ecs_service_facts – список или описание служб в ecs
Новая в версии 2.1.
Обзор
- Отображает или описывает службы в ecs.
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- boto
- boto3
- botocore
- json
- 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 | |
| cluster - | Значение по умолчанию: "default" | ARN кластера, в котором необходимо отобразить службы. |
| debug_botocore_endpoint_logs логический тип добавлен в 2.8 |
| Используйте логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время выполнения пьесы. Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS. |
| details логический тип |
| Установите в значение true, если требуется подробная информация о службах. |
| ec2_url строка | URL для подключения к EC2 или вашей облачной платформе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной среды EC2_URL, если таковая имеется. | |
| events логический тип добавлен в 2.6 |
| Возвращать события ECS службы. Действует только если details равно true. |
| profile строка | Использует профиль 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 строка | Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token | |
| service - | Одна или несколько служб, для которых нужно получить подробности | |
| validate_certs логический тип |
| Если установлено в "нет", сертификаты 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), если учетные данные не предоставлены. См. 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.
# 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 служб, в противном случае массив сложных объектов, как описано ниже. | ||
| clusterArn строка | всегда | Amazon Resource Name (ARN) кластера, который содержит службу. | ||
| deployments список сложных | всегда | список развертываний службы | ||
| desiredCount целое число | всегда | Желаемое количество экземпляров определения задачи, которые должны постоянно выполняться в службе. | ||
| events список сложных | если events равно true | список событий службы | ||
| loadBalancers сложное | всегда | Список объектов балансировщика нагрузки | ||
| containerName строка | всегда | Имя контейнера, которое нужно ассоциировать с балансировщиком нагрузки. | ||
| containerPort целое число | всегда | Порт в контейнере, который нужно ассоциировать с балансировщиком нагрузки. | ||
| loadBalancerName строка | всегда | имя | ||
| pendingCount целое число | всегда | Количество задач в кластере, находящихся в состоянии ОЖИДАНИЯ. | ||
| runningCount целое число | всегда | Количество задач в кластере, находящихся в состоянии ВЫПОЛНЕНИЯ. | ||
| serviceArn строка | всегда | Amazon Resource Name (ARN), идентифицирующий службу. ARN содержит пространство имен arn:aws:ecs, за которым следует регион службы, идентификатор учетной записи AWS владельца службы, пространство имен службы и затем имя службы. Например, arn:aws:ecs:region:012345678910:service/my-service. | ||
| serviceName строка | всегда | Строка, сгенерированная пользователем, используемая для идентификации службы | ||
| status строка | всегда | Допустимые значения: ACTIVE, DRAINING или INACTIVE. | ||
| taskDefinition строка | всегда | ARN определения задачи, которое будет использоваться для задач в службе. | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Марк Ченс (@java1guy)
- Дарек Качинский (@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.8/modules/ecs_service_facts_module.html