Spec-Zone.ru › Ansible

модуль azure.azcollection.azure_rm_aksagentpool_info – Показать сведения о пуле узлов в управляемом кластере Kubernetes

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_aksagentpool_info.

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Получить сведения о пуле узлов в управляемом кластере Kubernetes.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 2.7
  • На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, выполняющем модули из azure.azcollection
  • Полные инструкции по установке доступны по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

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

adfs_authority_url

string

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

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

api_profile

string

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

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

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

auth_source

string

добавлено в 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; в противном случае используется подписка Azure CLI по умолчанию.

Если установлено значение msi, хост-компьютер должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае выбирается первая подписка.

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

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

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

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

Варианты:

  • "ignore"
  • "validate"

client_id

string

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

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

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

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

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

cluster_name

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

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

disable_instance_discovery

boolean

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

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

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

Варианты:

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

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Имя пула узлов.

oidc_token

string

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

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC.

Подходит для систем CI (например, GitHub Actions, Azure DevOps), в которых платформа предоставляет токен OIDC напрямую.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, сохраняющих токены OIDC в файлах.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

string

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

profile

string

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

resource_group

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

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

secret

string

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

subscription_id

string

Идентификатор вашей подписки Azure.

tenant

string

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

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

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

Обязателен, если задан параметр x509_certificate_path.

x509_certificate_path

path

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

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат должен быть добавлен в конец файла закрытого ключа.

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

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или выполнить вход перед запуском задач или плейбука с помощью az login.
  • Аутентификация также возможна с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации с помощью субъекта-службы передайте 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: Get node agent pool by cluster name
  azure_rm_aksagentpool_info:
    resource_group: myRG
    cluster_name: testcluster

- name: Get node agent pool by name
  azure_rm_aksagentpool_info:
    resource_group: myRG
    cluster_name: testcluster
    name: default

Возвращаемые значения

Общие возвращаемые значения описаны здесь, далее перечислены поля, уникальные для этого модуля:

Ключ

Описание

aks_agent_pools

complex

Сведения о пуле узлов в управляемом кластере Kubernetes.

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

availability_zones

list / elements=string

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

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

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

capacity_reservation_group_id

string

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

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

Пример: "/subscriptions/xxxxx/resourceGroups/testRG/providers/Microsoft.Compute/capacityReservationGroups/crgid"

cluster_name

string

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

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

Пример: "testcluster"

count

integer

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

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

Пример: 2

enable_auto_scaling

boolean

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

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

enable_encryption_at_host

boolean

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

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

Пример: false

enable_node_public_ip

boolean

Включить общедоступный IP-адрес для узлов.

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

Пример: true

enable_ultra_ssd

boolean

Включено ли использование пула узлов FIPS.

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

Пример: false

gpu_instance_profile

string

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

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

Пример: "MIG1g"

host_group_id

string

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

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

Пример: "/subscriptions/xxxxx/resourceGroups/testRG/providers/Microsoft.Compute/hostGroups/hostgroup"

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"

network_profile

complex

Параметры сети пула агентов.

Возвращается: при использовании

allowed_host_ports

list / elements=string

Диапазоны портов, доступ к которым разрешен.

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

Пример: [{"port_end": 200, "port_start": 10, "protocol": "TCP"}]

application_security_groups

list / elements=string

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

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

Пример: ["/subscriptions/xxxxxx/resourceGroups/testRG/providers/Microsoft.Network/applicationSecurityGroups/appnsg"]

node_image_version

string

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

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

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

node_labels

list / elements=string

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

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

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

node_public_ip_prefix_id

string

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

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

node_taints

list / elements=string

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

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

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

orchestrator_version

string

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

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

Пример: "1.22.11"

os_disk_size_gb

integer

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

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

Пример: 128

os_disk_type

string

Тип диска ОС.

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

Пример: "Managed"

os_sku

string

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

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

Пример: "Windows2022"

os_type

string

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

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

Пример: "Linux"

pod_subnet_id

string

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

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

Пример: "/subscriptions/xxxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/My_Virtual_Network/subnets/foobar"

power_state

dictionary

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

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

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

provisioning_state

string

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

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

Пример: "Succeeded"

proximity_placement_group_id

string

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

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

Пример: "/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 используется для указания приоритета масштабируемого набора виртуальных машин.

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

security_profile

complex

Параметры безопасности пула агентов.

Возвращается: при успешном выполнении

enable_secure_boot

boolean

Безопасная загрузка отключена или включена.

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

Пример: true

enable_vtpm

boolean

vTPM отключен или включен.

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

Пример: true

spot_max_price

float

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

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

tags

dictionary

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

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

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

type

string

Тип ресурса.

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

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

type_properties_type

string

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

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

Пример: "VirtualMachineScaleSets"

upgrade_settings

string

Параметры обновления пула агентов.

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

vm_size

string

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

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

Пример: "Standard_B2s"

vnet_subnet_id

string

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

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

windows_profile

dictionary

Специальный профиль пула агентов Windows.

Возвращается: при использовании

Пример: {"disable_outbound_nat": false}

workload_runtime

string

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

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

Пример: "OCIContainer"

Авторы

  • xuzhang3 (@xuzhang3)
  • Fred Sun (@Fred-sun)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_aksagentpool_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API