ecs_task - запуск, начало или остановка задачи в ecs

Новая версия с 2.0.

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Описание

Создаёт или удаляет экземпляры определений задач.

Требования

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

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		Имя кластера, на котором нужно запустить задачу
container_instances		Список контейнерных экземпляров, на которых нужно развернуть задачу
count		Количество новых экземпляров, которые нужно запустить
ec2_url		URL для подключения к EC2 или вашей облачной платформе Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной среды EC2_URL, если она задана.
network_configuration (добавлен в 2.6)		Настройка сети сервиса. Применимо только для определений задач, созданных с `awsvpc` network_mode. network_configuration имеет два ключа: subnets, список идентификаторов подсетей, к которым прикрепляется задача, и security_groups, список имён или идентификаторов групп безопасности для задачи
operation обязательно	Варианты: run start stop	Операция над задачей, которую нужно выполнить
overrides		Словарь значений, которые нужно передать новым экземплярам
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
started_by		Значение, показывающее, кто или что запустило задачу (для информационных целей)
task		Задача, которую нужно остановить
task_definition		Определение задачи для запуска или выполнения
validate_certs bool (добавлен в 1.5)	Варианты: нет да ←	При значении "нет", сертификаты 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), если учётные данные не предоставлены. См. http://boto.readthedocs.org/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION обычно используются для указания региона AWS, когда это необходимо, но это также можно настроить в конфигурационном файле boto

Примеры

# Simple example of run task
- name: Run task
  ecs_task:
    operation: run
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    count: 1
    started_by: ansible_user
  register: task_output

# Simple example of start task

- name: Start a task
  ecs_task:
      operation: start
      cluster: console-sample-app-static-cluster
      task_definition: console-sample-app-static-taskdef
      task: "arn:aws:ecs:us-west-2:172139249013:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
      container_instances:
      - arn:aws:ecs:us-west-2:172139249013:container-instance/79c23f22-876c-438a-bddf-55c98a3538a8
      started_by: ansible_user
      network_configuration:
        subnets:
        - subnet-abcd1234
        security_groups:
        - sg-aaaa1111
        - my_security_group
  register: task_output

- name: Stop a task
  ecs_task:
      operation: stop
      cluster: console-sample-app-static-cluster
      task_definition: console-sample-app-static-taskdef
      task: "arn:aws:ecs:us-west-2:172139249013:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"

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

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

Ключ		Возвращаемое значение	Описание
task сложное		успех	Подробности о запущенной задаче
	taskArn строка	всегда	Amazon Resource Name (ARN), идентифицирующий задачу.
	clusterArn строка	только если детали равны true	Amazon Resource Name (ARN) кластера, в котором размещена задача.
	taskDefinitionArn строка	только если детали равны true	Amazon Resource Name (ARN) определения задачи.
	containerInstanceArn строка	только если детали равны true	Amazon Resource Name (ARN) контейнера, выполняющего задачу.
	overrides список сложных	только если детали равны true	Контейнерные переопределения, установленные для этой задачи.
	lastStatus строка	только если детали равны true	Последний записанный статус задачи.
	desiredStatus строка	только если детали равны true	Желаемый статус задачи.
	containers список сложных	только если детали равны true	Подробности о контейнере.
	startedBy строка	только если детали равны true	Используемое имя того, кто запустил задачу.
	stoppedReason строка	только если детали равны true	Причина остановки задачи.
	createdAt строка	только если детали равны true	Отметка времени создания задачи.
	startedAt строка	только если детали равны true	Отметка времени запуска задачи.
	stoppedAt строка	только если детали равны true	Отметка времени остановки задачи.

Статус

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

Mark Chance(@Java1Guy)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

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