community.aws.ecs_service_info – Список или описание служб в ECS

Примечание

Этот плагин входит в состав коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в книге задач укажите: community.aws.ecs_service_info.

Добавлена в версии 1.0.0: из community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Отображает или описывает службы в ECS.
Этот модуль назывался ecs_service_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль community.aws.ecs_service_info больше не возвращает ansible_facts!

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

boto
boto3
botocore
json
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aws_access_key строка		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение пакета сертификатов CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: пакет CA читается со стороны модуля и может потребоваться явно скопировать его с контроллера, если он не используется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти на https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Только ключ 'user_agent' используется для модулей boto. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key строка		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
cluster строка		Указатель ARNS кластера, в котором нужно перечислить службы.
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Используйте логгер botocore.endpoint для анализа уникальных (а не общих) вызовов API «ресурс:действие» во время задачи, выводив набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время книги задач. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
details логический тип	Варианты: нет ← да	Установите это значение в true, если вы хотите получить подробную информацию о службах.
ec2_url строка		URL для подключения к EC2 или вашей облачной системе Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где необходим регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
events логический тип	Варианты: нет да ←	Нужно ли возвращать события службы ECS. Действует только если details=true.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределит aws_access_key, aws_secret_key и security_token, и поддержка их одновременной передачи с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
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. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
service список / элементы=строка		Одна или несколько служб, для которых нужно получить подробности.
validate_certs логический тип	Варианты: нет да ←	Если установлено в «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
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
- community.aws.ecs_service_info:
    cluster: test-cluster
    service: console-test-service
    details: true
  register: output

# Basic listing example
- community.aws.ecs_service_info:
    cluster: test-cluster
  register: output

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ			Возвращаемое значение	Описание
services complex			success	Если details ложно, возвращает массив ARNs сервисов, иначе массив сложных объектов, как описано ниже.
	clusterArn string		всегда	Amazon Resource Name (ARN) кластера, в котором размещён сервис.
	deployments list / elements=dictionary		всегда	Список развертываний сервиса
	desiredCount integer		всегда	Желаемое число экземпляров определения задачи, которые должны выполняться в сервисе.
	events list / elements=dictionary		если events равно true	Список событий сервиса
	loadBalancers complex		всегда	Список объектов балансировщиков нагрузки
		containerName string	всегда	Имя контейнера, который нужно связать с балансировщиком нагрузки.
		containerPort integer	всегда	Порт в контейнере, который нужно связать с балансировщиком нагрузки.
		loadBalancerName string	всегда	Имя
	pendingCount integer		всегда	Количество задач в кластере, находящихся в состоянии ОЖИДАНИЯ.
	runningCount integer		всегда	Количество задач в кластере, находящихся в состоянии ВЫПОЛНЕНИЯ.
	serviceArn string		всегда	Amazon Resource Name (ARN), определяющий сервис. ARN содержит пространство имён arn:aws:ecs, за которым следуют регион сервиса, идентификатор учётной записи AWS владельца сервиса, пространство имён сервиса и имя сервиса. Например, arn:aws:ecs:region:012345678910:service/my-service.
	serviceName string		всегда	Сгенерированная пользователем строка, используемая для идентификации сервиса
	status string		всегда	Допустимые значения: ACTIVE, DRAINING или INACTIVE.
	taskDefinition string		всегда	ARN определения задачи, которое следует использовать для задач в сервисе.

Авторы

Марк Ченс (@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.10/collections/community/aws/ecs_service_info_module.html