community.aws.ecs_task – Запуск, начало или остановка задачи в ecs

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Чтобы использовать его в книге задач, укажите: community.aws.ecs_task.

Новое в версии 1.0.0: от community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

boto
boto3
botocore
json
python >= 2.6

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aws_access_key строка			Ключ доступа AWS. Если не задано, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь			Расположение файла сертификата CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл сертификата CA считывается на стороне модуля и, возможно, потребует явного копирования с контроллера, если он не выполняется локально.
aws_config словарь			Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для дополнительной конфигурации boto.
aws_secret_key строка			Секретный ключ AWS. Если не задано, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
cluster строка			Имя кластера для запуска задачи.
container_instances список / элементы=строка			Список экземпляров контейнеров, на которых развернуть задачу.
count целое число			Количество новых экземпляров для запуска.
debug_botocore_endpoint_logs логический		Варианты: нет ← да	Использовать логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время выполнения задачи, выводя набор в ключ task_results. Используйте обратный вызов aws_resource_action для вывода общего списка, выполненного во время книги задач. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может использоваться.
ec2_url строка			URL для подключения к облаку EC2 или Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где регион обязателен. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она существует. псевдонимы: aws_endpoint_url, endpoint_url
launch_type строка		Варианты: EC2 FARGATE	Тип запуска, на котором запустить свою службу.
network_configuration словарь			Конфигурация сети службы. Применимо только для определений задач, созданных с network_mode=awsvpc.
	security_groups список / элементы=строка		Список имен или идентификаторов групп безопасности для задачи.
	subnets список / элементы=строка		Список идентификаторов подсетей, к которым подключена задача.
operation строка / обязательно		Варианты: run start stop	Операция для выполнения задачи.
overrides словарь			Словарь значений для передачи новым экземплярам.
profile строка			Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token. Поддержка их одновременной передачи с profile устарела. aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
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. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
started_by строка			Значение, показывающее, кто или что запустил задачу (для информационных целей).
tags словарь			Теги, которые будут добавлены к задачам ecs при запуске и выполнении
task строка			Задача для остановки.
task_definition строка			Определение задачи для запуска или выполнения.
validate_certs логический		Варианты: нет да ←	При значении «нет» SSL-сертификаты не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
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
  community.aws.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
  community.aws.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"
      tags:
        resourceName: a_task_for_ansible_to_run
        type: long_running_task
        network: internal
        version: 1.4
      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
  community.aws.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
  community.aws.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 равно true	Amazon Resource Name (ARN) кластера, в котором размещена задача.
	containerInstanceArn строка	только когда details равно true	Amazon Resource Name (ARN) контейнера, в котором выполняется задача.
	containers список / элементы=словарь	только когда details равно true	Подробности о контейнере.
	createdAt строка	только когда details равно true	Отметка времени создания задачи.
	desiredStatus строка	только когда details равно true	Желаемый статус задачи.
	lastStatus строка	только когда details равно true	Зафиксированный статус задачи.
	launchType строка	всегда	Тип запуска для выполнения задачи.
	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) определения задачи.

Авторы

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