Spec-Zone.ru › Ansible

azure.azcollection.azure_rm_aksagentpool_info модуль — Отображение деталей пула узлов в управляемом кластере Kubernetes

Примечание

Этот модуль входит в состав коллекции azure.azcollection (версия 2.7.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

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"

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.

Варианты:

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

cert_validation_mode

string

added in 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

added in azure.azcollection 0.0.1

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

Default: "AzureCloud"

cluster_name

string / required

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

disable_instance_discovery

boolean

added in 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

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

password

string

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

profile

string

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

resource_group

string / required

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

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.
  • Для аутентификации через служебный принцип передайте 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]

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"

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

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

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

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

orchestrator_version

string

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

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

Пример: "1.22.11"

os_disk_size_gb

integer

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

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

Пример: 128

os_sku

string

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

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

Пример: "Windows2022"

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"

type_properties_type

строка

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

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

Пример: "VirtualMachineScaleSets"

upgrade_settings

строка

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

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

vm_size

строка

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

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

Пример: "Standard_B2s"

vnet_subnet_id

строка

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

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

workload_runtime

строка

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

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

Пример: "OCIContainer"

Авторы

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

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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