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 boolean добавлено в 1.5	Варианты: no yes ←	При значении "no" сертификаты 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: 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 сложное		success	детали о запущенной задаче
	clusterArn строка	только при details=true	Amazon Resource Name (ARN) кластера, на котором размещена задача.
	containerInstanceArn строка	только при details=true	Amazon Resource Name (ARN) контейнера, в котором выполняется задача.
	containers список сложных	только при details=true	Детали контейнеров.
	createdAt строка	только при details=true	Отметка времени создания задачи.
	desiredStatus строка	только при details=true	Желаемый статус задачи.
	lastStatus строка	только при details=true	Последний зарегистрированный статус задачи.
	overrides список сложных	только при details=true	Настройки переопределения для контейнеров этой задачи.
	startedAt строка	только при details=true	Отметка времени запуска задачи.
	startedBy строка	только при details=true	Идентификатор пользователя, который запустил задачу.
	stoppedAt строка	только при details=true	Отметка времени остановки задачи.
	stoppedReason строка	только при details=true	Причина остановки задачи.
	taskArn строка	всегда	Amazon Resource Name (ARN), идентифицирующий задачу.
	taskDefinitionArn строка	только при details=true	Amazon Resource Name (ARN) определения задачи.

Статус

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

Авторы

Марк Ченс (@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.7/modules/ecs_task_module.html