ecs_service - создание, завершение, запуск или остановка службы в 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
client_token	нет			Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Разрешается до 32 ASCII символов.
cluster	нет			Имя кластера, в котором существует служба
delay	нет	10		Время ожидания перед проверкой доступности службы
deployment_configuration (добавлен в 2.3)	нет			Необязательные параметры, которые управляют deployment_configuration; формат — '{"maximum_percent":<целое число>, "minimum_healthy_percent":<целое число>}'
desired_count	нет			Количество экземпляров службы. Этот параметр требуется, когда state=present
ec2_url	нет			URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется.
load_balancers	нет			Список ELB, определенных для данной службы
name	да			Имя службы
placement_constraints (добавлен в 2.4)	нет			Ограничения размещения задач в службе
placement_strategy (добавлен в 2.4)	нет			Объекты стратегии размещения для задач в вашей службе. Вы можете указать не более 5 правил стратегии на службу
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
repeat	нет	10		Количество попыток проверки доступности службы
role	нет			Имя или полный Amazon Resource Name (ARN) роли IAM, которая позволяет вашему агенту Amazon ECS делать вызовы к вашему балансировщику нагрузки от вашего имени. Этот параметр необходим только в том случае, если вы используете балансировщик нагрузки со своей службой.
security_token (добавлен в 1.6)	нет			Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
state	да		present absent deleting	Желаемое состояние службы
task_definition	нет			Определение задачи, которое будет выполняться службой. Этот параметр требуется, когда state=present
validate_certs (добавлен в 1.5)	нет	да	да нет	Если установлено «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.
- ecs_service:
    state: present
    name: console-test-service
    cluster: new_cluster
    task_definition: 'new_cluster-task:1'
    desired_count: 0

# Basic provisioning example
- ecs_service:
    name: default
    state: present
    cluster: new_cluster

# Simple example to delete
- ecs_service:
    name: default
    state: absent
    cluster: new_cluster

# With custom deployment configuration (added in version 2.3), placement constraints and strategy (added in version 2.4)
- ecs_service:
    state: present
    name: test-service
    cluster: test-cluster
    task_definition: test-task-definition
    desired_count: 3
    deployment_configuration:
      minimum_healthy_percent: 75
      maximum_percent: 150
    placement_constraints:
      - type: memberOf
        expression: 'attribute:flavor==test'
    placement_strategy:
      - type: binpack
        field: memory

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

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

название

описание

возвращается

тип

пример

ansible_facts

Информация о удаленной службе.

при удалении службы

сложный

содержит:

название	описание	возвращается	тип	пример
service	Подробности удаленной службы в той же структуре, что и при создании службы.	если служба существовала и была удалена	сложный

service

Подробности созданной службы.

при создании службы

сложный

содержит:

название	описание	возвращается	тип
status	Допустимые значения: ACTIVE, DRAINING или INACTIVE.	всегда	строка
pendingCount	Количество задач в кластере, находящихся в состоянии PENDING.	всегда	целое
loadBalancers	Список объектов балансировщиков нагрузки	всегда	сложный
placementConstraints	Список объектов ограничений размещения	всегда	список сложных
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.	всегда	строка
deploymentConfiguration	словарь deploymentConfiguration	всегда	сложный
deployments	список развертываний службы	всегда	список сложных
events	список событий службы	всегда	список сложных
taskDefinition	ARN определения задачи для использования в задачах службы.	всегда	строка
placementStrategy	Список объектов стратегии размещения	всегда	список сложных

Примечания

Примечание

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