Try SpotterManage node pools in Kubernetes kubernetes cluster
| "added in version" 1.14.0 of azure.azcollection"
Authors: xuzhang3 (@xuzhang3), Fred Sun (@Fred-sun)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update or delete node pools in kubernetes cluster.
- name: Add new node agent pool
azure_rm_aksagentpool:
resource_group: "{{ resource_group }}"
cluster_name: aksfred01
name: default-new
count: 2
vm_size: Standard_B2s
type_properties_type: VirtualMachineScaleSets
mode: System
node_labels: {"release":"stable"}
max_pods: 42
orchestrator_version: 1.23.5
availability_zones:
- 1
- 2
- name: Delete node agent pool
azure_rm_aksagentpool:
resource_group: "{{ resource_group }}"
cluster_name: aksfred01
name: default-new
mode:
choices:
- System
- User
description:
- AgentPoolMode represents mode of an agent pool.
type: str
name:
description:
- The name of the node agent pool.
required: true
type: str
tags:
description:
- Dictionary of string:string pairs to assign as metadata to the object.
- Metadata tags on the object will be updated with any provided values.
- To remove tags set append_tags option to false.
- Currently, Azure DNS zones and Traffic Manager services also don't allow the use
of spaces in the tag.
- Azure Front Door doesn't support the use of
- Azure Automation and Azure CDN only support 15 tags on resources.
type: dict
count:
description:
- Number of agents (VMs) to host docker containers.
type: int
state:
choices:
- present
- absent
default: present
description:
- State of the automation runbook. Use C(present) to create or update a automation
runbook and use C(absent) to delete.
type: str
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
os_type:
choices:
- Linux
- Windows
description:
- OsType to be used to specify os type.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
vm_size:
description:
- Size of agent VMs
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
max_pods:
description:
- Maximum number of pods that can run on a node.
type: int
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
max_count:
description:
- Maximum number of nodes for auto-scaling.
type: int
min_count:
description:
- Minimum number of nodes for auto-scaling.
type: int
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
append_tags:
default: true
description:
- Use to control if tags field is canonical or just appends to existing tags.
- When canonical, any tags not found in the tags parameter will be removed from the
object's metadata.
type: bool
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used
to identify the subscription ID if more than one is present otherwise the default
az cli subscription is used.
- When set to C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID)
can be used to identify the subscription ID if the resource is granted access to
more than one subscription, otherwise the first subscription is chosen.
- The C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
node_labels:
description:
- Agent pool node labels to be persisted across all nodes in agent pool.
type: dict
cluster_name:
description:
- The name of the kubernetes cluster.
required: true
type: str
resource_group:
description:
- The name of the resource group.
required: true
type: str
vnet_subnet_id:
description:
- VNet SubnetID specifies the VNet's subnet identifier.
type: str
os_disk_size_gb:
description:
- OS Disk Size in GB to be used to specify the disk size for every machine in this
master/agent pool.
type: int
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
availability_zones:
choices:
- 1
- 2
- 3
description:
- Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.
elements: int
type: list
enable_auto_scaling:
description:
- Whether to enable auto-scaler.
type: bool
cert_validation_mode:
choices:
- ignore
- validate
description:
- Controls the certificate validation behavior for Azure endpoints. By default, all
modules will validate the server certificate, but when an HTTPS proxy is in use,
or against Azure Stack, it may be necessary to disable this behavior by passing
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
orchestrator_version:
description:
- Version of orchestrator specified when creating the managed cluster.
type: str
type_properties_type:
choices:
- VirtualMachineScaleSets
- AvailabilitySet
description:
- AgentPoolType represents types of an agent pool.
type: str
x509_certificate_path:
description:
- Path to the X509 certificate used to create the service principal in PEM format.
- The certificate must be appended to the private key.
- Use when authenticating with a Service Principal.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
aks_agent_pools:
contains:
availability_zones:
description:
- Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType.
returned: always
sample:
- 1
- 2
type: list
cluster_name:
description:
- The cluster name.
returned: always
sample: testcluster
type: str
count:
description:
- Number of agents (VMs) to host docker containers.
returned: always
sample: 2
type: int
enable_auto_scaling:
description:
- Whether to enable auto-scaler.
returned: always
sample: null
type: str
enable_node_public_ip:
description:
- Enable public IP for nodes.
returned: always
sample: bool
type: str
id:
description:
- Resource ID.
returned: always
sample: /subscriptions/xxx-xxxf/resourcegroups/myRG/providers/Microsoft.ContainerService/managedClusters/cluster/agentPools/default
type: str
max_count:
description:
- Maximum number of nodes for auto-scaling.
returned: always
sample: 10
type: int
max_pods:
description:
- Maximum number of pods that can run on a node.
returned: always
sample: 42
type: int
min_count:
description:
- Minimum number of nodes for auto-scaling.
returned: always
sample: 1
type: int
mode:
description:
- AgentPoolMode represents mode of an agent pool.
returned: always
sample: System
type: str
name:
description:
- Resource name.
returned: always
sample: default
type: str
node_image_version:
description:
- Version of node image.
returned: always
sample: AKSUbuntu-1804gen2containerd-2022.08.23
type: str
node_labels:
description:
- Agent pool node labels to be persisted across all nodes in agent pool.
returned: always
sample:
- release: stable
type: list
node_taints:
description:
- Taints added to new nodes during node pool create and scale.
returned: always
sample: null
type: str
orchestrator_version:
description:
- Version of orchestrator specified when creating the managed cluster.
returned: always
sample: 1.22.11
type: str
os_disk_size_gb:
description:
- OS Disk Size in GB to be used to specify the disk size for every machine in
this master/agent pool.
returned: always
sample: 128
type: int
os_type:
description:
- OsType to be used to specify os type.
returned: always
sample: Linux
type: str
provisioning_state:
description:
- The current deployment or provisioning state, which only appears in the response.
returned: always
sample: Succeeded
type: str
resource_group:
description:
- Resource group name.
returned: always
sample: myRG
type: str
scale_set_eviction_policy:
description:
- ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual
machine scale set.
returned: always
sample: null
type: str
scale_set_priority:
description:
- caleSetPriority to be used to specify virtual machine scale set priority.
returned: always
sample: null
type: str
spot_max_price:
description:
- SpotMaxPrice to be used to specify the maximum price you are willing to pay
in US Dollars.
returned: always
sample: null
type: float
type:
description:
- Resource Type.
returned: always
sample: Microsoft.ContainerService/managedClusters/agentPools
type: str
type_properties_type:
description:
- AgentPoolType represents types of an agent pool.
returned: always
sample: VirtualMachineScaleSets
type: str
upgrade_settings:
description:
- Settings for upgrading the agentpool.
returned: always
sample: null
type: str
vm_size:
description:
- Size of agent VMs.
returned: always
sample: Standard_B2s
type: str
vnet_subnet_id:
description:
- VNet SubnetID specifies the VNet's subnet identifier.
returned: always
sample: null
type: str
description:
- Details for a node pool in the managed Kubernetes cluster.
returned: always
type: complex