Spec-Zone.ru › Ansible 2.4

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
нет false
  • true
  • false
Установите в значение true, если требуется подробная информация о службах.
ec2_url
нет
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
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
нет
Служба для получения подробностей (требуется, если details равно true)
validate_certs
(добавлен в 1.5)
нет да
  • да
  • нет
Если установлено в "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примеры

# 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 служб, иначе массив сложных объектов, как описано ниже.
успех сложный
содержит:
имя описание возвращается тип пример
status
Допустимые значения: ACTIVE, DRAINING или INACTIVE.
всегда строка
pendingCount
Количество задач в кластере, находящихся в состоянии PENDING.
всегда целое число
loadBalancers
Список объектов балансировщиков нагрузки.
всегда сложный
desiredCount
Желаемое количество экземпляров определения задачи, которые нужно держать в работе в службе.
всегда целое число
runningCount
Количество задач в кластере, находящихся в состоянии RUNNING.
всегда целое число
serviceName
Строка, заданная пользователем, используемая для идентификации службы.
всегда строка
clusterArn
Amazon Resource Name (ARN) кластера, содержащего службу.
всегда строка
serviceArn
Amazon Resource Name (ARN), идентифицирующий службу. ARN содержит пространство имен arn:aws:ecs, за которым следует регион службы, идентификатор учетной записи AWS владельца службы, пространство имен службы и затем имя службы. Например, arn:aws:ecs:region:012345678910:service/my-service.
всегда строка
deployments
Список развертываний службы.
всегда список сложных
events
Список событий службы.
всегда список сложных
taskDefinition
ARN определения задачи, используемого для задач в службе.
всегда строка

Примечания

Примечание

  • Подробности параметров и возвращаемых значений см. в http://boto3.readthedocs.org/en/latest/reference/services/ecs.html
  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Статус

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

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ecs_service_facts_module.html

Spec-Zone.ru

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