Модуль community.aws.batch_job_definition – Управление определениями задач AWS Batch

Примечание

Этот модуль входит в коллекцию community.aws (версия 8.0.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в книге задач укажите: community.aws.batch_job_definition.

Впервые появился в community.aws 1.0.0

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

Этот модуль позволяет управлять определениями задач AWS Batch.
Он идемпотентен и поддерживает режим "Проверка".
Для управления средой выполнения используйте модуль community.aws.batch_compute_environment, для управления очередями задач - community.aws.batch_job_queue, для управления определениями задач - community.aws.batch_job_definition.
До версии 5.0.0 этот модуль назывался community.aws.aws_batch_job_definition. Способ использования не изменился.

Псевдонимы: aws_batch_job_definition

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key, ec2_access_key строка	Идентификатор ключа доступа AWS. Дополнительную информацию о маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные среды `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Опции aws_access_key и profile взаимоисключающие. Псевдоним aws_access_key_id добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
attempts целое число	Стратегия повторных попыток - количество раз, когда задание перемещается в состояние RUNNABLE. Вы можете указать от 1 до 10 попыток. Если attempts больше одного, задание повторяется в случае ошибки, пока не перейдет в состояние RUNNABLE указанное количество раз.
aws_ca_bundle путь	Местоположение файла сертификата CA для проверки SSL-сертификатов. Также может использоваться переменная среды `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
command список / элементы=строка	Команда, передаваемая контейнеру. Этот параметр соответствует параметру Cmd в разделе «Создание контейнера» в Docker Remote API и параметру COMMAND в docker run. Дополнительную информацию см. на странице https://docs.docker.com/engine/reference/builder/#cmd. Значение по умолчанию: `[]`
debug_botocore_endpoint_logs булево	Использовать логгер `botocore.endpoint` для анализа уникальных (а не общих) `"resource:action"` API-вызовов, сделанных во время задачи, выводя набор в ключ resource_actions результатов задачи. Используйте обратный вызов `aws_resource_action` для вывода полного списка, сделанного во время выполнения плейбука. Также может использоваться переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Возможные значения: `false` ← (по умолчанию) `true`
endpoint_url псевдонимы: ec2_url, aws_endpoint_url, s3_url строка	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws протестированы только для AWS. Также могут использоваться переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
environment список / элементы=словарь	Переменные среды, передаваемые контейнеру. Этот параметр соответствует параметру Env в разделе «Создание контейнера» в Docker Remote API и параметру –env в docker run. Значение по умолчанию: `[]`
name строка	Имя пары ключ-значение. Для переменных среды это имя переменной среды.
value строка	Значение пары ключ-значение. Для переменных среды это значение переменной среды.
image строка / обязательно	Используемый образ для запуска контейнера. Эта строка передается непосредственно демону Docker. Образы из реестра Docker Hub доступны по умолчанию. Другие репозитории указываются с помощью `repository-url/image-name: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 алиасы: aws_profile строка	Используемый профиль AWS для аутентификации. Для получения дополнительной информации о профилях см. документацию AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также может использоваться переменная окружения `AWS_PROFILE`. Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token.
readonly_root_filesystem строка	При значении true контейнер получает доступ только для чтения к своей корневой файловой системе. Этот параметр соответствует параметру ReadonlyRootfs в разделе «Создание контейнера» в Docker Remote API и параметру –read-only в команде docker run.
region алиасы: aws_region, ec2_region строка	Используемая область AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, region игнорируется. Также могут использоваться переменные окружения `AWS_REGION` или `EC2_REGION`. Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Алиас `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной окружения `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key алиасы: aws_secret_access_key, aws_secret_key, ec2_secret_key строка	Секретный ключ доступа AWS. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные окружения `AWS_SECRET_ACCESS_KEY`, `AWS_SECRET_KEY`, или `EC2_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile взаимоисключающие. Алиас aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с SDK AWS botocore. Алиас ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
session_token алиасы: aws_session_token, security_token, aws_security_token, access_token строка	Токен сессии AWS STS для использования с временными учетными данными. Дополнительную информацию об маркерах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также могут использоваться переменные окружения `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN`, или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Алиасы aws_session_token и session_token были добавлены в релизе 3.2.0, параметр был переименован из security_token в session_token в релизе 6.0.0. Алиасы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных окружения `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state строка	Описывает желаемое состояние. Варианты: `"present"` ← (по умолчанию) `"absent"`
type строка / обязательно	Тип определения задачи.
ulimits список / элементы=словарь	Список ограничений ulimits для установки в контейнере. Этот параметр соответствует параметру Ulimits в разделе «Создание контейнера» в Docker Remote API и параметру –ulimit в команде docker run. По умолчанию: `[]`

hardLimit string	Жесткое ограничение для типа ulimit.
name string	Тип ограничения ulimit.
softLimit string	Мягкое ограничение для типа ulimit.
user string	Имя пользователя для использования внутри контейнера. Этот параметр соответствует параметру User в разделе Создание контейнера в Docker Remote API и параметру –user в команде docker run.
validate_certs boolean	Если установлено в `false`, сертификаты SSL не будут проверяться при общении с AWS API. Настройка validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите настройку aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)
vcpus integer / обязательно	Количество выделенных виртуальных процессоров (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.

Примечания

Примечание

Внимание: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не «контроллер». Поэтому файлы, возможно, нужно явно скопировать в «хост». Для плагинов lookup и connection переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не «хост».
AWS SDK (boto3), используемый Ansible, также может читать значения по умолчанию для учетных данных и других параметров, таких как регион, из его конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). Дополнительную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

---
- name: My Batch Job Definition
  community.aws.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
  ansible.builtin.debug: var=job_definition_create_result

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

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

Ключ	Описание
output словарь	Возвращает, какое действие было выполнено, были ли какие-либо изменения, вызов и ответ. Возвращаемое значение: всегда Пример: `{"aws_batch_job_definition_action": "none", "changed": false, "response": {"job_definition_arn": "arn:aws:batch:....", "job_definition_name": "<name>", "status": "INACTIVE", "type": "container"}}`

Ключ

Описание

output

словарь

Возвращает, какое действие было выполнено, были ли какие-либо изменения, вызов и ответ.

Возвращаемое значение: всегда

Пример: {"aws_batch_job_definition_action": "none", "changed": false, "response": {"job_definition_arn": "arn:aws:batch:....", "job_definition_name": "<name>", "status": "INACTIVE", "type": "container"}}

Авторы

Jon Meran (@jonmer85)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/batch_job_definition_module.html