ecs_service_facts - список или описание служб в ecs
Новое в версии 2.1.
Обзор
- Отображает или описывает службы в ecs.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- botocore
- json
- 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 |
| cluster | Значение по умолчанию: default | ARN кластера, в котором нужно перечислить службы. |
| details |
| Установите значение true, если требуется подробная информация о службах. |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. |
| 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 | |
| security_token (добавлен в 1.6) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token |
| service | Служба, для которой требуется получить подробную информацию (обязательно, если details равно true). | |
| validate_certs (добавлен в 1.5) |
| При значении "no", сертификаты SSL не будут проверены для boto версий >= 2.6.0. |
Примечания
Примечание
- Подробная информация о параметрах и возвращаемых значениях см. на http://boto3.readthedocs.org/en/latest/reference/services/ecs.html
- Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета
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.
# Basic listing example
- ecs_service_facts:
cluster: test-cluster
service: console-test-service
details: true
# Basic listing example
- ecs_service_facts:
cluster: test-cluster
Возвращаемые значения
Общие возвращаемые значения описаны в разделе, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| services сложное | успех | При details = false возвращается массив ARN служб, в противном случае массив сложных объектов, как описано ниже. | ||
| status строка | всегда | Допустимые значения: ACTIVE, DRAINING или INACTIVE. | ||
| pendingCount целое число | всегда | Количество задач в кластере, находящихся в состоянии PENDING. | ||
| loadBalancers сложное | всегда | Список объектов балансировщиков нагрузки. | ||
| containerName строка | всегда | Имя контейнера, которое следует связать с балансировщиком нагрузки. | ||
| containerPort целое число | всегда | Порт в контейнере, который следует связать с балансировщиком нагрузки. | ||
| loadBalancerName строка | всегда | имя | ||
| desiredCount целое число | всегда | Желаемое количество экземпляров определения задачи, которые должны постоянно выполняться в службе. | ||
| runningCount целое число | всегда | Количество задач в кластере, находящихся в состоянии RUNNING. | ||
| serviceName строка | всегда | Сгенерированная пользователем строка, используемая для идентификации службы. | ||
| clusterArn строка | всегда | Amazon Resource Name (ARN) кластера, который предоставляет службу. | ||
| serviceArn строка | всегда | Amazon Resource Name (ARN), идентифицирующий службу. ARN содержит пространство имен arn:aws:ecs, за которым следует регион службы, идентификатор учетной записи AWS владельца службы, пространство имен службы и имя службы. Например, arn:aws:ecs:region :012345678910 :service/my-service. | ||
| deployments список сложных | всегда | список развертываний службы | ||
| events список сложных | всегда | список событий службы | ||
| taskDefinition строка | всегда | ARN определения задачи, которое нужно использовать для задач в службе. | ||
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Автор
- Mark Chance (@java1guy)
- Darek Kaczynski (@kaczynskid)
Подсказка
Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 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_service_facts_module.html