Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.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

псевдонимы: aws_access_key_id, aws_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 в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK.

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

Путь к пакету центров сертификации, который используется для проверки сертификатов 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 / обязательный

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

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего числа) вызовов API "resource:action", выполненных в задаче, и выводить их набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных в плейбуке.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

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

disk_size

integer

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

endpoint_url

псевдонимы: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную среды AWS_URL.

instance_types

list / элементы=string

Укажите типы экземпляров для группы узлов. Если указан параметр launch_template, не указывайте instance_types, иначе развертывание группы узлов завершится с ошибкой.

labels

dictionary

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

По умолчанию: {}

launch_template

dictionary

Объект, представляющий спецификацию шаблона запуска группы узлов.

Если параметр указан, не указывайте instanceTypes, diskSize или remoteAccess.

id

string

Идентификатор шаблона запуска.

name

string

Имя шаблона запуска.

version

string

Версия шаблона запуска, которую следует использовать.

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

name

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

Имя группы узлов EKS.

node_role

string

ARN роли IAM, используемой группой узлов кластера EKS.

profile

псевдонимы: aws_profile

string

Именованный профиль AWS для аутентификации.

Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token.

purge_tags

boolean

Удалять существующие теги, отсутствующие в группе узлов.

Варианты:

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

region

псевдонимы: aws_region

string

Регион AWS, который следует использовать.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

release_version

string

Версия AMI оптимизированного AMI Amazon EKS, используемого группой узлов.

remote_access

dictionary

Конфигурация удаленного доступа (SSH) для группы узлов. Если указан параметр launch_template, не указывайте remote_access, иначе развертывание группы узлов завершится с ошибкой.

ec2_ssh_key

string

Ключ SSH Amazon EC2, предоставляющий доступ к узлам управляемой группы узлов через SSH.

source_sg

list / элементы=string

Группы безопасности, которым разрешен доступ по SSH (порт 22) к узлам.

scaling_config

dictionary

Сведения о конфигурации масштабирования группы Auto Scaling, создаваемой для группы узлов.

По умолчанию: {"desired_size": 1, "max_size": 2, "min_size": 1}

desired_size

integer

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

max_size

integer

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

min_size

integer

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

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа 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 в порядке убывания приоритета.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS botocore SDK.

session_token

псевдонимы: aws_session_token

string

Токен сеанса 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.

Параметры session_token и profile являются взаимоисключающими.

state

string

Создать или удалить группу узлов.

Варианты:

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

subnets

list / элементы=string

Список идентификаторов подсетей для кластера Kubernetes.

tags

псевдонимы: resource_tags

dictionary

Словарь тегов ресурсов.

taints

list / элементы=dictionary

Тинты Kubernetes, применяемые к узлам группы узлов.

По умолчанию: []

effect

string

Эффект тинта.

Варианты:

  • "NO_SCHEDULE"
  • "NO_EXECUTE"
  • "PREFER_NO_SCHEDULE"

key

string

Ключ тинта.

value

string

Значение тинта.

update_config

dictionary

Конфигурация обновления группы узлов.

По умолчанию: {"max_unavailable": 1}

max_unavailable

integer

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

max_unavailable_percentage

integer

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

validate_certs

boolean

Если установлено значение false, сертификаты SSL не будут проверяться при взаимодействии с API AWS.

Настоятельно не рекомендуется устанавливать validate_certs=false; в качестве альтернативы рассмотрите возможность указать aws_ca_bundle.

Варианты:

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

wait

boolean

Определяет, ожидает ли модуль создания или удаления профиля, прежде чем продолжить выполнение.

Варианты:

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

wait_timeout

integer

Время ожидания перехода группы узлов в активное состояние, в секундах. Значение по умолчанию — 1200 секунд.

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

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста Ansible «host», а не «controller». Поэтому файлы может потребоваться явно скопировать на «host». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста Ansible «controller», а не «host».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и другие настройки, например регион, из файлов конфигурации в контексте Ansible «host» (обычно ~/.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

string

Тип AMI, указанный в конфигурации группы узлов.

Возвращается: когда state имеет значение present

Пример: "need_validate"

capacity_type

string

Тип емкости управляемой группы узлов.

Возвращается: когда state имеет значение present

Пример: "need_validate"

cluster_name

string

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

Возвращается: когда state имеет значение present

Пример: "test_cluster"

created_at

string

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

Возвращается: когда state имеет значение present

Пример: "2022-01-18T20:00:00.111000+00:00"

diskSize

integer

Размер диска, указанный в конфигурации группы узлов.

Возвращается: когда state имеет значение present

Пример: 20

health

dictionary

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

Возвращается: когда state имеет значение present

Пример: "need_validate"

instance_types

list / elements=string

Тип экземпляра, связанный с группой узлов.

Возвращается: когда state имеет значение present

Пример: ["need_validate"]

labels

dictionary

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

Возвращается: когда state имеет значение present

Пример: "need_validate"

launch_template

dictionary

Если для создания группы узлов использовался шаблон запуска, здесь указан этот шаблон.

Возвращается: когда state имеет значение present

Пример: "need_validate"

modified_at

string

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

Возвращается: когда state имеет значение present

Пример: "2022-01-18T20:00:00.111000+00:00"

node_role

string

ARN роли IAM, используемой группой узлов.

Возвращается: когда state имеет значение present

Пример: "arn:aws:eks:us-east-1:1231231123:role/asdf"

nodegroup_arn

string

Имя ресурса Amazon (ARN), связанное с управляемой группой узлов.

Возвращается: когда state имеет значение present

Пример: "arn:aws:eks:us-east-1:1231231123:safd"

nodegroup_name

string

Имя управляемой группы узлов Amazon EKS.

Возвращается: когда state имеет значение present

Пример: "test_cluster"

release_version

string

Версия оптимизированного AMI Amazon EKS, с которой была развернута группа узлов.

Возвращается: когда state имеет значение present

Пример: "need_validate"

remote_access

dictionary

Конфигурация удаленного доступа, связанная с группой узлов.

Возвращается: когда state имеет значение present

Пример: "need_validate"

resources

complex

Ресурсы, связанные с группой узлов.

Возвращается: когда state имеет значение present

autoScalingGroups

list / elements=dictionary

Группы Auto Scaling, связанные с группой узлов.

Возвращается: когда state имеет значение present

remoteAccessSecurityGroup

string

Группа безопасности для удаленного доступа, связанная с группой узлов.

Возвращается: когда state имеет значение present

scaling_config

dictionary

Параметры конфигурации масштабирования группы Auto Scaling, связанной с группой узлов.

Возвращается: когда state имеет значение present

Пример: "need_validate"

status

string

Состояние группы узлов EKS.

Возвращается: когда state имеет значение present

Пример: "['CREATING', 'ACTIVE']"

subnets

list / elements=string

Список подсетей, используемых в профиле Fargate.

Возвращается: когда state имеет значение present

Пример: ["subnet-qwerty123", "subnet-asdfg456"]

tags

dictionary

Теги группы узлов.

Возвращается: когда state имеет значение present

Пример: {"foo": "bar"}

taints

list / elements=string

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

Возвращается: когда state имеет значение present

Пример: ["need_validate"]

update_config

dictionary

Конфигурация обновления группы узлов.

Возвращается: когда state имеет значение present

maxUnavailable

integer

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

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

maxUnavailablePercentage

integer

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

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

version

string

Версия Kubernetes управляемой группы узлов.

Возвращается: когда state имеет значение present

Пример: "need_validate"

Авторы

  • Tiago Jarra (@tjarra)

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

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

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

Spec-Zone.ru

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