mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
modify azure_rm_aks* document (#56293)
This commit is contained in:
parent
c6a8e99d34
commit
35c655c8f5
3 changed files with 24 additions and 16 deletions
|
@ -16,9 +16,9 @@ DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: azure_rm_aks
|
module: azure_rm_aks
|
||||||
version_added: "2.6"
|
version_added: "2.6"
|
||||||
short_description: Manage a managed Azure Container Service (AKS) Instance.
|
short_description: Manage a managed Azure Container Service (AKS) instance
|
||||||
description:
|
description:
|
||||||
- Create, update and delete a managed Azure Container Service (AKS) Instance.
|
- Create, update and delete a managed Azure Container Service (AKS) instance.
|
||||||
|
|
||||||
options:
|
options:
|
||||||
resource_group:
|
resource_group:
|
||||||
|
@ -47,11 +47,11 @@ options:
|
||||||
- Version of Kubernetes specified when creating the managed cluster.
|
- Version of Kubernetes specified when creating the managed cluster.
|
||||||
linux_profile:
|
linux_profile:
|
||||||
description:
|
description:
|
||||||
- The linux profile suboptions.
|
- The Linux profile suboptions.
|
||||||
suboptions:
|
suboptions:
|
||||||
admin_username:
|
admin_username:
|
||||||
description:
|
description:
|
||||||
- The Admin Username for the Cluster.
|
- The Admin Username for the cluster.
|
||||||
required: true
|
required: true
|
||||||
ssh_key:
|
ssh_key:
|
||||||
description:
|
description:
|
||||||
|
@ -63,16 +63,16 @@ options:
|
||||||
suboptions:
|
suboptions:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Unique name of the agent pool profile in the context of the subscription and resource group.
|
- Unique name of the agent pool profile in the context of the subscription and resource group.
|
||||||
required: true
|
required: true
|
||||||
count:
|
count:
|
||||||
description:
|
description:
|
||||||
- Number of agents (VMs) to host docker containers.
|
- Number of agents (VMs) to host docker containers.
|
||||||
- Allowed values must be in the range of 1 to 100 (inclusive).
|
- Allowed values must be in the range of C(1) to C(100) (inclusive).
|
||||||
required: true
|
required: true
|
||||||
vm_size:
|
vm_size:
|
||||||
description:
|
description:
|
||||||
- The VM Size of each of the Agent Pool VM's (e.g. Standard_F1 / Standard_D2v2).
|
- The VM Size of each of the Agent Pool VM's (e.g. C(Standard_F1) / C(Standard_D2v2)).
|
||||||
required: true
|
required: true
|
||||||
os_disk_size_gb:
|
os_disk_size_gb:
|
||||||
description:
|
description:
|
||||||
|
@ -95,7 +95,7 @@ options:
|
||||||
- Existing non-RBAC enabled AKS clusters cannot currently be updated for RBAC use.
|
- Existing non-RBAC enabled AKS clusters cannot currently be updated for RBAC use.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: no
|
||||||
version_added: 2.8
|
version_added: "2.8"
|
||||||
network_profile:
|
network_profile:
|
||||||
description:
|
description:
|
||||||
- Profile of network configuration.
|
- Profile of network configuration.
|
||||||
|
@ -107,30 +107,38 @@ options:
|
||||||
- With C(kubenet), nodes get an IP address from the Azure virtual network subnet.
|
- With C(kubenet), nodes get an IP address from the Azure virtual network subnet.
|
||||||
- AKS features such as Virtual Nodes or network policies aren't supported with C(kubenet).
|
- AKS features such as Virtual Nodes or network policies aren't supported with C(kubenet).
|
||||||
- C(azure) enables Azure Container Networking Interface(CNI), every pod gets an IP address from the subnet and can be accessed directly.
|
- C(azure) enables Azure Container Networking Interface(CNI), every pod gets an IP address from the subnet and can be accessed directly.
|
||||||
|
default: kubenet
|
||||||
choices:
|
choices:
|
||||||
- azure
|
- azure
|
||||||
- kubenet
|
- kubenet
|
||||||
network_policy:
|
network_policy:
|
||||||
description: Network policy used for building Kubernetes network.
|
description: Network policy used for building Kubernetes network.
|
||||||
|
choices:
|
||||||
|
- azure
|
||||||
|
- calico
|
||||||
pod_cidr:
|
pod_cidr:
|
||||||
description:
|
description:
|
||||||
- A CIDR notation IP range from which to assign pod IPs when kubenet is used.
|
- A CIDR notation IP range from which to assign pod IPs when I(network_plugin=kubenet) is used.
|
||||||
- It should be a large address space that isn't in use elsewhere in your network environment.
|
- It should be a large address space that isn't in use elsewhere in your network environment.
|
||||||
- This address range must be large enough to accommodate the number of nodes that you expect to scale up to.
|
- This address range must be large enough to accommodate the number of nodes that you expect to scale up to.
|
||||||
|
default: "10.244.0.0/16"
|
||||||
service_cidr:
|
service_cidr:
|
||||||
description:
|
description:
|
||||||
- A CIDR notation IP range from which to assign service cluster IPs.
|
- A CIDR notation IP range from which to assign service cluster IPs.
|
||||||
- It must not overlap with any Subnet IP ranges.
|
- It must not overlap with any Subnet IP ranges.
|
||||||
- It should be the *.10 address of your service IP address range.
|
- It should be the *.10 address of your service IP address range.
|
||||||
|
default: "10.0.0.0/16"
|
||||||
dns_service_ip:
|
dns_service_ip:
|
||||||
description:
|
description:
|
||||||
- An IP address assigned to the Kubernetes DNS service.
|
- An IP address assigned to the Kubernetes DNS service.
|
||||||
- It must be within the Kubernetes service address range specified in serviceCidr.
|
- It must be within the Kubernetes service address range specified in serviceCidr.
|
||||||
|
default: "10.0.0.10"
|
||||||
docker_bridge_cidr:
|
docker_bridge_cidr:
|
||||||
description:
|
description:
|
||||||
- A CIDR notation IP range assigned to the Docker bridge network.
|
- A CIDR notation IP range assigned to the Docker bridge network.
|
||||||
- It must not overlap with any Subnet IP ranges or the Kubernetes service address range.
|
- It must not overlap with any Subnet IP ranges or the Kubernetes service address range.
|
||||||
version_added: 2.8
|
default: "172.17.0.1/16"
|
||||||
|
version_added: "2.8"
|
||||||
aad_profile:
|
aad_profile:
|
||||||
description:
|
description:
|
||||||
- Profile of Azure Active Directory configuration.
|
- Profile of Azure Active Directory configuration.
|
||||||
|
@ -145,7 +153,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- The AAD tenant ID to use for authentication.
|
- The AAD tenant ID to use for authentication.
|
||||||
- If not specified, will use the tenant of the deployment subscription.
|
- If not specified, will use the tenant of the deployment subscription.
|
||||||
version_added: 2.8
|
version_added: "2.8"
|
||||||
addon:
|
addon:
|
||||||
description:
|
description:
|
||||||
- Profile of managed cluster add-on.
|
- Profile of managed cluster add-on.
|
||||||
|
@ -188,7 +196,7 @@ options:
|
||||||
subnet_resource_id:
|
subnet_resource_id:
|
||||||
description:
|
description:
|
||||||
- Subnet associdated to the cluster.
|
- Subnet associdated to the cluster.
|
||||||
version_added: 2.8
|
version_added: "2.8"
|
||||||
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- azure
|
- azure
|
||||||
|
@ -228,7 +236,7 @@ EXAMPLES = '''
|
||||||
'''
|
'''
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
state:
|
state:
|
||||||
description: Current state of the Azure Container Service (AKS)
|
description: Current state of the Azure Container Service (AKS).
|
||||||
returned: always
|
returned: always
|
||||||
type: dict
|
type: dict
|
||||||
example:
|
example:
|
||||||
|
|
|
@ -18,7 +18,7 @@ module: azure_rm_aks_facts
|
||||||
|
|
||||||
version_added: "2.6"
|
version_added: "2.6"
|
||||||
|
|
||||||
short_description: Get Azure Kubernetes Service facts.
|
short_description: Get Azure Kubernetes Service facts
|
||||||
|
|
||||||
description:
|
description:
|
||||||
- Get facts for a specific Azure Kubernetes Service or all Azure Kubernetes Services.
|
- Get facts for a specific Azure Kubernetes Service or all Azure Kubernetes Services.
|
||||||
|
@ -37,7 +37,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Show kubeconfig of the AKS cluster.
|
- Show kubeconfig of the AKS cluster.
|
||||||
- Note the operation will cost more network overhead, not recommended when listing AKS.
|
- Note the operation will cost more network overhead, not recommended when listing AKS.
|
||||||
version_added: 2.8
|
version_added: "2.8"
|
||||||
choices:
|
choices:
|
||||||
- user
|
- user
|
||||||
- admin
|
- admin
|
||||||
|
|
|
@ -18,7 +18,7 @@ module: azure_rm_aksversion_facts
|
||||||
|
|
||||||
version_added: "2.8"
|
version_added: "2.8"
|
||||||
|
|
||||||
short_description: Get available kubernetes versions supported by Azure Kubernetes Service.
|
short_description: Get available kubernetes versions supported by Azure Kubernetes Service
|
||||||
|
|
||||||
description:
|
description:
|
||||||
- Get available kubernetes versions supported by Azure Kubernetes Service.
|
- Get available kubernetes versions supported by Azure Kubernetes Service.
|
||||||
|
|
Loading…
Reference in a new issue