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 -		Количество новых экземпляров для запуска
debug_botocore_endpoint_logs булево добавлен в 2.8	Варианты: нет ← да	Используйте регистратор botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», совершённых во время задачи, выводит множество в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в полный список, созданный во время исполнения playbook. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
launch_type - добавлен в 2.8	Варианты: EC2 FARGATE	Тип запуска, на котором нужно запустить вашу службу
network_configuration - добавлен в 2.6		Конфигурация сети службы. Применимо только для определений задач, созданных с `awsvpc` network_mode. network_configuration имеет два ключа, subnets, список идентификаторов подсетей, к которым подключена задача, и security_groups, список имён или идентификаторов групп безопасности для задачи
operation - / обязательно	Варианты: run start stop	Операция над задачей, которую необходимо выполнить
overrides -		Словарь значений, передаваемых новым экземплярам
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. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token
started_by -		Значение, показывающее, кто или что запустил задачу (для справочных целей)
task -		Задача для остановки
task_definition -		Определение задачи для запуска или выполнения
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

Примеры

# 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: RUN a task on Fargate
  ecs_task:
      operation: run
      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"
      started_by: ansible_user
      launch_type: FARGATE
      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 complex		success	подробности о задаче, которая была запущена
	clusterArn string	только когда details равно true	Идентификатор ресурса Amazon (ARN) кластера, в котором выполняется задача.
	containerInstanceArn string	только когда details равно true	Идентификатор ресурса Amazon (ARN) контейнера, в котором выполняется задача.
	containers список complex	только когда details равно true	Подробности контейнера.
	createdAt string	только когда details равно true	Отметка времени создания задачи.
	desiredStatus string	только когда details равно true	Желаемый статус задачи.
	lastStatus string	только когда details равно true	Записанный последний статус задачи.
	launchType string	всегда	Тип запуска, на котором нужно выполнить задачу.
	overrides список complex	только когда details равно true	Параметры переопределения контейнера для этой задачи.
	startedAt string	только когда details равно true	Отметка времени запуска задачи.
	startedBy string	только когда details равно true	Пользователь, запустивший задачу.
	stoppedAt string	только когда details равно true	Отметка времени остановки задачи.
	stoppedReason string	только когда details равно true	Причина остановки задачи.
	taskArn string	всегда	Идентификатор ресурса Amazon (ARN), определяющий задачу.
	taskDefinitionArn string	только когда details равно true	Идентификатор ресурса Amazon (ARN) определения задачи.

Статус

Этот модуль не гарантирует обратную совместимость. [предварительный просмотр]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/ecs_task_module.html