ecs_cluster - создание или завершение кластеров ecs
Новое в версии 2.0.
- Обзор
- Требования (для хоста, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Создает или завершает кластеры ecs.
Требования (для хоста, на котором выполняется модуль)
- boto
- boto3
- 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 | ||
| delay | нет | Количество секунд ожидания | ||
| ec2_url | нет | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она задана. | ||
| name | да | Название кластера | ||
| 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 | ||
| repeat | нет | Количество повторений ожидания наличия экземпляров в кластере | ||
| security_token (добавлен в 1.6)
| нет | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token | ||
| state | да |
| Желаемое состояние кластера | |
| validate_certs (добавлен в 1.5)
| нет | да |
| При значении "нет", сертификаты SSL для boto версий >= 2.6.0 не будут проверены. |
Примеры
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Cluster creation
- ecs_cluster:
name: default
state: present
# Cluster deletion
- ecs_cluster:
name: default
state: absent
- name: Wait for register
ecs_cluster:
name: "{{ new_cluster }}"
state: has_instances
delay: 10
repeat: 10
register: task_output
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращаемое значение | тип | пример |
|---|---|---|---|---|
| activeServicesCount | количество активных сервисов в этом кластере | 0, если новый кластер | int | |
| clusterArn | ARN кластера, только что созданного | 0, если новый кластер | строка | arn:aws:ecs:us-west-2:172139249013:cluster/test-cluster-mfshcdok |
| clusterName | имя кластера, только что созданного (должно совпадать с входным аргументом) | всегда | строка | test-cluster-mfshcdok |
| pendingTasksCount | количество задач, ожидающих выполнения в этом кластере | 0, если новый кластер | int | |
| registeredContainerInstancesCount | количество доступных контейнерных экземпляров в этом кластере | 0, если новый кластер | int | |
| runningTasksCount | количество выполняющихся задач в этом кластере | 0, если новый кластер | int | |
| status | статус нового кластера | всегда | строка | ACTIVE |
Примечания
Примечание
- При удалении кластера возвращаемая информация соответствует состоянию кластера до удаления.
- Модуль также будет ждать регистрации экземпляров в кластере.
- Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета
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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
-
AWS_REGIONилиEC2_REGIONобычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей ознакомьтесь с Информацией о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ecs_cluster_module.html