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 bool	Варианты: нет да По умолчанию: "false"	Установите в значение true, если требуется подробная информация о службах.
ec2_url		URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
events bool (добавлено в 2.6)	Варианты: нет да По умолчанию: "true"	Возвращать ли события 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. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
service		Одна или несколько служб, для которых нужно получить подробности
validate_certs bool (добавлено в 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), если данные учетных данных не предоставлены. См. 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 служб, в противном случае массив сложных объектов, как описано ниже.
	clusterArn строка		всегда	Amazon Resource Name (ARN) кластера, который содержит службу.
	desiredCount целое число		всегда	Желаемое количество экземпляров определения задачи, которые должны выполняться в службе.
	loadBalancers сложное		всегда	Список объектов балансировщиков нагрузки
		loadBalancerName строка	всегда	имя
		containerName строка	всегда	Имя контейнера, который нужно связать с балансировщиком нагрузки.
		containerPort целое число	всегда	Порт в контейнере, который нужно связать с балансировщиком нагрузки.
	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 определения задачи, которое используется для задач в службе.
	deployments список сложных		всегда	список развертываний службы
	events список сложных		если events равно true	список событий службы

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, также поддерживаемых сообществом 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.6/modules/ecs_service_facts_module.html