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: of 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'. См. 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 строка		ARN кластера, в котором необходимо получить список служб.
debug_botocore_endpoint_logs булево	Варианты: нет ← да	Используйте логировщик botocore.endpoint для анализа уникальных (а не общих) API-вызовов "resource:action", выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время книги задач. Переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
details булево	Варианты: нет ← да	Установите значение в «истина», если требуется подробная информация о службах.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она существует. псевдонимы: aws_endpoint_url, endpoint_url
events булево	Варианты: нет да ←	Возвращать ли события ECS service. Действует только при 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 ложно, возвращает массив ARN служб, в противном случае массив сложных объектов, как описано ниже.
	clusterArn string		всегда	Amazon Resource Name (ARN) кластера, в котором размещена служба.
	deployments list / elements=dictionary		всегда	список развертываний служб
	desiredCount integer		всегда	Желаемое количество экземпляров определения задачи, которые необходимо поддерживать в активном состоянии в службе.
	events list / elements=dictionary		если events истинно	список событий службы
	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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/ecs_service_info_module.html