Spec-Zone.ru › Ansible 2.11

community.aws.aws_eks_cluster – Управление кластерами Elastic Kubernetes Service

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.aws_eks_cluster.

Новое в версии 1.0.0: из community.aws

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

Описание

  • Управление кластерами Elastic Kubernetes Service

Требования

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

  • boto
  • boto3
  • botocore
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key
строка
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров aws_access_key и profile устарело и будет исключено после 2022-06-01.

псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла с сертификатом CA для проверки SSL-сертификатов.
Используется только для модулей, основанных на boto3.
Примечание: Файл CA Bundle читается со стороны модуля и может потребоваться его явное копирование с контроллера, если модуль не запускается локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти на https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для более подробной информации о конфигурации boto.
aws_secret_key
строка
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров aws_secret_key и profile устарело и будет исключено после 2022-06-01.

псевдонимы: ec2_secret_key, secret_key
debug_botocore_endpoint_logs
булево
    Варианты:
  • нет ←
  • да
Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", производимых во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.
ec2_url
строка
URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть.

псевдонимы: aws_endpoint_url, endpoint_url
name
строка / обязательно
Имя кластера EKS
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка их одновременного использования с profile устарела.
aws_access_key, aws_secret_key и security_token будут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
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.
Если задан параметр profile, этот параметр игнорируется.
Одновременное использование параметров security_token и profile устарело и будет исключено после 2022-06-01.

псевдонимы: aws_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_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
  • 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
  community.aws.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.aws_eks_cluster:
    name: my_cluster
    wait: yes
    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


Авторы

  • Will Thames (@willthames)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/aws_eks_cluster_module.html

Spec-Zone.ru

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