Модуль azure.azcollection.azure_rm_aksagentpool — Управление пулами узлов в кластере Kubernetes

ad_user

string

Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с субъектом безопасности.

adfs_authority_url

string

added in azure.azcollection 0.0.1

URL-адрес узла Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и имеет собственный узел ADFS.

api_profile

string

added in azure.azcollection 0.0.1

Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.

Default: "latest"

append_tags

boolean

Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам.

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

• false
• true ← (default)

auth_source

string

added in 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 могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка.

Параметр msi был добавлен в Ansible 2.6.

Choices:

• "auto" ← (default)
• "cli"
• "credential_file"
• "env"
• "msi"

availability_zones

list / elements=integer

Зоны доступности для узлов. Должен использовать AgentPoolType VirtualMachineScaleSets.

Choices:

• 1
• 2
• 3

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

• "ignore"
• "validate"

client_id

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi).

Также может быть задана через переменную среды AZURE_CLIENT_ID.

cloud_environment

string

added in azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT.

Default: "AzureCloud"

cluster_name

string / required

Имя кластера Kubernetes.

count

integer

Количество агентов (виртуальных машин) для размещения контейнеров Docker.

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате важно убедиться, что настроенный узел authority является действительным и заслуживающим доверия.

Задается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

• false ← (default)
• true

enable_auto_scaling

boolean

Включать ли автомасштабирование.

Choices:

• false
• true

enable_encryption_at_host

boolean

Поддерживается только на определенных размерах виртуальных машин и в определенных регионах Azure.

Choices:

• false
• true

enable_fips

boolean

Включить узлы пула FIPS.

Выбираемые значения:

• false
• true

enable_node_public_ip

boolean

В некоторых сценариях узлам пула могут потребоваться собственные публичные IP-адреса.

Частым примером является работа с игровыми приложениями, где консоли должны осуществлять прямое подключение к виртуальным машинам в облаке, чтобы минимизировать количество переходов.

Выбираемые значения:

• false
• true

enable_ultra_ssd

boolean

Включить UltraSSD.

Выбираемые значения:

• false
• true

gpu_instance_profile

string

GPUInstanceProfile, используемый для задания профиля экземпляра MIG GPU для поддерживаемых SKU виртуальных машин с GPU.

Выбираемые значения:

• "MIG1g"
• "MIG2g"
• "MIG3g"
• "MIG4g"
• "MIG7g"

kubelet_config

dictionary

Конфигурация Kubelet на узлах пула агентов.

allowed_unsafe_sysctls

list / elements=string

Разрешённый список небезопасных sysctl или шаблонов небезопасных sysctl.

container_log_max_files

integer

Максимальное количество файлов логов контейнеров, которые могут присутствовать для контейнера. Число должно быть ≥ 2.

container_log_max_size_mb

integer

Максимальный размер файла логов контейнера, прежде чем он будет переименован.

cpu_cfs_quota

boolean

По умолчанию true.

Выбираемые значения:

• false
• true ← (по умолчанию)

cpu_cfs_quota_period

string

По умолчанию 100ms.

Допустимые значения — последовательность десятичных чисел с необязательной дробной частью и суффиксом единицы измерения.

По умолчанию: "100ms"

cpu_manager_policy

string

Политики управления процессором Kubernetes.

По умолчанию none.

Выбираемые значения:

• "none" ← (по умолчанию)
• "static"

fail_swap_on

boolean

Если установлено в значение true, Kubelet будет завершать работу с ошибкой, если на узле включён swap.

Выбираемые значения:

• false
• true

image_gc_high_threshold

integer

Для отключения сбора мусора образов установите значение 100.

По умолчанию 85

По умолчанию: 85

image_gc_low_threshold

integer

Это значение не может быть выше, чем imageGcHighThreshold.

По умолчанию 80.

По умолчанию: 80

pod_max_pids

integer

Максимальное количество процессов на под.

topology_manager_policy

string

Политики менеджера топологии Kubernetes.

По умолчанию none.

Выбираемые значения:

• "none" ← (по умолчанию)
• "best-effort"
• "restricted"
• "single-numa-node"

kubelet_disk_type

string

Определяет размещение томов emptyDir, корневую директорию контейнерного времени выполнения и хранилище Kubelet.

Выбираемые значения:

• "OS"
• "Temporary"

linux_os_config

dictionary

Конфигурация ОС узлов Linux-агентов.

swap_file_size_mb

integer

Размер файла подкачки в МБ, который будет создан на каждом узле.

sysctls

dictionary

Настройки Sysctl для узлов агента Linux.

fs_aio_max_nr

integer

Настройка Sysctl fs.aio-max-nr.

fs_file_max

integer

Настройка Sysctl fs.file-max.

fs_inotify_max_user_watches

integer

Настройка Sysctl fs.inotify.max_user_watches.

fs_nr_open

integer

Настройка Sysctl fs.nr_open.

kernel_threads_max

integer

Настройка Sysctl kernel.threads-max.

net_core_netdev_max_backlog

integer

Настройка Sysctl net.core.netdev_max_backlog.

net_core_optmem_max

integer

Настройка Sysctl net.core.optmem_max.

net_core_rmem_default

integer

Настройка Sysctl net.core.rmem_default.

net_core_rmem_max

integer

Настройка Sysctl net.core.rmem_max.

net_core_somaxconn

integer

Настройка Sysctl net.core.somaxconn.

net_core_wmem_default

integer

Настройка Sysctl net.core.wmem_default.

net_core_wmem_max

integer

Настройка Sysctl net.core.wmem_max.

net_ipv4_ip_local_port_range

string

Настройка Sysctl net.ipv4.ip_local_port_range.

net_ipv4_neigh_default_gc_thresh1

integer

Настройка Sysctl net.ipv4.neigh.default.gc_thresh1.

net_ipv4_neigh_default_gc_thresh2

integer

Настройка Sysctl net.ipv4.neigh.default.gc_thresh2.

net_ipv4_neigh_default_gc_thresh3

integer

Настройка Sysctl net.ipv4.neigh.default.gc_thresh3.

net_ipv4_tcp_fin_timeout

integer

Настройка Sysctl net.ipv4.tcp_fin_timeout.

net_ipv4_tcp_keepalive_probes

integer

Настройка Sysctl net.ipv4.tcp_keepalive_probes.

net_ipv4_tcp_keepalive_time

integer

Настройка Sysctl net.ipv4.tcp_keepalive_time.

net_ipv4_tcp_max_syn_backlog

integer

Настройка Sysctl net.ipv4.tcp_max_syn_backlog.

net_ipv4_tcp_max_tw_buckets

integer

Настройка Sysctl net.ipv4.tcp_max_tw_buckets.

net_ipv4_tcp_tw_reuse

boolean

Настройка Sysctl net.ipv4.tcp_tw_reuse.

Варианты:

• false
• true

net_ipv4_tcpkeepalive_intvl

integer

Настройка Sysctl net.ipv4.tcp_keepalive_intvl.

net_netfilter_nf_conntrack_buckets

integer

Настройка 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

целое число

Максимальное количество подложек, которые могут работать на узле.

min_count

целое число

Минимальное количество узлов для автоматического масштабирования.

mode

строка

AgentPoolMode представляет режим пула агентов.

Варианты:

• "System"
• "User"

name

строка / обязательно

Имя пула узлов агента.

node_labels

словарь

Метки узлов пула агентов, сохраняемые на всех узлах в пуле агентов.

node_public_ip_prefix_id

строка

Идентификатор префикса общедоступного IP-адреса Azure.

node_taints

список / элементы=строка

Метки, добавленные к новым узлам во время создания и масштабирования пула узлов.

Например, значение: 'NoSchedule'.

orchestrator_version

строка

Версия оркестратора, указанная при создании управляемого кластера.

os_disk_size_gb

целое число

Размер диска ОС в ГБ, используемый для указания размера диска для каждой машины в этом мастер/агентском пуле.

os_sku

строка

Указывает SKU ОС.

Это значение не должно быть указано, если OSType — Windows.

Варианты:

• "Ubuntu"
• "CBLMariner"

os_type

строка

OsType, используемый для указания типа ОС.

Варианты:

• "Linux"
• "Windows"

password

строка

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо принципа службы.

power_state

словарь

При первом создании пула агентов он находится в состоянии Running.

Пул агентов можно остановить, установив это поле в Stopped.

Остановленный пул агентов останавливает все свои виртуальные машины и не начисляет плату за использование.

Пул агентов можно остановить только если он работает, а состояние подготовки — Успешно.

code

string

Указывает, находится ли кластер в Running или Stopped состоянии.

Варианты:

• "Running"
• "Stopped"

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

proximity_placement_group_id

string

Идентификатор группы близости размещения.

resource_group

string / обязательно

Имя группы ресурсов.

scale_down_mode

string

Это также влияет на поведение автоматического масштабирования кластера.

Если не указано, по умолчанию используется Delete.

Варианты:

• "Delete" ← (по умолчанию)
• "Deallocate"

scale_set_eviction_policy

string

Это нельзя указать, если scale_set_priority=Spot.

Если не указано, значение по умолчанию Delete.

Варианты:

• "Delete"
• "Deallocate"

scale_set_priority

string

Приоритет набора масштабирования виртуальных машин.

Если не указано, значение по умолчанию Regular.

Варианты:

• "Spot"
• "Regular"

secret

string

Секрет Azure клиента. Используется при аутентификации с помощью принципала службы.

spot_max_price

float

Возможные значения — любые десятичные значения больше нуля или -1.

Указывает готовность заплатить любую цену по запросу.

state

string

Состояние выполнения сценария автоматизации. Используйте present для создания или обновления сценария автоматизации и absent для удаления.

Варианты:

• "present" ← (по умолчанию)
• "absent"

subscription_id

string

Ваш идентификатор подписки Azure.

tags

dictionary

Словарь пар «строка:строка» для назначения метаданных объекту.

Метаданные-метки объекта будут обновлены любыми предоставленными значениями.

Для удаления меток установите параметр append_tags в false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в метке.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают только 15 меток для ресурсов.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток цифровой подписи открытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью принципала службы.

Требуется, если определен x509_certificate_path.

type_properties_type

string

AgentPoolType представляет типы пула агентов.

Варианты:

• "VirtualMachineScaleSets"
• "AvailabilitySet"

upgrade_settings

dictionary

Настройки для обновления пула агентов.

max_surge

string

Это может быть целое число, например 5, или процент 50%. Если указан процент, это процент от общего размера пула агентов на момент обновления.

Для процентов дробные узлы округляются вверх.

Если не указано, значение по умолчанию 1.

vm_size

string

Размер виртуальных машин агентов.

vnet_subnet_id

string

VNet SubnetID указывает идентификатор подсети VNet.

workload_runtime

string

Определяет тип рабочей нагрузки, которую может выполнять узел.

Варианты:

• "OCIContainer"
• "WasmWasi"

x509_certificate_path

path

added in azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания управляющего принципа в формате PEM.

Сертификат должен быть присоединён к закрытому ключу.

Используется при аутентификации с помощью управляющего принципа.

aks_agent_pools

complex

Подробная информация о пуле узлов в управляемом кластере Kubernetes.

Возвращается: всегда

availability_zones

list / elements=string

Зоны доступности для узлов. Необходимо использовать AgentPoolType VirtualMachineScaleSets.

Возвращается: всегда

Пример: [1, 2]

cluster_name

string

Имя кластера.

Возвращается: всегда

Пример: "testcluster"

count

integer

Количество агентов (ВМ) для размещения контейнеров Docker.

Возвращается: всегда

Пример: 2

enable_auto_scaling

string

Включить автомасштабирование.

Возвращается: всегда

enable_encryption_at_host

boolean

Поддерживается только для определенных размеров ВМ и в определенных регионах Azure.

Возвращается: всегда

Пример: false

enable_node_public_ip

string

Включить публичный IP для узлов.

Возвращается: всегда

Пример: "bool"

enable_ultra_ssd

boolean

Включить пул узлов FIPS.

Возвращается: всегда

Пример: false

gpu_instance_profile

string

GPUInstanceProfile для указания профиля экземпляра GPU MIG для поддерживаемого SKU виртуальной машины GPU.

Возвращается: всегда

Пример: "MIG1g"

id

string

Идентификатор ресурса.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxxf/resourcegroups/myRG/providers/Microsoft.ContainerService/managedClusters/cluster/agentPools/default"

kubelet_config

dictionary

Конфигурация 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

string

Определяет размещение томов emptyDir, корневого каталога среды выполнения контейнеров и эфемерного хранилища Kubelet.

Возвращается: всегда

Пример: "OS"

linux_os_config

dictionary

Конфигурация ОС узлов агента Linux.

Возвращается: всегда

Пример: {"swap_file_size_mb": 1500, "sysctls": {}, "transparent_huge_page_defrag": "defer+madvise", "transparent_huge_page_enabled": "madvise"}

max_count

integer

Максимальное количество узлов для автомасштабирования.

Возвращается: всегда

Пример: 10

max_pods

integer

Максимальное количество подсетей, которые могут работать на узле.

Возвращается: всегда

Пример: 42

min_count

integer

Минимальное количество узлов для автомасштабирования.

Возвращается: всегда

Пример: 1

mode

string

AgentPoolMode представляет режим пула агентов.

Возвращается: всегда

Пример: "System"

name

string

Имя ресурса.

Возвращается: всегда

Пример: "default"

node_image_version

string

Версия образа узла.

Возвращается: всегда

Пример: "AKSUbuntu-1804gen2containerd-2022.08.23"

node_labels

list / elements=string

Метки узлов пула агентов, которые должны сохраняться на всех узлах в пуле агентов.

Возвращается: всегда

Пример: [{"release": "stable"}]

node_public_ip_prefix_id

string

ID префикса общедоступного IP-адреса Azure.

Возвращается: всегда

node_taints

list / elements=string

Заражения, добавляемые к новым узлам во время создания и масштабирования пула узлов.

Возвращается: всегда

Пример: ["CriticalAddonsOnly=false:NoSchedule"]

orchestrator_version

string

Версия оркестратора, указанная при создании управляемого кластера.

Возвращается: всегда

Пример: "1.22.11"

os_disk_size_gb

integer

Размер диска ОС в ГБ, который будет использоваться для указания размера диска для каждой машины в этом главном/агентском пуле.

Возвращается: всегда

Пример: 128

os_sku

string

SKU пула агентов узлов.

Возвращается: всегда

Пример: "Ubuntu"

os_type

string

OsType, который будет использоваться для указания типа ОС.

Возвращается: всегда

Пример: "Linux"

power_state

dictionary

Состояние питания пула агентов.

Возвращается: всегда

Пример: {"code": "Running"}

provisioning_state

string

Текущее состояние развертывания или подготовки, которое отображается только в ответе.

Возвращается: всегда

Пример: "Succeeded"

proximity_placement_group_id

string

ID для группы размещения Proximity Placement Group.

Возвращается: всегда

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/proximityPlacementGroups/proxi01"

resource_group

string

Имя группы ресурсов.

Возвращается: всегда

Пример: "myRG"

scale_down_mode

string

Это также влияет на поведение автомасштабирования кластера.

Возвращается: всегда

Пример: "Delete"

scale_set_eviction_policy

string

ScaleSetEvictionPolicy, который будет использоваться для указания политики выселения для масштабируемого набора виртуальных машин Spot.

Возвращается: всегда

scale_set_priority

string

caleSetPriority, который будет использоваться для указания приоритета масштабируемого набора виртуальных машин.

Возвращается: всегда

spot_max_price

float

SpotMaxPrice, который будет использоваться для указания максимальной цены, которую вы готовы заплатить в долларах США.

Возвращается: всегда

метки

словарь

Метки пула узлов-агентов.

Возвращается: всегда

Пример: {"key1": "value1", "key2": "value2"}

тип

строка

Тип ресурса.

Возвращается: всегда

Пример: "Microsoft.ContainerService/managedClusters/agentPools"

тип_свойства_тип

строка

AgentPoolType представляет типы пула агентов.

Возвращается: всегда

Пример: "VirtualMachineScaleSets"

параметры_обновления

строка

Настройки для обновления пула агентов.

Возвращается: всегда

размер_вм

строка

Размер виртуальных машин агентов.

Возвращается: всегда

Пример: "Standard_B2s"

идентификатор_подсети_в_сети

строка

VNet SubnetID указывает идентификатор подсети сети VNet.

Возвращается: всегда

среда_работы_рабочей_нагрузки

строка

Определяет тип рабочей нагрузки, которую может выполнять узел.

Возвращается: всегда

Пример: "OCIContainer"