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

Примечание

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

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

Для использования в плейбуке укажите: community.aws.ecs_service_facts.

Новое в версии 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. Для модулей boto используется только ключ 'user_agent'. Подробнее о настройках boto см. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#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 строка		ARN кластера, в котором необходимо получить список служб.
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 security token. Если не задан, используется значение переменной среды 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_facts_module.html