Модуль community.aws.eks_cluster — Управление кластерами Elastic Kubernetes Service (EKS)

Примечание

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

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

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

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

Добавлен в community.aws 1.0.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Управление кластерами Elastic Kubernetes Service (EKS).
До версии 5.0.0 этот модуль назывался community.aws.aws_eks_cluster. Использование не изменилось.

Псевдонимы: aws_eks_cluster

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	Идентификатор ключа доступа AWS. См. документацию AWS для получения дополнительной информации об access-токенах 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 для соответствия SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Расположение файла CA Bundle для проверки SSL-сертификатов. Также может использоваться переменная среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs булево	Использовать `botocore.endpoint` логгер для анализа уникальных (а не суммарных) `"resource:action"` API-вызовов, выполненных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обработчик для вывода полного списка, выполненного во время выполнения playbook. Также может использоваться переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных AWS-эндопоинтов. Хотя это можно использовать для подключения к другим совместимым с AWS-сервисам, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут использоваться переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
name строка / обязательный	Имя кластера EKS.
profile псевдонимы: 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.
region псевдонимы: 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.
role_arn строка	ARN роли IAM, используемой кластером EKS.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа AWS. См. документацию AWS для получения дополнительной информации об access-токенах 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.
security_groups список / элементы=строка	Список имен или ID групп безопасности.

session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительную информацию об access token см. в документации 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 string	Желаемое состояние кластера EKS. Варианты: `"absent"` `"present"` ← (по умолчанию)
subnets list / elements=string	Список идентификаторов подсетей для кластера Kubernetes.
tags dictionary добавлен в community.aws 5.3.0	Словарь тегов для добавления кластера EKS.
validate_certs boolean	Если установлено значение `false`, сертификаты SSL не будут проверяться для связи с API AWS. Установка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)
version string	Версия Kubernetes. По умолчанию `latest`.
wait boolean	Определяет, ожидает ли модуль активации или удаления кластера до перехода к следующему шагу. По данным AWS, это обычно занимает менее 10 минут. Варианты: `false` ← (по умолчанию) `true`
wait_timeout integer	Время ожидания активации кластера в секундах. По умолчанию 1200 секунд (20 минут). По умолчанию: `1200`

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не «контроллер». Поэтому файлы, возможно, нужно явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер», а не «хост».
Используемый Ansible SDK AWS (boto3) также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из конфигурационных файлов в контексте 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 an EKS cluster
  community.aws.eks_cluster:
    name: my_cluster
    version: 1.14
    role_arn: my_eks_role
    subnets:
      - subnet-aaaa1111
    security_groups:
      - my_eks_sg
      - sg-abcd1234
  register: caller_facts

- name: Remove an EKS cluster
  community.aws.eks_cluster:
    name: my_cluster
    wait: true
    state: absent

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

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

Ключ	Описание
arn строка	ARN кластера EKS Возвращается: при наличии состояния Пример: `"arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster"`
certificate_authority сложный	Словарь, содержащий данные Удостоверяющего центра для кластера Возвращается: после создания
data строка	Данные Удостоверяющего центра для кластера в кодировке Base-64 Возвращается: когда кластер создан и активен
created_at строка	Дата и время создания кластера Возвращается: при наличии состояния Пример: `"2018-06-06T11:56:56.242000+00:00"`
endpoint строка	Конечная точка сервера API Kubernetes Возвращается: когда кластер создан и активен Пример: `"https://API_SERVER_ENDPOINT.yl4.us-west-2.eks.amazonaws.com"`
name строка	Имя кластера EKS Возвращается: при наличии состояния Пример: `"my-eks-cluster"`
resources_vpc_config сложный	Конфигурация VPC кластера Возвращается: при наличии состояния
security_group_ids список / элементы=строка	Список идентификаторов групп безопасности Возвращается: всегда Пример: `["sg-abcd1234", "sg-aaaa1111"]`
subnet_ids список / элементы=строка	Список идентификаторов подсетей Возвращается: всегда Пример: `["subnet-abcdef12", "subnet-345678ab", "subnet-cdef1234"]`
vpc_id строка	Идентификатор VPC Возвращается: всегда Пример: `"vpc-a1b2c3d4"`
role_arn строка	ARN роли IAM, используемой кластером Возвращается: при наличии состояния Пример: `"arn:aws:iam::123456789012:role/eks_cluster_role"`
status строка	Состояние кластера EKS Возвращается: при наличии состояния Пример: `"['CREATING', 'ACTIVE']"`
version строка	Версия Kubernetes кластера Возвращается: при наличии состояния Пример: `"1.10"`

Авторы

Will Thames (@willthames)

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

© 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_cluster_module.html