aws_eks_cluster – Управление кластерами Elastic Kubernetes Service
Новое в версии 2.7.
Обзор
- Управление кластерами Elastic Kubernetes Service
Требования
Ниже приведены требования к хосту, на котором будет выполняться данный модуль.
- boto
- boto3
- botocore
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key строка | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Псевдонимы: ec2_access_key, access_key | |
| aws_secret_key строка | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Псевдонимы: ec2_secret_key, secret_key | |
| debug_botocore_endpoint_logs логический добавлено в 2.8 |
| Используйте logger botocore.endpoint для разбора уникальных (а не общих) API-вызовов «ресурс:действие», выполненных во время задачи, выведя набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action для вывода в полный список, созданный во время выполнения playbook. Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| ec2_url строка | URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она есть. | |
| name - / обязательно | Имя кластера EKS | |
| profile строка | Использует профиль boto. Работает только с boto >= 2.24.0. | |
| region строка | AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
Псевдонимы: aws_region, ec2_region | |
| role_arn - | ARN роли IAM, используемой кластером EKS | |
| security_groups - | Список имён или идентификаторов групп безопасности | |
| security_token строка | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| state - |
| Желаемое состояние кластера EKS |
| subnets - | Список идентификаторов подсетей для кластера Kubernetes | |
| validate_certs логический |
| Если установлено «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0. |
| version - | Версия Kubernetes — по умолчанию последняя | |
| wait логический |
| Указывает, ожидает ли модуль, пока кластер не станет активным после создания. По документации AWS занимает «обычно менее 10 минут». |
| wait_timeout - | По умолчанию: 1200 | Время ожидания активации кластера в секундах. По умолчанию 1200 секунд (20 минут). |
Примечания
Примечание
- Если параметры не установлены в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
AWS_URLилиEC2_URL,AWS_ACCESS_KEY_IDилиAWS_ACCESS_KEYилиEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYилиAWS_SECRET_KEYилиEC2_SECRET_KEY,AWS_SECURITY_TOKENилиEC2_SECURITY_TOKEN,AWS_REGIONилиEC2_REGION - Ansible использует конфигурационный файл boto (обычно ~/.boto), если данные для авторизации не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONможно использовать для указания AWS региона, когда это требуется, но это также можно настроить в конфигурационном файле boto
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create an EKS cluster
aws_eks_cluster:
name: my_cluster
version: v1.10.0
role_arn: my_eks_role
subnets:
- subnet-aaaa1111
security_groups:
- my_eks_sg
- sg-abcd1234
register: caller_facts
- name: Remove an EKS cluster
aws_eks_cluster:
name: my_cluster
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| arn строка | при наличии состояния | ARN кластера EKS Пример: arn:aws:eks:us-west-2:111111111111: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::111111111111:role/aws_eks_cluster_role | |
| status строка | при наличии состояния | Статус кластера EKS Пример: ['CREATING', 'ACTIVE'] | |
| version строка | при наличии состояния | Версия Kubernetes кластера Пример: 1.10 | |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Will Thames (@willthames)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aws_eks_cluster_module.html