community.aws.ecs_task модуль — Запуск, начало или остановка задачи в ECS

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

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

Новинка в community.aws 1.0.0

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

Описание

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

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	Идентификатор ключа доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные окружения `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
aws_ca_bundle путь	Путь к файлу с набором CA-сертификатов для проверки SSL-сертификатов. Также может использоваться переменная окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для модификации конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cluster строка	Имя кластера, в котором запустить задачу. Если не указано, имя кластера будет `default`. Значение по умолчанию: `"default"`
container_instances список / элементы=строка	Список контейнерных экземпляров, на которых развернуть задачу.
count целое число	Количество новых экземпляров для запуска.
debug_botocore_endpoint_logs логический тип	Использовать `botocore.endpoint` логгер для анализа уникальных (а не суммарных) `"resource:action"` API-вызовов, сделанных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте `aws_resource_action` обратный вызов для вывода в общий список, созданный во время выполнения playbook. Также может использоваться переменная окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только с AWS. Также могут использоваться переменные окружения `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной окружения `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
launch_type строка	Тип запуска для выполнения службы. Варианты: `"EC2"` `"FARGATE"`
network_configuration словарь	Конфигурация сети службы. Применимо только для определений задач, созданных с network_mode=awsvpc.
assign_public_ip логический тип добавлено в community.aws 1.5.0	Получает ли эластичный сетевой интерфейс задачи публичный IP-адрес. Варианты: `false` `true`
security_groups список / элементы=строка	Список имен или идентификаторов групп для задачи.
subnets список / элементы=строка	Список идентификаторов подсетей, к которым прикреплена задача.
operation строка / обязательный	Операцию задачи для выполнения. При operation=run необходимо установить task_definition. При operation=start необходимо установить task_definition и container_instances. При operation=stop необходимо установить task_definition и task. Варианты: `"run"` `"start"` `"stop"`
overrides словарь	Словарь значений для передачи новым экземплярам.
profile псевдонимы: aws_profile строка	Используемый именованный профиль AWS для аутентификации. Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная окружения `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.

регион псевдонимы: aws_region, ec2_region строка	AWS регион для использования. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, регион игнорируется. Также могут быть использованы переменные среды `AWS_REGION` или `EC2_REGION`. Дополнительную информацию можно найти в документации Amazon AWS по ссылке http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key псевдонимы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа AWS. Дополнительную информацию об маркерах доступа можно найти в документации AWS по ссылке https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` также могут быть использованы в порядке убывания предпочтения. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для обеспечения согласованности с SDK AWS botocore. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token псевдонимы: aws_session_token, security_token, aws_security_token, access_token строка	AWS STS токен сессии для использования с временными учетными данными. Дополнительную информацию об маркерах доступа можно найти в документации AWS по ссылке https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Переменные среды `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` также могут быть использованы в порядке убывания предпочтения. Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
started_by строка	Значение, показывающее, кто или что запустил задачу (для информационных целей).
метки псевдонимы: resource_tags словарь	Метки, которые будут добавлены к задачам ecs при запуске.
задача строка	ARN задачи, которую нужно остановить.
определение_задачи строка	Определение задачи для запуска или остановки.
validate_certs булево	При установке в значение `false`, сертификаты SSL не будут проверяться для связи с API AWS. Установка validate_certs=false категорически не рекомендуется. В качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)
ждать булево добавлен в community.aws 4.1.0	Ожидать или нет достижения желаемого состояния. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост», а не из «контроллера». Поэтому файлы, возможно, необходимо явно скопировать на «хост». Для плагинов поиска и соединения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллера», а не из «хоста».
AWS SDK (boto3), который используется Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Более подробную информацию можно найти по ссылке https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# 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:123456789012: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:123456789012: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:123456789012: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: RUN a task on Fargate with public ip assigned
  community.aws.ecs_task:
    operation: run
    count: 2
    cluster: console-sample-app-static-cluster
    task_definition: console-sample-app-static-taskdef
    task: "arn:aws:ecs:us-west-2:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"
    started_by: ansible_user
    launch_type: FARGATE
    network_configuration:
      assign_public_ip: true
      subnets:
        - subnet-abcd1234
  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:123456789012:task/3f8353d1-29a8-4689-bbf6-ad79937ffe8a"

Значения возврата

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

Ключ	Описание
task сложный	детали задачи, которая была запущена Возвращается: успех
clusterArn строка	Идентификатор ресурса Amazon (ARN) кластера, в котором размещена задача. Возвращается: только при details = true
containerInstanceArn строка	Идентификатор ресурса Amazon (ARN) контейнера, выполняющего задачу. Возвращается: только при details = true
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 (ARN), идентифицирующий задачу. Возвращается: всегда
taskDefinitionArn строка	Идентификатор ресурса Amazon (ARN) определения задачи. Возвращается: только при details = true

Авторы

Mark Chance (@Java1Guy)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ecs_task_module.html