Skip to content

Latest commit

 

History

History
286 lines (154 loc) · 9.64 KB

kubernetes_cluster.html.markdown

File metadata and controls

286 lines (154 loc) · 9.64 KB
Raw
subcategory layout page_title description
Container
azurerm
Azure Resource Manager: azurerm_kubernetes_cluster
Gets information about an existing Managed Kubernetes Cluster (AKS)

Data Source: azurerm_kubernetes_cluster

Use this data source to access information about an existing Managed Kubernetes Cluster (AKS).

~> Note: All arguments including the client secret will be stored in the raw state as plain-text. Read more about sensitive data in state.

Example Usage

data "azurerm_kubernetes_cluster" "example" {
  name                = "myakscluster"
  resource_group_name = "my-example-resource-group"
}

Argument Reference

The following arguments are supported:

  • name - The name of the managed Kubernetes Cluster.

  • resource_group_name - The name of the Resource Group in which the managed Kubernetes Cluster exists.

Attributes Reference

The following attributes are exported:

  • id - The ID of the Kubernetes Managed Cluster.

  • api_server_authorized_ip_ranges - The IP ranges to whitelist for incoming traffic to the masters.

-> NOTE: api_server_authorized_ip_ranges Is currently in Preview on an opt-in basis. To use it, enable feature APIServerSecurityPreview for namespace Microsoft.ContainerService. For an example of how to enable a Preview feature, please visit How to enable the Azure Firewall Public Preview

  • addon_profile - A addon_profile block as documented below.

  • agent_pool_profile - An agent_pool_profile block as documented below.

  • dns_prefix - The DNS Prefix of the managed Kubernetes cluster.

  • fqdn - The FQDN of the Azure Kubernetes Managed Cluster.

  • private_fqdn - The FQDN of this Kubernetes Cluster when private link has been enabled. This name is only resolvable inside the Virtual Network where the Azure Kubernetes Service is located

-> NOTE: At this time Private Link is in Public Preview.

  • kube_admin_config - A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled.

  • kube_admin_config_raw - Raw Kubernetes config for the admin account to be used by kubectl and other compatible tools. This is only available when Role Based Access Control with Azure Active Directory is enabled.

  • kube_config - A kube_config block as defined below.

  • kube_config_raw - Base64 encoded Kubernetes configuration.

  • kubernetes_version - The version of Kubernetes used on the managed Kubernetes Cluster.

  • private_cluster_enabled - If the cluster has the Kubernetes API only exposed on internal IP addresses.

  • location - The Azure Region in which the managed Kubernetes Cluster exists.

  • linux_profile - A linux_profile block as documented below.

  • windows_profile - A windows_profile block as documented below.

  • network_profile - A network_profile block as documented below.

  • node_resource_group - Auto-generated Resource Group containing AKS Cluster resources.

  • role_based_access_control - A role_based_access_control block as documented below.

  • service_principal - A service_principal block as documented below.

  • identity - A identity block as documented below.

  • kubelet_identity - A kubelet_identity block as documented below.

  • tags - A mapping of tags assigned to this resource.

A addon_profile block exports the following:

  • http_application_routing - A http_application_routing block.

  • oms_agent - A oms_agent block.

  • kube_dashboard - A kube_dashboard block.

  • azure_policy - A azure_policy block.

A agent_pool_profile block exports the following:

  • type - The type of the Agent Pool.

  • count - The number of Agents (VM's) in the Pool.

  • max_pods - The maximum number of pods that can run on each agent.

  • availability_zones - The availability zones used for the nodes.

  • enable_auto_scaling - If the auto-scaler is enabled.

  • min_count - Minimum number of nodes for auto-scaling

  • max_count - Maximum number of nodes for auto-scaling

  • name - The name assigned to this pool of agents.

  • node_taints - The list of Kubernetes taints which are applied to nodes in the agent pool

  • os_disk_size_gb - The size of the Agent VM's Operating System Disk in GB.

  • os_type - The Operating System used for the Agents.

  • tags - A mapping of tags to assign to the resource.

  • vm_size - The size of each VM in the Agent Pool (e.g. Standard_F1).

  • vnet_subnet_id - The ID of the Subnet where the Agents in the Pool are provisioned.

A azure_active_directory block exports the following:

  • client_app_id - The Client ID of an Azure Active Directory Application.

  • server_app_id - The Server ID of an Azure Active Directory Application.

  • tenant_id - The Tenant ID used for Azure Active Directory Application.

A http_application_routing block exports the following:

  • enabled - Is HTTP Application Routing Enabled?

  • http_application_routing_zone_name - The Zone Name of the HTTP Application Routing.

The kube_admin_config and kube_config blocks exports the following:

  • client_key - Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

  • client_certificate - Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

  • cluster_ca_certificate - Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

  • host - The Kubernetes cluster server host.

  • username - A username used to authenticate to the Kubernetes cluster.

  • password - A password or token used to authenticate to the Kubernetes cluster.

-> NOTE: It's possible to use these credentials with the Kubernetes Provider like so:

provider "kubernetes" {
  load_config_file       = "false"
  host                   = "${data.azurerm_kubernetes_cluster.main.kube_config.0.host}"
  username               = "${data.azurerm_kubernetes_cluster.main.kube_config.0.username}"
  password               = "${data.azurerm_kubernetes_cluster.main.kube_config.0.password}"
  client_certificate     = "${base64decode(data.azurerm_kubernetes_cluster.main.kube_config.0.client_certificate)}"
  client_key             = "${base64decode(data.azurerm_kubernetes_cluster.main.kube_config.0.client_key)}"
  cluster_ca_certificate = "${base64decode(data.azurerm_kubernetes_cluster.main.kube_config.0.cluster_ca_certificate)}"
}

A linux_profile block exports the following:

  • admin_username - The username associated with the administrator account of the managed Kubernetes Cluster.

  • ssh_key - An ssh_key block as defined below.

A windows_profile block exports the following:

  • admin_username - The username associated with the administrator account of the Windows VMs.

A network_profile block exports the following:

  • docker_bridge_cidr - IP address (in CIDR notation) used as the Docker bridge IP address on nodes.

  • dns_service_ip - IP address within the Kubernetes service address range used by cluster service discovery (kube-dns).

  • network_plugin - Network plugin used such as azure or kubenet.

  • network_policy - Network policy to be used with Azure CNI. Eg: calico or azure

  • pod_cidr - The CIDR used for pod IP addresses.

  • service_cidr - Network range used by the Kubernetes service.

A oms_agent block exports the following:

  • enabled - Is the OMS Agent Enabled?

  • log_analytics_workspace_id - The ID of the Log Analytics Workspace which the OMS Agent should send data to.

  • oms_agent_identity - An oms_agent_identity block as defined below.

The oms_agent_identity block exports the following:

  • client_id - The Client ID of the user-defined Managed Identity used by the OMS Agents.

  • object_id - The Object ID of the user-defined Managed Identity used by the OMS Agents.

  • user_assigned_identity_id - The ID of the User Assigned Identity used by the OMS Agents.

A kube_dashboard block supports the following:

  • enabled - Is the Kubernetes Dashboard enabled?

A azure_policy block supports the following:

  • enabled - Is Azure Policy for Kubernetes enabled?

A role_based_access_control block exports the following:

  • azure_active_directory - A azure_active_directory block as documented above.

  • enabled - Is Role Based Access Control enabled?

A service_principal block supports the following:

  • client_id - The Client ID of the Service Principal used by this Managed Kubernetes Cluster.

The identity block exports the following:

  • type - The type of identity used for the managed cluster.

  • principal_id - The principal id of the system assigned identity which is used by master components.

  • tenant_id - The tenant id of the system assigned identity which is used by master components.

The kubelet_identity block exports the following:

  • client_id - The Client ID of the user-defined Managed Identity assigned to the Kubelets.

  • object_id - The Object ID of the user-defined Managed Identity assigned to the Kubelets.

  • user_assigned_identity_id - The ID of the User Assigned Identity assigned to the Kubelets.

A ssh_key block exports the following:

  • key_data - The Public SSH Key used to access the cluster.

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • read - (Defaults to 5 minutes) Used when retrieving the Managed Kubernetes Cluster (AKS).