Модуль community.aws.ecs_cluster — Создание или завершение работы кластеров ECS.

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.aws.ecs_cluster.

Новая функция в community.aws 1.0.0

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

Описание

Создаёт или завершает работу кластеров ECS.

Требования

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

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

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	ID ключа доступа AWS. См. документацию AWS для получения дополнительной информации об маркерах доступа 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 для проверки SSL-сертификатов. Также можно использовать переменную среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
capacity_provider_strategy список / элементы=словарь добавлено в community.aws 5.2.0	Список стратегий поставщиков емкости для использования в кластере.
base целое число	Минимальное количество задач, которые должны использовать указанного поставщика. По умолчанию: `0`
capacity_provider строка	Название поставщика емкости.
weight целое число	Относительный процент от общего числа запущенных задач, которые должны использовать указанного поставщика.
capacity_providers список / элементы=строка добавлено в community.aws 5.2.0	Список поставщиков емкости для использования в кластере.
debug_botocore_endpoint_logs булево	Использование логгера `botocore.endpoint` для анализа уникальных (а не общих) `"resource:action"` API-вызовов, осуществленных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов `aws_resource_action` для вывода общего списка, выполненного во время выполнения плейбука. Также можно использовать переменную среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
delay целое число	Количество секунд ожидания. По умолчанию: `10`
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 строка / обязательно	Название кластера.
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.
purge_capacity_providers булево добавлено в community.aws 5.2.0	Переключатель для перезаписи существующих поставщиков емкости или стратегий. Это необходимо для обратной совместимости. По умолчанию purge_capacity_providers=false. В релизе 9.0.0 это значение по умолчанию будет изменено на purge_capacity_providers=true. Варианты: `false` ← (по умолчанию) `true`

END_OF_DOCUMENT_MARKER

регион псевдонимы: aws_region, ec2_region строка	AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр регион игнорируется. Также можно использовать переменные среды `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.
повторить целое число	Количество попыток ожидания, пока кластер не получит экземпляр. По умолчанию: `10`
секретный_ключ псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа к AWS. Дополнительную информацию об маркерах доступа см. в документации AWS по 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.
токен_сессии псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка	Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию об маркерах доступа см. в документации 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.
состояние строка / обязательно	Желаемое состояние кластера. Варианты: `"present"` `"absent"` `"has_instances"`
validate_certs булево	При установке в `false`, сертификаты SSL для связи с AWS API не будут проверены. Сильно не рекомендуется устанавливать validate_certs=false. В качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

При удалении кластера возвращаемая информация соответствует состоянию кластера до удаления.
Также будет ожидание, пока кластер зарегистрирует в себе экземпляры.
Внимание: Для модулей переменные среды и файлы конфигурации читаются из контекста хоста Ansible, а не контекста контроллера. Вследствие этого файлы могут потребоваться явно скопировать в хост. Для плагинов поиска и подключения переменные среды и файлы конфигурации считываются из контекста контроллера Ansible, а не из контекста хоста.
AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих файлов конфигурации в контексте хоста 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: Cluster creation
  community.aws.ecs_cluster:
    name: default
    state: present

- name: Cluster creation with capacity providers and strategies.
  community.aws.ecs_cluster:
    name: default
    state: present
    capacity_providers:
      - FARGATE
      - FARGATE_SPOT
    capacity_provider_strategy:
      - capacity_provider: FARGATE
        base: 1
        weight: 1
      - capacity_provider: FARGATE_SPOT
        weight: 100
    purge_capacity_providers: true

- name: Cluster deletion
  community.aws.ecs_cluster:
    name: default
    state: absent

- name: Wait for register
  community.aws.ecs_cluster:
    name: "{{ new_cluster }}"
    state: has_instances
    delay: 10
    repeat: 10
  register: task_output

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

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

Ключ	Описание
activeServicesCount целое число	сколько сервисов активны в этом кластере Возвращается: 0, если новый кластер
capacityProviders список / элементы=строка добавлен в community.aws 5.2.0	список используемых поставщиков емкости в этом кластере Возвращается: всегда
clusterArn строка	ARN кластера, только что созданного Возвращается: 0, если новый кластер Пример: `"arn:aws:ecs:us-west-2:123456789012:cluster/test-cluster"`
clusterName строка	имя кластера, только что созданного (должно совпадать со входным аргументом) Возвращается: всегда Пример: `"test-cluster"`
defaultCapacityProviderStrategy список / элементы=строка добавлен в community.aws 5.2.0	список стратегий поставщиков емкости, используемых в этом кластере Возвращается: всегда
pendingTasksCount целое число	сколько задач ожидают выполнения в этом кластере Возвращается: 0, если новый кластер
registeredContainerInstancesCount целое число	сколько контейнерных экземпляров доступно в этом кластере Возвращается: 0, если новый кластер
runningTasksCount целое число	сколько задач выполняются в этом кластере Возвращается: 0, если новый кластер
status строка	статус нового кластера Возвращается: всегда Пример: `"ACTIVE"`

Авторы

Mark Chance (@Java1Guy)

Ссылки на сборки

© 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/ecs_cluster_module.html