Spec-Zone.ru › Ansible 2.9

ecs_service_info – список или описание служб в ecs

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

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

Псевдонимы: ecs_service_facts

Требования

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

  • 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 кластера, в котором необходимо перечислить службы.
debug_botocore_endpoint_logs
булево
добавлено в 2.8
    Варианты:
  • нет ←
  • да
Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время выполнения игры.
details
булево
    Варианты:
  • нет ←
  • да
Установите в значение true, если требуется подробная информация о службах.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
events
булево
добавлено в 2.6
    Варианты:
  • нет
  • да ←
Возвращать ли события ECS-службы. Действует только если details имеет значение true.
profile
строка
Использует профиль 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
строка
AWS STS security token. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
service
-
Одна или несколько служб, для которых нужно получить подробную информацию
validate_certs
булево
    Варианты:
  • нет
  • да ←
При значении "нет" сертификаты 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_info:
    cluster: test-cluster
    service: console-test-service
    details: true
  register: output

# Basic listing example
- ecs_service_info:
    cluster: test-cluster
  register: output

Значения возврата

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

Ключ Возвращаемое значение Описание
services
сложный
success
Если details ложно, возвращает массив 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. [community]

Авторы

  • 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.9/modules/ecs_service_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API