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:
Fred-sun
Yunge Zhu
parent
c6a8e99d34
commit
35c655c8f5
3 changed files with 24 additions and 16 deletions
|
|
@ -16,9 +16,9 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: azure_rm_aks
|
||||
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:
|
||||
- Create, update and delete a managed Azure Container Service (AKS) Instance.
|
||||
- Create, update and delete a managed Azure Container Service (AKS) instance.
|
||||
|
||||
options:
|
||||
resource_group:
|
||||
|
|
@ -47,11 +47,11 @@ options:
|
|||
- Version of Kubernetes specified when creating the managed cluster.
|
||||
linux_profile:
|
||||
description:
|
||||
- The linux profile suboptions.
|
||||
- The Linux profile suboptions.
|
||||
suboptions:
|
||||
admin_username:
|
||||
description:
|
||||
- The Admin Username for the Cluster.
|
||||
- The Admin Username for the cluster.
|
||||
required: true
|
||||
ssh_key:
|
||||
description:
|
||||
|
|
@ -68,11 +68,11 @@ options:
|
|||
count:
|
||||
description:
|
||||
- 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
|
||||
vm_size:
|
||||
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
|
||||
os_disk_size_gb:
|
||||
description:
|
||||
|
|
@ -95,7 +95,7 @@ options:
|
|||
- Existing non-RBAC enabled AKS clusters cannot currently be updated for RBAC use.
|
||||
type: bool
|
||||
default: no
|
||||
version_added: 2.8
|
||||
version_added: "2.8"
|
||||
network_profile:
|
||||
description:
|
||||
- Profile of network configuration.
|
||||
|
|
@ -107,30 +107,38 @@ options:
|
|||
- 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).
|
||||
- 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:
|
||||
- azure
|
||||
- kubenet
|
||||
network_policy:
|
||||
description: Network policy used for building Kubernetes network.
|
||||
choices:
|
||||
- azure
|
||||
- calico
|
||||
pod_cidr:
|
||||
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.
|
||||
- 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:
|
||||
description:
|
||||
- A CIDR notation IP range from which to assign service cluster IPs.
|
||||
- It must not overlap with any Subnet IP ranges.
|
||||
- It should be the *.10 address of your service IP address range.
|
||||
default: "10.0.0.0/16"
|
||||
dns_service_ip:
|
||||
description:
|
||||
- An IP address assigned to the Kubernetes DNS service.
|
||||
- It must be within the Kubernetes service address range specified in serviceCidr.
|
||||
default: "10.0.0.10"
|
||||
docker_bridge_cidr:
|
||||
description:
|
||||
- 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.
|
||||
version_added: 2.8
|
||||
default: "172.17.0.1/16"
|
||||
version_added: "2.8"
|
||||
aad_profile:
|
||||
description:
|
||||
- Profile of Azure Active Directory configuration.
|
||||
|
|
@ -145,7 +153,7 @@ options:
|
|||
description:
|
||||
- The AAD tenant ID to use for authentication.
|
||||
- If not specified, will use the tenant of the deployment subscription.
|
||||
version_added: 2.8
|
||||
version_added: "2.8"
|
||||
addon:
|
||||
description:
|
||||
- Profile of managed cluster add-on.
|
||||
|
|
@ -188,7 +196,7 @@ options:
|
|||
subnet_resource_id:
|
||||
description:
|
||||
- Subnet associdated to the cluster.
|
||||
version_added: 2.8
|
||||
version_added: "2.8"
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
|
@ -228,7 +236,7 @@ EXAMPLES = '''
|
|||
'''
|
||||
RETURN = '''
|
||||
state:
|
||||
description: Current state of the Azure Container Service (AKS)
|
||||
description: Current state of the Azure Container Service (AKS).
|
||||
returned: always
|
||||
type: dict
|
||||
example:
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ module: azure_rm_aks_facts
|
|||
|
||||
version_added: "2.6"
|
||||
|
||||
short_description: Get Azure Kubernetes Service facts.
|
||||
short_description: Get Azure Kubernetes Service facts
|
||||
|
||||
description:
|
||||
- Get facts for a specific Azure Kubernetes Service or all Azure Kubernetes Services.
|
||||
|
|
@ -37,7 +37,7 @@ options:
|
|||
description:
|
||||
- Show kubeconfig of the AKS cluster.
|
||||
- Note the operation will cost more network overhead, not recommended when listing AKS.
|
||||
version_added: 2.8
|
||||
version_added: "2.8"
|
||||
choices:
|
||||
- user
|
||||
- admin
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ module: azure_rm_aksversion_facts
|
|||
|
||||
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:
|
||||
- Get available kubernetes versions supported by Azure Kubernetes Service.
|
||||
|
|
|
|||
Loading…
Reference in a new issue