Модуль community.aws.eks_nodegroup — Управление группой узлов EKS

Примечание

Этот модуль входит в коллекцию community.aws (версия 8.0.0).

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

Для установки используйте: ansible-galaxy collection install community.aws.

Для использования в плейбуке укажите: community.aws.eks_nodegroup.

Новое в community.aws 5.3.0

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

Управление группой узлов EKS.

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации о токенах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` также могут использоваться в порядке убывания предпочтения. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
ami_type string	Тип AMI для вашей группы узлов. Варианты: `"AL2_x86_64"` `"AL2_x86_64_GPU"` `"AL2_ARM_64"` `"CUSTOM"` `"BOTTLEROCKET_ARM_64"` `"BOTTLEROCKET_x86_64"`
aws_ca_bundle path	Расположение пакета CA, который используется при проверке сертификатов SSL. Переменная среды `AWS_CA_BUNDLE` также может использоваться.
aws_config dictionary	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
capacity_type string	Тип емкости для вашей группы узлов. Варианты: `"ON_DEMAND"` ← (по умолчанию) `"SPOT"`
cluster_name string / required	Имя кластера EKS.
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, сделанный во время выполнения playbook. Переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
disk_size integer	Размер диска в узлах группы узлов. Если вы указываете launch_template, то не указывайте disk_size, иначе развертывание группы узлов завершится ошибкой.
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды `AWS_URL` или `EC2_URL` также могут использоваться в порядке убывания предпочтения. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
instance_types list / elements=string	Укажите типы экземпляров для группы узлов. Если вы указываете launch_template, то не указывайте instance_types, иначе развертывание группы узлов завершится ошибкой.
labels dictionary	Метки Kubernetes, которые будут применены к узлам в группе узлов при их создании. Значение по умолчанию: `{}`
launch_template dictionary	Объект, представляющий спецификацию шаблона запуска группы узлов. Если указано, то не указывайте instanceTypes, diskSize или remoteAccess.
id string	Идентификатор шаблона запуска.
name string	Имя шаблона запуска.
version string	Версия шаблона запуска, которую нужно использовать. Если версия не указана, используется версия шаблона по умолчанию.
name string / required	Имя группы узлов EKS.
node_role string	ARN роли IAM, используемой группой узлов кластера EKS.

profile aliases: aws_profile строка	Используемый именованный профиль AWS для аутентификации. См. документацию AWS для получения дополнительной информации об именованных профилях https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.
purge_tags логическое	Удалить существующие теги, которых нет в группе узлов. Варианты: `false` `true` ← (по умолчанию)
region aliases: aws_region, ec2_region строка	Используемый регион AWS. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменные среды `AWS_REGION` или `EC2_REGION`. Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
release_version строка	Версия AMI оптимизированного AMI Amazon EKS для использования с группой узлов.
remote_access словарь	Конфигурация удалённого доступа (SSH) для использования с вашей группой узлов. Если вы указали launch_template, не указывайте remote_access, в противном случае развертывание группы узлов завершится ошибкой.
ec2_ssh_key строка	Ключ SSH Amazon EC2 для доступа к SSH-соединению с узлами в управляемой группе узлов.
source_sg список / элементы=строка	Список групп безопасности, которым разрешен SSH-доступ (порт 22) к узлам.
scaling_config словарь	Подробная информация о конфигурации масштабирования для группы автоматического масштабирования, созданной для вашей группы узлов. По умолчанию: `{"desired_size": 1, "max_size": 2, "min_size": 1}`
desired_size целое число	Текущее количество узлов, которое управляемая группа узлов должна поддерживать.
max_size целое число	Максимальное количество узлов, до которого может масштабироваться управляемая группа узлов.
min_size целое число	Минимальное количество узлов, до которого может масштабироваться управляемая группа узлов.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации об маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token строка	AWS STS сессионный токен для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об маркерах доступа https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state строка	Создать или удалить группу узлов. Варианты: `"absent"` `"present"` ← (по умолчанию)
subnets список / элементы=строка	Список идентификаторов подсетей для кластера Kubernetes.

метки псевдонимы: resource_tags словарь	Словарь тегов ресурсов.
меченые_пометки список / элементы=словарь	Метки Kubernetes, которые необходимо применить к узлам в группе узлов. По умолчанию: `[]`
эффект строка	Эффект меченых_пометок. Варианты: `"NO_SCHEDULE"` `"NO_EXECUTE"` `"PREFER_NO_SCHEDULE"`
ключ строка	Ключ меченых_пометок.
значение строка	Значение меченых_пометок.
конфигурация_обновления словарь	Конфигурация обновления группы узлов. По умолчанию: `{"max_unavailable": 1}`
макс_недоступных целое число	Максимальное количество недоступных узлов одновременно во время обновления версии.
макс_недоступных_процентов целое число	Максимальный процент недоступных узлов во время обновления версии.
проверять_сертификаты логическое	При установке в `false`, сертификаты SSL не будут проверены для связи с API AWS. Настройка проверять_сертификаты=false настоятельно не рекомендуется; вместо этого рассмотрите возможность настройки aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
ожидать логическое	Указывает, ожидает ли модуль до создания или удаления профиля перед продолжением. Варианты: `false` ← (по умолчанию) `true`
ожидание_таймаут целое число	Продолжительность ожидания активации группы узлов в секундах. По умолчанию составляет `1200` секунды. По умолчанию: `1200`

Примечания

Примечание

Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста Ansible «хост», а не «контроллер». Таким образом, файлы, возможно, нужно будет явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих файлов конфигурации в контексте Ansible «хост» (обычно ~/.aws/credentials). Более подробную информацию можно найти на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: create nodegroup
  community.aws.eks_nodegroup:
    name: test_nodegroup
    state: present
    cluster_name: test_cluster
    node_role: arn:aws:eks:us-east-1:1231231123:role/asdf
    subnets:
      - subnet-qwerty123
      - subnet-asdfg456
    scaling_config:
      min_size: 1
      max_size: 2
      desired_size: 1
    disk_size: 20
    instance_types: 't3.micro'
    ami_type: 'AL2_x86_64'
    labels:
      'teste': 'test'
    taints:
      - key: 'test'
        value: 'test'
        effect: 'NO_SCHEDULE'
    capacity_type: 'ON_DEMAND'

- name: Remove an EKS Nodegrop
  community.aws.eks_nodegroup:
    name: test_nodegroup
    cluster_name: test_cluster
    wait: true
    state: absent

Значения возврата

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

Ключ	Описание
ami_type строка	Это тип AMI, указанный в конфигурации группы узлов. Возвращается: при наличии параметра state Пример: `"need_validate"`
capacity_type строка	Тип емкости вашей управляемой группы узлов. Возвращается: при наличии параметра state Пример: `"need_validate"`
cluster_name строка	Имя кластера EKS Возвращается: при наличии параметра state Пример: `"test_cluster"`
created_at строка	Дата и время создания группы узлов. Возвращается: при наличии параметра state Пример: `"2022-01-18T20:00:00.111000+00:00"`
diskSize целое число	Это размер диска в конфигурации группы узлов. Возвращается: при наличии параметра state Пример: `20`
health словарь	Статус работоспособности группы узлов. Возвращается: при наличии параметра state Пример: `"need_validate"`
instance_types список / элементы=строка	Это тип экземпляра, связанный с группой узлов. Возвращается: при наличии параметра state Пример: `["need_validate"]`
labels словарь	Метки Kubernetes, примененные к узлам в группе узлов. Возвращается: при наличии параметра state Пример: `"need_validate"`
launch_template словарь	Если для создания группы узлов использовалась шаблон запуска, то это шаблон запуска, который использовался. Возвращается: при наличии параметра state Пример: `"need_validate"`
modified_at строка	Дата и время изменения группы узлов. Возвращается: при наличии параметра state Пример: `"2022-01-18T20:00:00.111000+00:00"`
node_role строка	ARN роли IAM, используемой группой узлов. Возвращается: при наличии параметра state Пример: `"arn:aws:eks:us-east-1:1231231123:role/asdf"`
nodegroup_arn строка	Amazon Resource Name (ARN), связанный с управляемой группой узлов. Возвращается: при наличии параметра state Пример: `"arn:aws:eks:us-east-1:1231231123:safd"`
nodegroup_name строка	Имя, связанное с управляемой группой узлов Amazon EKS. Возвращается: при наличии параметра state Пример: `"test_cluster"`
release_version строка	Это версия оптимизированного AMI Amazon EKS, с которой была развернута группа узлов. Возвращается: при наличии параметра state Пример: `"need_validate"`
remote_access словарь	Это конфигурация удаленного доступа, связанная с группой узлов. Возвращается: при наличии параметра state Пример: `"need_validate"`
resources сложное	Ресурсы, связанные с группой узлов. Возвращается: при наличии параметра state
autoScalingGroups список / элементы=словарь	Группы автоматического масштабирования, связанные с группой узлов. Возвращается: при наличии параметра state

remoteAccessSecurityGroup string	Группа безопасности удалённого доступа, связанная с узловой группой. Возвращается: при наличии состояния
scaling_config dictionary	Подробные данные конфигурации масштабирования для группы автоматического масштабирования, связанной с вашей узловой группой. Возвращается: при наличии состояния Пример: `"need_validate"`
status string	Состояние узловой группы EKS. Возвращается: при наличии состояния Пример: `"['CREATING', 'ACTIVE']"`
subnets list / elements=string	Список подсетей, используемых в профиле Fargate. Возвращается: при наличии состояния Пример: `["subnet-qwerty123", "subnet-asdfg456"]`
tags dictionary	Теги узловой группы. Возвращается: при наличии состояния Пример: `{"foo": "bar"}`
taints list / elements=string	Теги Kubernetes, которые будут применены к узлам в узловой группе при их создании. Возвращается: при наличии состояния Пример: `["need_validate"]`
update_config dictionary	Конфигурация обновления узловой группы. Возвращается: при наличии состояния
maxUnavailable integer	Максимальное количество недоступных узлов одновременно во время обновления версии. Возвращается: при успехе
maxUnavailablePercentage integer	Максимальный процент недоступных узлов во время обновления версии. Возвращается: при успехе
version string	Версия Kubernetes управляемой узловой группы. Возвращается: при наличии состояния Пример: `"need_validate"`

Авторы

Tiago Jarra (@tjarra)

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

© 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/community/aws/eks_nodegroup_module.html