ecs_task - запуск, начало или остановка задачи в ecs
Новая версия 2.0.
Обзор
- Создаёт или удаляет экземпляры определений задач.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- boto
- boto3
- botocore
- json
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aws_access_key | Значение по умолчанию: None | Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. псевдонимы: ec2_access_key, access_key |
| aws_secret_key | Значение по умолчанию: None | Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. псевдонимы: ec2_secret_key, secret_key |
| cluster | Имя кластера, на котором нужно запустить задачу | |
| container_instances | Список контейнерных экземпляров, на которых необходимо развернуть задачу | |
| count | Количество новых экземпляров для запуска | |
| ec2_url | Значение по умолчанию: None | URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если она есть. |
| operation обязательно |
| Операция задачи, которую необходимо выполнить |
| overrides | Словарь значений, которые необходимо передать новым экземплярам | |
| profile (добавлено в 1.6) | Значение по умолчанию: None | Использует профиль 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) | Значение по умолчанию: None | Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. псевдонимы: access_token |
| started_by | Значение, показывающее, кто или что запустил задачу (для справочных целей) | |
| task | Задача для остановки | |
| task_definition | Определение задачи для запуска или выполнения | |
| validate_certs (добавлено в 1.5) |
| Если установлено значение «нет», сертификаты 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), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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
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 | детали задачи, которая была запущена | |
| taskArn строка | всегда | Amazon Resource Name (ARN), который идентифицирует задачу. | |
| overrides список сложных | только когда details true | Параметры контейнера, установленные для этой задачи. | |
| lastStatus строка | только когда details true | Последний зарегистрированный статус задачи. | |
| containerInstanceArn строка | только когда details true | Amazon Resource Name (ARN) контейнера, выполняющего задачу. | |
| containers список сложных | только когда details true | Подробности контейнера. | |
| clusterArn строка | только когда details true | Amazon Resource Name (ARN) кластера, который содержит задачу. | |
| desiredStatus строка | только когда details true | Желаемый статус задачи. | |
| startedAt строка | только когда details true | Отметка времени запуска задачи. | |
| stoppedReason строка | только когда details true | Причина остановки задачи. | |
| taskDefinitionArn строка | только когда details true | Amazon Resource Name (ARN) определения задачи. | |
| startedBy строка | только когда details true | Кто запустил задачу. | |
| createdAt строка | только когда details true | Отметка времени создания задачи. | |
| stoppedAt строка | только когда details true | Отметка времени остановки задачи. | |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- Марк Ченс(@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.5/modules/ecs_task_module.html