Spec-Zone.ru › Ansible 2.4

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, если таковое имеется.
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
(добавлено в 1.5)
нет да
  • да
  • нет
При установке в "нет", сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примеры

# 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
детали о задаче, которая была запущена
успешно сложный
содержит:
название описание возвращается тип пример
taskArn
Amazon Resource Name (ARN), идентифицирующий задачу.
всегда строка
overrides
Контейнерные параметры, установленные для этой задачи.
только при подробных данных список сложных
lastStatus
Последний зарегистрированный статус задачи.
только при подробных данных строка
containerInstanceArn
Amazon Resource Name (ARN) контейнера, выполняющего задачу.
только при подробных данных строка
containers
Подробности контейнера.
только при подробных данных список сложных
clusterArn
Amazon Resource Name (ARN) кластера, который содержит задачу.
только при подробных данных строка
desiredStatus
Желаемый статус задачи.
только при подробных данных строка
startedAt
Маркер времени запуска задачи.
только при подробных данных строка
stoppedReason
Причина остановки задачи.
только при подробных данных строка
taskDefinitionArn
Amazon Resource Name (ARN) определения задачи.
только при подробных данных строка
startedBy
Пользователь, который запустил задачу.
только при подробных данных строка
createdAt
Маркер времени создания задачи.
только при подробных данных строка
stoppedAt
Маркер времени остановки задачи.
только при подробных данных строка

Примечания

Примечание

  • Если параметры не заданы в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета 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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Справочная информация по сообществу и вклад, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API