ecs_cluster - создание или завершение работы кластеров ecs
Новое в версии 2.0.
Обзор
- Создает или завершает работу кластеров ecs.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key |
| delay | Количество секунд ожидания | |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковое есть. |
| name обязательно | Имя кластера | |
| profile (добавлено в 1.6) | Значение по умолчанию: None | Использует профиль 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) | Значение по умолчанию: None | AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token |
| state обязательно |
| Желаемое состояние кластера |
| validate_certs (добавлено в 1.5) |
| При значении "no", сертификаты SSL для boto версии >= 2.6.0 не будут проверены. |
Примечания
Примечание
- При удалении кластера возвращаемая информация — состояние кластера до удаления.
- Модуль также будет ожидать регистрации экземпляров в кластере.
- Если параметры не заданы в модуле, могут быть использованы следующие переменные среды в порядке убывания приоритета
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
Примеры
# 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 int | 0, если создается новый кластер | Количество активных сервисов в кластере |
| clusterArn строка | 0, если создается новый кластер | ARN созданного кластера Пример: arn:aws:ecs:us-west-2:172139249013:cluster/test-cluster-mfshcdok |
| clusterName строка | всегда | Имя созданного кластера (должно совпадать с входным аргументом) Пример: test-cluster-mfshcdok |
| pendingTasksCount int | 0, если создается новый кластер | Количество задач, ожидающих выполнения в этом кластере |
| registeredContainerInstancesCount int | 0, если создается новый кластер | Количество контейнерных экземпляров, доступных в этом кластере |
| runningTasksCount int | 0, если создается новый кластер | Количество выполняемых задач в этом кластере |
| status строка | всегда | Статус нового кластера Пример: ACTIVE |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимый.
Автор
- Mark Chance(@Java1Guy)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его для улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ecs_cluster_module.html