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 кластера, в котором необходимо получить список сервисов.
details boolean	Варианты: нет ← да	Установите в значение true, если требуется подробная информация о сервисах.
ec2_url -		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть.
events boolean добавлен в 2.6	Варианты: нет да ←	Указывает, необходимо ли возвращать события сервиса ECS. Действует только если `details` равно true.
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
security_token - добавлен в 1.6		AWS STS security token. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
service -		Один или несколько сервисов для получения подробной информации
validate_certs boolean добавлен в 1.5	Варианты: нет да ←	При значении "нет", сертификаты 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, возвращает массив ARNs сервисов, в противном случае массив сложных объектов, как описано ниже.
	clusterArn строка		всегда	Amazon Resource Name (ARN) кластера, который содержит сервис.
	deployments список сложных типов		всегда	список развертываний сервисов
	desiredCount целое число		всегда	Желаемое количество экземпляров определения задачи, которые необходимо поддерживать в активном состоянии в сервисе.
	events список сложных типов		при events равно true	список событий сервиса
	loadBalancers сложный тип		всегда	Список объектов балансировщиков нагрузки
		containerName строка	всегда	Имя контейнера, которое следует ассоциировать с балансировщиком нагрузки.
		containerPort целое число	всегда	Порт контейнера, который следует ассоциировать с балансировщиком нагрузки.
		loadBalancerName строка	всегда	имя
	pendingCount целое число		всегда	Количество задач в кластере, находящихся в состоянии PENDING.
	runningCount целое число		всегда	Количество задач в кластере, находящихся в состоянии RUNNING.
	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 определения задачи, которое следует использовать для задач в сервисе.

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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.7/modules/ecs_service_facts_module.html