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 символов (строчные и прописные буквы), цифры, дефисы, нижние подчеркивания, двоеточия, точки, слеши и диезы.
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 -			Список ограничений ulimit для задания в контейнере. Этот параметр соответствует параметру Ulimits в разделе «Создание контейнера» в Docker Remote API и параметру --ulimit в команде docker run. Список словарей.
	hardLimit -		Жесткое ограничение для типа ulimit.
	name -		Тип ограничения ulimit.
	softLimit -		Мягкое ограничение для типа ulimit.
user -			Имя пользователя для использования внутри контейнера. Этот параметр соответствует параметру User в разделе «Создание контейнера» в Docker Remote API и параметру --user в команде docker run.
validate_certs boolean добавлен в 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 создаёт его. Если местоположение существует, содержимое папки source path экспортируется.
	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), если учетные данные не предоставлены. См. https://boto.readthedocs.io/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 словарь	всегда	возвращает, какое действие было выполнено, было ли что-то изменено, вызов и ответ Пример: {'batch_job_definition_action': 'none', 'changed': False, 'response': {'job_definition_arn': 'arn:aws:batch:....', 'job_definition_name': '<name>', 'status': 'НЕАКТИВЕН', 'type': 'контейнер'}}

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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.7/modules/aws_batch_job_definition_module.html