aws_batch_job_definition - Управление определениями задач AWS Batch

Новая версия с 2.5.

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

Описание

Этот модуль позволяет управлять определениями задач AWS Batch. Он идемпотентен и поддерживает режим «Проверка». Используйте модуль batch_compute_environment для управления средой выполнения, batch_job_queue для управления очередями задач, batch_job_definition для управления определениями задач.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
attempts			Стратегия повторных попыток — количество раз, чтобы перевести задачу в состояние RUNNABLE. Вы можете указать от 1 до 10 попыток. Если attempts больше единицы, задача повторяется при ошибке, пока не перейдет в состояние RUNNABLE указанное количество раз.
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
command			Команда, передаваемая контейнеру. Этот параметр соответствует Cmd в разделе «Создание контейнера» в Docker Remote API и параметру COMMAND в docker run. Дополнительную информацию см. на странице https://docs.docker.com/engine/reference/builder/#cmd.
ec2_url		Значение по умолчанию: None	URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если не используется регион. Если не задан, используется значение переменной окружения EC2_URL, если она есть.
environment			Переменные окружения, передаваемые контейнеру. Этот параметр соответствует Env в разделе «Создание контейнера» в Docker Remote API и параметру --env в docker run. Список словарей.
	name		Имя пары ключ-значение. Для переменных окружения — имя переменной окружения.
	value		Значение пары ключ-значение. Для переменных окружения — значение переменной окружения.
image			Имедж, используемый для запуска контейнера. Эта строка передается непосредственно в Docker-демон. Образы из Docker Hub-реестра доступны по умолчанию. Другие репозитории указываются с помощью `` repository-url /image <colon>tag ``. Разрешено до 255 символов (строчные и прописные буквы, цифры, дефисы, подчеркивания, двоеточия, точки, косые черты и диезы). Этот параметр соответствует Image в разделе «Создание контейнера» в Docker Remote API и параметру IMAGE в docker run.
job_definition_arn			ARN для определения задачи.
job_definition_name обязательно			Имя для определения задачи.
job_role_arn			Amazon Resource Name (ARN) роли IAM, которую контейнер может принять для AWS-разрешений.
memory			Жесткое ограничение (в МБ) памяти, предоставляемой контейнеру. Если контейнер пытается превысить указанный объем памяти, он убивается. Этот параметр соответствует Memory в разделе «Создание контейнера» в Docker Remote API и параметру --memory в docker run.
mount_points			Точки монтирования томов данных в контейнере. Этот параметр соответствует Volumes в разделе «Создание контейнера» в Docker Remote API и параметру --volume в docker run. Список словарей.
	sourceVolume		Имя тома для монтирования.
	readOnly		Если это значение true, контейнер имеет только чтение для тома; в противном случае контейнер может записывать в том. Значение по умолчанию — false.
	containerPath		Путь в контейнере, на который монтируется том хоста.
parameters			Значения параметров по умолчанию для подстановки в определении задачи. Параметры указываются как пары ключ-значение. Параметры в запросе SubmitJob переопределяют любые соответствующие параметры по умолчанию из определения задачи.
privileged			Если этот параметр равен true, контейнеру предоставляются повышенные привилегии на экземпляре хост-контейнера (аналогично пользователю root). Этот параметр соответствует Privileged в разделе «Создание контейнера» в Docker Remote API и параметру --privileged в docker run.
profile (добавлен в 1.6)		Значение по умолчанию: None	Использует профиль boto. Работает только с boto >= 2.24.0.
readonly_root_filesystem			Если этот параметр равен true, контейнеру предоставляется доступ только для чтения к его файловой системе корня. Этот параметр соответствует ReadonlyRootfs в разделе «Создание контейнера» в Docker Remote API и параметру --read-only в docker run.
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
state обязательно		Варианты: present ← absent	Описывает желаемое состояние.
type обязательно			Тип определения задачи.
ulimits			Список ulimits, которые нужно установить в контейнере. Этот параметр соответствует Ulimits в разделе «Создание контейнера» в Docker Remote API и параметру --ulimit в docker run. Список словарей.
	softLimit		Мягкое ограничение для типа ulimit.
	hardLimit		Жесткое ограничение для типа ulimit.
	name		Тип ulimit.
user			Имя пользователя для использования внутри контейнера. Этот параметр соответствует User в разделе «Создание контейнера» в Docker Remote API и параметру --user в docker run.
validate_certs (добавлен в 1.5)		Варианты: no yes ←	При значении «no» сертификаты SSL не будут проверены для версий boto >= 2.6.0.
vcpus			Количество vCPU, зарезервированных для контейнера. Этот параметр соответствует CpuShares в разделе «Создание контейнера» в Docker Remote API и параметру --cpu-shares в docker run. Каждая vCPU эквивалентна 1024 CPU-долям.
volumes			Список томов данных, используемых в задаче. Список словарей.
	host		Содержимое параметра host определяет, сохраняется ли ваш том данных на экземпляре хост-контейнера и где он хранится. Если параметр host пуст, Docker-демон назначает путь хоста для вашего тома данных, но данные не гарантируются сохранение после остановки связанных с ним контейнеров. Это словарь с одним свойством, sourcePath — путь на экземпляре хост-контейнера, который представляется контейнеру. Если этот параметр пуст, Docker-демон назначил путь для вас. Если параметр host содержит расположение файла sourcePath, том данных сохраняется в указанном месте на экземпляре хост-контейнера, пока вы его не удалите вручную. Если значение sourcePath не существует на экземпляре хост-контейнера, Docker-демон создает его. Если местоположение существует, содержимое папки sourcePath экспортируется.
	name		Имя тома. Разрешено до 255 символов (строчные и прописные буквы, цифры, дефисы и подчеркивания). Это имя используется в параметре sourceVolume определения контейнера mountPoints.

Примечания

Примечание

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

Примеры

---
- hosts: localhost
  gather_facts: no
  vars:
    state: present
  tasks:
- name: My Batch Job Definition
  batch_job_definition:
    job_definition_name: My Batch Job Definition
    state: present
    type: container
    parameters:
      Param1: Val1
      Param2: Val2
    image: <Docker Image URL>
    vcpus: 1
    memory: 512
    command:
      - python
      - run_my_script.py
      - arg1
    job_role_arn: <Job Role ARN>
    attempts: 3
  register: job_definition_create_result

- name: show results
  debug: var=job_definition_create_result

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

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

Ключ	Возвращаемое значение	Описание
output dict	всегда	возвращает информацию о произведённом действии, изменениях, вызове и ответе Пример: {'batch_job_definition_action': 'none', 'changed': False, 'response': {'status': 'НЕАКТИВНО', 'job_definition_arn': 'arn:aws:batch:....', 'job_definition_name': '<имя>', 'type': 'контейнер'}}

Статус

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

Автор

Jon Meran (@jonmer85)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/aws_batch_job_definition_module.html