ecs_task – запуск, начало или остановка задачи в 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 -		Имя кластера для запуска задачи.
container_instances -		Список контейнерных экземпляров для развертывания задачи.
count -		Количество новых экземпляров для запуска.
debug_botocore_endpoint_logs логический тип добавлено в 2.8	Варианты: нет ← да	Использование логгера botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие» во время выполнения задачи, выводит набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, созданного во время выполнения сценария.
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 сложный		успешно	подробности о задаче, которая была запущена
	clusterArn строка	только если details истинно	Amazon Resource Name (ARN) кластера, в котором выполняется задача.
	containerInstanceArn строка	только если details истинно	Amazon Resource Name (ARN) контейнера, в котором выполняется задача.
	containers список сложных	только если details истинно	Подробности контейнера.
	createdAt строка	только если details истинно	Маркер времени создания задачи.
	desiredStatus строка	только если details истинно	Желаемый статус задачи.
	lastStatus строка	только если details истинно	Зафиксированный статус задачи.
	launchType строка	всегда	Тип запуска для выполнения задачи.
	overrides список сложных	только если details истинно	Настройки переопределения контейнера для этой задачи.
	startedAt строка	только если details истинно	Маркер времени запуска задачи.
	startedBy строка	только если details истинно	Пользователь, запустивший задачу.
	stoppedAt строка	только если details истинно	Маркер времени остановки задачи.
	stoppedReason строка	только если details истинно	Причина остановки задачи.
	taskArn строка	всегда	Amazon Resource Name (ARN), определяющий задачу.
	taskDefinitionArn строка	только если details истинно	Amazon Resource Name (ARN) определения задачи.

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом 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.9/modules/ecs_task_module.html