azure.azcollection.azure_rm_aksagentpool 模块 – 管理 Kubernetes Kubernetes 集群中的节点池

注意

此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅 要求了解详细信息。

要在 Playbook 中使用它，请指定：azure.azcollection.azure_rm_aksagentpool。

azure.azcollection 1.14.0 中的新增功能

概要

• 在 Kubernetes 集群中创建、更新或删除节点池。

要求

执行此模块的主机需要满足以下要求。

• python >= 2.7

• 执行此模块的主机必须通过 Galaxy 安装了 azure.azcollection 集合

• 必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合的 requirements.txt 中列出的所有 Python 包

• 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到

参数

参数	注释
ad_user 字符串	Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串 在 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且拥有自己的 ADFS 授权时使用。
api_profile 字符串 在 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公共云；未来的值将允许与 Azure Stack 一起使用。 默认值： "latest"
append_tags 布尔值	用于控制 tags 字段是规范的还是仅附加到现有标签。 当为规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项 false true ← （默认值）
auth_source 字符串 在 azure.azcollection 0.0.1 中添加	控制用于身份验证的凭据的来源。 也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。 当设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。 当设置为 env 时，将从环境变量中读取凭据 当设置为 credential_file 时，它将从 ~/.azure/credentials 中读取配置文件。 当设置为 cli 时，凭据将来源于 Azure CLI 配置文件。如果存在多个订阅，则可以使用 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 来标识订阅 ID，否则将使用默认的 az cli 订阅。 当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。如果该资源被授予对多个订阅的访问权限，则可以使用 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 来标识订阅 ID，否则将选择第一个订阅。 msi 在 Ansible 2.6 中添加。 选项 "auto" ← （默认值） "cli" "credential_file" "env" "msi"
availability_zones 列表 / 元素=整数	节点的可用区。必须使用 VirtualMachineScaleSets AgentPoolType。 选项 1 2 3
cert_validation_mode 字符串 在 azure.azcollection 0.0.1 中添加	控制 Azure 端点的证书验证行为。默认情况下，所有模块都会验证服务器证书，但是当使用 HTTPS 代理时，或者针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量进行设置。 选项 "ignore" "validate"
client_id 字符串	Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 AZURE_CLIENT_ID 环境变量设置。
cloud_environment 字符串 在 azure.azcollection 0.0.1 中添加	对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如，AzureChinaCloud、AzureUSGovernment），或元数据发现端点 URL（Azure Stack 需要）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认值： "AzureCloud"
cluster_name 字符串 / 必需	Kubernetes 集群的名称。
count 整数	用于托管 Docker 容器的代理（虚拟机）的数量。
disable_instance_discovery 布尔值 在 azure.azcollection 2.3.0 中添加	确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的情况，例如私有云或 Azure Stack。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据，以验证授权。通过将此项设置为 **True**，将禁用对授权的验证。因此，确保配置的授权主机有效且可信至关重要。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ←（默认值） true
enable_auto_scaling 布尔值	是否启用自动缩放。 选项 false true
enable_encryption_at_host 布尔值	这仅在某些 VM 大小和某些 Azure 区域中受支持。 选项 false true
enable_fips 布尔值	是否启用 FIPS 节点池。 选项 false true
enable_node_public_ip 布尔值	某些情况下，可能需要节点池中的节点接收其自己的专用公共 IP 地址。 一个常见的情况是游戏工作负载，其中控制台需要直接连接到云虚拟机以最大限度地减少跃点。 选项 false true
enable_ultra_ssd 布尔值	是否启用 UltraSSD。 选项 false true
gpu_instance_profile 字符串	GPUInstanceProfile 用于为受支持的 GPU VM SKU 指定 GPU MIG 实例配置文件。 选项 "MIG1g" "MIG2g" "MIG3g" "MIG4g" "MIG7g"
kubelet_config 字典	代理池节点上的 Kubelet 配置。
allowed_unsafe_sysctls 列表 / 元素=字符串	允许的不安全 sysctl 或不安全 sysctl 模式的列表。
container_log_max_files 整数	容器可以存在的最大容器日志文件数。该数字必须 ≥ 2。
container_log_max_size_mb 整数	容器日志文件在轮换之前的最大大小。
cpu_cfs_quota 布尔值	默认值为 true。 选项 false true ← （默认值）
cpu_cfs_quota_period 字符串	默认值为 100ms。 有效值是由可选的小数部分和单位后缀组成的十进制数字序列。 默认值： "100ms"
cpu_manager_policy 字符串	Kubernetes CPU 管理策略。 默认值为 none。 选项 "none" ←（默认值） "static"
fail_swap_on 布尔值	如果设置为 true，则如果节点上启用了交换，Kubelet 将无法启动。 选项 false true
image_gc_high_threshold 整数	要禁用映像垃圾回收，请设置为 100。 默认值为 85 默认值： 85
image_gc_low_threshold 整数	此值不能设置高于 imageGcHighThreshold。 默认值为 80。 默认值： 80
pod_max_pids 整数	每个 Pod 的最大进程数。
topology_manager_policy 字符串	Kubernetes 拓扑管理器策略。 默认值为 none。 选项 "none" ←（默认值） "best-effort" "restricted" "single-numa-node"
kubelet_disk_type 字符串	确定 emptyDir 卷、容器运行时数据根和 Kubelet 临时存储的放置位置。 选项 "OS" "Temporary"
linux_os_config 字典	Linux 代理节点的操作系统配置。
swap_file_size_mb 整数	将在每个节点上创建的交换文件的大小（以 MB 为单位）。
sysctls 字典	Linux 代理节点的 Sysctl 设置。
fs_aio_max_nr 整数	Sysctl 设置 fs.aio-max-nr。
fs_file_max 整数	Sysctl 设置 fs.file-max。
fs_inotify_max_user_watches 整数	Sysctl 设置 fs.inotify.max_user_watches。
fs_nr_open 整数	Sysctl 设置 fs.nr_open。
kernel_threads_max 整数	Sysctl 设置 kernel.threads-max。
net_core_netdev_max_backlog 整数	Sysctl 设置 net.core.netdev_max_backlog。
net_core_optmem_max 整数	Sysctl 设置 net.core.optmem_max。
net_core_rmem_default 整数	Sysctl 设置 net.core.rmem_default。
net_core_rmem_max 整数	Sysctl 设置 net.core.rmem_max。
net_core_somaxconn 整数	Sysctl 设置 net.core.somaxconn。
net_core_wmem_default 整数	Sysctl 设置 net.core.wmem_default。
net_core_wmem_max 整数	Sysctl 设置 net.core.wmem_max。
net_ipv4_ip_local_port_range 字符串	Sysctl 设置 net.ipv4.ip_local_port_range。
net_ipv4_neigh_default_gc_thresh1 整数	Sysctl 设置 net.ipv4.neigh.default.gc_thresh1。
net_ipv4_neigh_default_gc_thresh2 整数	Sysctl 设置 net.ipv4.neigh.default.gc_thresh2。
net_ipv4_neigh_default_gc_thresh3 整数	Sysctl 设置 net.ipv4.neigh.default.gc_thresh3。
net_ipv4_tcp_fin_timeout 整数	Sysctl 设置 net.ipv4.tcp_fin_timeout。
net_ipv4_tcp_keepalive_probes 整数	Sysctl 设置 net.ipv4.tcp_keepalive_probes。
net_ipv4_tcp_keepalive_time 整数	Sysctl 设置 net.ipv4.tcp_keepalive_time。
net_ipv4_tcp_max_syn_backlog 整数	Sysctl 设置 net.ipv4.tcp_max_syn_backlog。
net_ipv4_tcp_max_tw_buckets 整数	Sysctl 设置 net.ipv4.tcp_max_tw_buckets。
net_ipv4_tcp_tw_reuse 布尔值	Sysctl 设置 net.ipv4.tcp_tw_reuse。 选项 false true
net_ipv4_tcpkeepalive_intvl 整数	Sysctl 设置 net.ipv4.tcp_keepalive_intvl。
net_netfilter_nf_conntrack_buckets 整数	Sysctl 设置 net.netfilter.nf_conntrack_buckets。
net_netfilter_nf_conntrack_max 整数	sysctl 设置 net.netfilter.nf_conntrack_max。
vm_max_map_count 整数	Sysctl 设置 vm.max_map_count。
vm_swappiness 整数	Sysctl 设置 vm.swappiness。
vm_vfs_cache_pressure 整数	Sysctl 设置 vm.vfs_cache_pressure。
transparent_huge_page_defrag 字符串	节点代理池透明大页碎片整理。 默认值为 madvise。 选项 "always" "defer" "defer+madvise" "madvise" ←（默认值） "never"
transparent_huge_page_enabled 字符串	节点代理池透明大页。 默认值为 always。 选项 "always" ←（默认值） "madvise" "never"
log_mode 字符串	父参数。
log_path 字符串	父参数。
max_count 整数	自动缩放的最大节点数。
max_pods 整数	可以在节点上运行的最大 Pod 数。
min_count 整数	自动缩放的最小节点数。
mode 字符串	AgentPoolMode 表示代理池的模式。 选项 "System" "User"
name 字符串 / 必需	节点代理池的名称。
node_labels 字典	要跨代理池中的所有节点持久化的代理池节点标签。
node_public_ip_prefix_id 字符串	Azure 公共 IP 前缀的 ID。
node_taints 列表 / 元素=字符串	在节点池创建和缩放期间添加到新节点的污点。 例如，值：NoSchedule'。
orchestrator_version 字符串	创建托管群集时指定的 Orchestrator 版本。
os_disk_size_gb 整数	OS 磁盘大小（以 GB 为单位），用于指定此主/代理池中每台计算机的磁盘大小。
os_sku 字符串	指定 OS SKU。 如果 OSType 为 Windows，则不能指定此值。 os_sku=CBLMariner 已弃用。Microsoft 建议新部署选择“AzureLinux”代替。 选项 "Ubuntu" "AzureLinux" "Windows2019" "Windows2022"
os_type 字符串	OsType 用于指定操作系统类型。 选项 "Linux" "Windows"
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
power_state 字典	首次创建代理池时，它最初处于 Running 状态。 可以通过将此字段设置为 Stopped 来停止代理池。 已停止的代理池会停止其所有虚拟机，并且不会产生计费费用。 只有当代理池处于运行状态且预配状态为 Succeeded 时，才能停止代理池。
code 字符串	指示群集是 Running 还是 Stopped。 选项 "Running" "Stopped"
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
proximity_placement_group_id 字符串	接近放置组的 ID。
resource_group 字符串 / 必需	资源组的名称。
scale_down_mode 字符串	这也会影响群集自动缩放器的行为。 如果未指定，则默认为 Delete。 选项 "Delete" ←（默认值） "Deallocate"
scale_set_eviction_policy 字符串	除非 scale_set_priority=Spot，否则不能指定此项。 如果未指定，则默认值为 Delete。 选项 "Delete" "Deallocate"
scale_set_priority 字符串	虚拟机规模集优先级。 如果未指定，则默认为 Regular。 选项 "Spot" "Regular"
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
security_profile 字典	代理池的安全设置。
enable_secure_boot 布尔值	是否禁用或启用安全启动。 选项 false ←（默认值） true
enable_vtpm 布尔值	是否禁用或启用 vTPM。 选项 false ←（默认值） true
spot_max_price 浮点数	可能的值为大于零的任何十进制值或 -1。 表示愿意支付任何按需价格。
state 字符串	自动化 Runbook 的状态。使用 present 创建或更新自动化 Runbook，使用 absent 删除。 选项 "present" ← (默认) "absent"
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的字符串:字符串对的字典。 对象上的元数据标记将使用任何提供的值进行更新。 要删除标记，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。 Azure 前门不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标记。
tenant 字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 在使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
type_properties_type 字符串	AgentPoolType 表示代理池的类型。 选项 "VirtualMachineScaleSets" "AvailabilitySet"
upgrade_settings 字典	用于升级代理池的设置。
max_surge 字符串	这可以设置为整数，例如 5 或百分比 50%。 如果指定了百分比，则它是升级时代理池总大小的百分比。 对于百分比，小数节点会向上舍入。 如果未指定，则默认值为 1。
vm_size 字符串	代理 VM 的大小
vnet_subnet_id 字符串	VNet SubnetID 指定 VNet 的子网标识符。
workload_runtime 字符串	确定节点可以运行的工作负载类型。 选项 "OCIContainer" "WasmWasi"
x509_certificate_path 路径 在 azure.azcollection 1.14.0 中添加	用于以 PEM 格式创建服务主体的 X509 证书的路径。 证书必须附加到私钥。 在使用服务主体进行身份验证时使用。

注释

注意

• 要使用 Azure 进行身份验证，您可以传递参数，设置环境变量，使用存储在 ~/.azure/credentials 中的配置文件，或者在使用 az login 运行任务或 playbook 之前登录。

• 也可以使用服务主体或 Active Directory 用户进行身份验证。

• 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

• 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或者在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

• 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个 ini 文件，其中包含 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- 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: Create a node agent pool with custom config
  azure_rm_aksagentpool:
    resource_group: "{{ resource_group }}"
    cluster_name: "min{{ rpfx }}"
    name: default-new2
    count: 1
    vm_size: Standard_B2s
    type_properties_type: VirtualMachineScaleSets
    mode: System
    node_labels: {"release":"stable"}
    max_pods: 42
    enable_auto_scaling: true
    min_count: 1
    max_count: 10
    orchestrator_version: 1.23.5
    availability_zones:
      - 1
    kubelet_config:
      cpu_manager_policy: static
      cpu_cfs_quota: true
      fail_swap_on: false
    linux_os_config:
      transparent_huge_page_enabled: madvise
      swap_file_size_mb: 1500
      transparent_huge_page_defrag: defer+madvise
- name: Delete node agent pool
  azure_rm_aksagentpool:
    resource_group: "{{ resource_group }}"
    cluster_name: aksfred01
    name: default-new

返回值

常见返回值记录在此处，以下是此模块特有的字段

键	描述
aks_agent_pools 复杂类型	托管 Kubernetes 集群中节点池的详细信息。 返回: 总是
availability_zones 列表 / 元素=字符串	节点的可用区。必须使用 VirtualMachineScaleSets AgentPoolType。 返回: 总是 示例: [1, 2]
cluster_name 字符串	集群名称。 返回: 总是 示例: "testcluster"
count 整数	用于托管 Docker 容器的代理（虚拟机）的数量。 返回: 总是 示例: 2
enable_auto_scaling 字符串	是否启用自动缩放。 返回: 总是
enable_encryption_at_host 布尔值	这仅在某些 VM 大小和某些 Azure 区域中受支持。 返回: 总是 示例: false
enable_node_public_ip 字符串	为节点启用公共 IP。 返回: 总是 示例: "bool"
enable_ultra_ssd 布尔值	是否启用 FIPS 节点池。 返回: 总是 示例: false
gpu_instance_profile 字符串	GPUInstanceProfile 用于为受支持的 GPU VM SKU 指定 GPU MIG 实例配置文件。 返回: 总是 示例: "MIG1g"
id 字符串	资源 ID。 返回: 总是 示例: "/subscriptions/xxx-xxxf/resourcegroups/myRG/providers/Microsoft.ContainerService/managedClusters/cluster/agentPools/default"
kubelet_config 字典	代理池节点上的 Kubelet 配置。 返回: 总是 示例: {"cpu_cfs_quota": true, "cpu_cfs_quota_period": "100ms", "cpu_manager_policy": "static", "fail_swap_on": false, "image_gc_high_threshold": 85, "image_gc_low_threshold": 80, "topology_manager_policy": "none"}
kubelet_disk_type 字符串	确定 emptyDir 卷、容器运行时数据根和 Kubelet 临时存储的放置位置。 返回: 总是 示例: "OS"
linux_os_config 字典	Linux 代理节点的操作系统配置。 返回: 总是 示例: {"swap_file_size_mb": 1500, "sysctls": {}, "transparent_huge_page_defrag": "defer+madvise", "transparent_huge_page_enabled": "madvise"}
max_count 整数	自动缩放的最大节点数。 返回: 总是 示例: 10
max_pods 整数	可以在节点上运行的最大 Pod 数。 返回: 总是 示例: 42
min_count 整数	自动缩放的最小节点数。 返回: 总是 示例: 1
mode 字符串	AgentPoolMode 表示代理池的模式。 返回: 总是 示例: "System"
name 字符串	资源名称。 返回: 总是 示例: "default"
node_image_version 字符串	节点映像的版本。 返回: 总是 示例: "AKSUbuntu-1804gen2containerd-2022.08.23"
node_labels 列表 / 元素=字符串	要跨代理池中的所有节点持久化的代理池节点标签。 返回: 总是 示例: [{"release": "stable"}]
node_public_ip_prefix_id 字符串	Azure 公共 IP 前缀的 ID。 返回: 总是
node_taints 列表 / 元素=字符串	在节点池创建和缩放期间添加到新节点的污点。 返回: 总是 示例: ["CriticalAddonsOnly=false:NoSchedule"]
orchestrator_version 字符串	创建托管群集时指定的 Orchestrator 版本。 返回: 总是 示例: "1.22.11"
os_disk_size_gb 整数	OS 磁盘大小（以 GB 为单位），用于指定此主/代理池中每台计算机的磁盘大小。 返回: 总是 示例: 128
os_sku 字符串	节点代理池的 SKU。 返回: 总是 示例: "Ubuntu"
os_type 字符串	OsType 用于指定操作系统类型。 返回: 总是 示例: "Linux"
power_state 字典	代理池的电源状态。 返回: 总是 示例: {"code": "Running"}
provisioning_state 字符串	当前部署或预配状态，仅出现在响应中。 返回: 总是 示例: "Succeeded"
proximity_placement_group_id 字符串	接近放置组的 ID。 返回: 总是 示例: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/proximityPlacementGroups/proxi01"
resource_group 字符串	资源组名称。 返回: 总是 示例: "myRG"
scale_down_mode 字符串	这也会影响群集自动缩放器的行为。 返回: 总是 示例: "Delete"
scale_set_eviction_policy 字符串	ScaleSetEvictionPolicy，用于指定 Spot 虚拟机规模集的驱逐策略。 返回: 总是
scale_set_priority 字符串	caleSetPriority，用于指定虚拟机规模集优先级。 返回: 总是
security_profile 复杂类型	代理池的安全设置。 返回: 成功
enable_secure_boot 布尔值	安全启动已禁用或启用。 返回: 总是 示例: true
enable_vtpm 布尔值	vTPM 已启用或禁用。 返回: 总是 示例: true
spot_max_price 浮点数	SpotMaxPrice，用于指定您愿意支付的最高美元价格。 返回: 总是
tags 字典	节点代理池的标记。 返回: 总是 示例: {"key1": "value1", "key2": "value2"}
type 字符串	资源类型。 返回: 总是 示例: "Microsoft.ContainerService/managedClusters/agentPools"
type_properties_type 字符串	AgentPoolType 表示代理池的类型。 返回: 总是 示例: "VirtualMachineScaleSets"
upgrade_settings 字符串	用于升级代理池的设置。 返回: 总是
vm_size 字符串	代理 VM 的大小。 返回: 总是 示例: "Standard_B2s"
vnet_subnet_id 字符串	VNet SubnetID 指定 VNet 的子网标识符。 返回: 总是
workload_runtime 字符串	确定节点可以运行的工作负载类型。 返回: 总是 示例: "OCIContainer"

作者

• xuzhang3 (@xuzhang3)

• Fred Sun (@Fred-sun)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）