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

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

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

Описание

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
attempts			Стратегия повторных попыток — количество раз, чтобы перевести задачу в состояние RUNNABLE. Вы можете указать от 1 до 10 попыток. Если attempts больше одного, задача повторяется при неудаче, пока не перейдет в состояние RUNNABLE указанное количество раз.
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
command			Команда, передаваемая контейнеру. Этот параметр соответствует Cmd в разделе «Создание контейнера» в Docker Remote API и параметру COMMAND в docker run. Для получения дополнительной информации см. https://docs.docker.com/engine/reference/builder/#cmd.
ec2_url			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. Список словарей.
	containerPath		Путь внутри контейнера для монтирования тома хоста.
	readOnly		Если значение true, контейнер имеет чтение-только доступ к тому; в противном случае контейнер может записывать в том. Значение по умолчанию — false.
	sourceVolume		Имя монтируемого тома.
parameters			Значения по умолчанию для параметров подстановки, которые нужно установить в определении задачи. Параметры указываются как пары ключ-значение. Параметры в запросе SubmitJob переопределяют любые соответствующие параметры по умолчанию из определения задачи.
privileged			Когда этот параметр равен true, контейнеру предоставляются повышенные привилегии на хостовом контейнере (аналогично пользователю root). Этот параметр соответствует Privileged в разделе «Создание контейнера» в Docker Remote API и параметру --privileged в docker run.
profile (добавлено в 1.6)			Использует профиль 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)			AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Псевдонимы: access_token
state обязательно		Варианты: present ← absent	Описывает желаемое состояние.
type обязательно			Тип определения задачи.
ulimits			Список лимитов ulimits для установки в контейнере. Этот параметр соответствует Ulimits в разделе «Создание контейнера» в Docker Remote API и параметру --ulimit в docker run. Список словарей.
	hardLimit		Жесткое ограничение для типа лимита ulimit.
	name		Тип лимита ulimit.
	softLimit		Мягкое ограничение для типа лимита ulimit.
user			Имя пользователя для использования внутри контейнера. Этот параметр соответствует User в разделе «Создание контейнера» в Docker Remote API и параметру --user в docker run.
validate_certs bool (добавлено в 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': {'job_definition_arn': 'arn:aws:batch:....', 'job_definition_name': '<name>', 'status': 'НЕАКТИВЕН', 'type': 'контейнер'}}

Состояние

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

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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