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
ec2_url -		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
name - / обязательно		Имя кластера EKS
profile - добавлено в 1.6		Использует профиль 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 -		Список имен или ID групп безопасности
security_token - добавлено в 1.6		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state -	Варианты: absent present ←	желаемое состояние кластера EKS
subnets -		Список ID подсетей для кластера Kubernetes
validate_certs boolean добавлено в 1.5	Варианты: no yes ←	При значении "no", сертификаты SSL не будут проверены для версий boto >= 2.6.0.
version -		Версия Kubernetes - по умолчанию последняя
wait boolean	Варианты: no ← yes	Указывает, ожидает ли модуль, пока кластер не станет активным после создания. По документации 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.7/modules/aws_eks_cluster_module.html