Модуль community.aws.eks_cluster — управление кластерами Elastic Kubernetes Service (EKS)
Примечание
Этот модуль входит в коллекцию community.aws (версия 10.1.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.34.0
- botocore >= 1.34.0
Параметры
Параметр | Комментарии |
|---|---|
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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore. |
aws_ca_bundle path | Путь к пакету сертификатов центра сертификации (CA), который используется для проверки SSL-сертификатов. Также можно использовать переменную среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
debug_botocore_endpoint_logs boolean | Использовать регистратор Также можно использовать переменную среды Варианты:
|
endpoint_url псевдонимы: aws_endpoint_url string | URL для подключения вместо конечных точек AWS по умолчанию. Хотя его можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную среды |
name string / обязательный | Имя кластера EKS. |
profile псевдонимы: aws_profile string | Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и session_token. |
region псевдонимы: aws_region string | Регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную среды Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. |
role_arn string | ARN роли IAM, используемой кластером EKS. |
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. Также можно использовать переменные среды Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore. |
security_groups list / elements=string | Список имен или идентификаторов групп безопасности. |
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. Также можно использовать переменную среды Параметры session_token и profile являются взаимоисключающими. |
state string | Требуемое состояние кластера EKS. Варианты:
|
subnets list / elements=string | Список идентификаторов подсетей для кластера Kubernetes. |
tags dictionary добавлено в community.aws 5.3.0 | Словарь тегов для добавления к кластеру EKS. |
validate_certs boolean | Если установлено значение Настоятельно не рекомендуется устанавливать validate_certs=false; вместо этого рассмотрите возможность задания параметра aws_ca_bundle. Варианты:
|
version string | Версия Kubernetes. По умолчанию используется |
wait boolean | Указывает, ожидает ли модуль перехода кластера в активное состояние или его удаления, прежде чем продолжить выполнение. Согласно документации AWS, это занимает «обычно менее 10 минут». Варианты:
|
wait_timeout integer | Время ожидания перехода кластера в активное состояние, в секундах. По умолчанию — 1200 секунд (20 минут). По умолчанию: |
Примечания
Примечание
- Внимание: Для модулей переменные среды и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
- Используемый Ansible AWS SDK (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 string | ARN кластера EKS Возвращается: если state имеет значение present Пример: |
certificate_authority complex | Словарь с данными центра сертификации для кластера Возвращается: после создания |
|
data string |
Данные центра сертификации для кластера в кодировке Base-64 Возвращается: когда кластер создан и активен |
created_at string | Дата и время создания кластера Возвращается: если state имеет значение present Пример: |
endpoint string | Конечная точка сервера API Kubernetes Возвращается: когда кластер создан и активен Пример: |
name string | Имя кластера EKS Возвращается: если state имеет значение present Пример: |
resources_vpc_config complex | Конфигурация VPC кластера Возвращается: если state имеет значение present |
|
security_group_ids list / elements=string |
Список идентификаторов групп безопасности Возвращается: всегда Пример: |
|
subnet_ids list / elements=string |
Список идентификаторов подсетей Возвращается: всегда Пример: |
|
vpc_id string |
Идентификатор VPC Возвращается: всегда Пример: |
role_arn string | ARN роли IAM, используемой кластером Возвращается: если state имеет значение present Пример: |
status string | Состояние кластера EKS Возвращается: если state имеет значение present Пример: |
version string | Версия Kubernetes кластера Возвращается: если state имеет значение present Пример: |
Ссылки на коллекцию
© 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_cluster_module.html