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

Примечание

Этот плагин является частью коллекции community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в плейбуке укажите: community.aws.aws_batch_job_queue.

Новое в версии 1.0.0: из community.aws

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

Описание

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aws_access_key строка			Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_access_key и profile одновременно устарела, и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь			Расположение файла CA-сертификатов для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: CA-сертификаты считываются со стороны модуля и, возможно, должны быть явно скопированы с контроллера, если они не выполняются локально.
aws_config словарь			Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительные настройки boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка			Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Передача параметров aws_secret_key и profile одновременно устарела, и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
compute_environment_order список / элементы=словарь / обязательный			Набор сред выполнения, сопоставленных с очередью задач, и их порядок по отношению друг к другу. Планировщик задач использует этот параметр для определения среды выполнения, которая должна выполнить задачу. Среды выполнения должны быть в состоянии VALID, прежде чем вы сможете связать их с очередью задач. Вы можете связать до 3 сред выполнения с очередью задач.
	compute_environment строка		Название среды выполнения.
	order целое число		Относительный приоритет среды.
debug_botocore_endpoint_logs логический тип		Варианты: нет ← да	Используйте логирование botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, выполненного во время плейбука. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
ec2_url строка			URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2). Игнорируется для модулей, для которых требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если она есть. псевдонимы: aws_endpoint_url, endpoint_url
job_queue_name строка / обязательный			Имя очереди задач
job_queue_state строка		Варианты: ENABLED ← DISABLED	Состояние очереди задач. Если состояние очереди задач ENABLED, она может принимать задачи.
priority целое число / обязательный			Приоритет очереди задач. Очереди задач с более высоким приоритетом (или с меньшим целочисленным значением для параметра priority) обрабатываются в первую очередь, если они связаны с одной и той же средой выполнения. Приоритет определяется в порядке возрастания, например, очередь задач с приоритетом 1 получает приоритет в планировании по сравнению с очередью задач с приоритетом 10.
profile строка			Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, а поддержка их одновременной передачи с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
region строка			Регион AWS. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка			Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Передача параметров security_token и profile одновременно устарела, и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
state строка		Варианты: present ← absent	Описывает желаемое состояние.
validate_certs логический тип		Варианты: нет да ←	При значении "нет", SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, 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, AWS_CA_BUNDLE
Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION можно использовать для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- name: My Batch Job Queue
  community.aws.aws_batch_job_queue:
    job_queue_name: jobQueueName
    state: present
    region: us-east-1
    job_queue_state: ENABLED
    priority: 1
    compute_environment_order:
    - order: 1
      compute_environment: my_compute_env1
    - order: 2
      compute_environment: my_compute_env2
  register: batch_job_queue_action

- name: show results
  ansible.builtin.debug:
    var: batch_job_queue_action

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
output словарь	всегда	возвращает произведённое действие, было ли что-то изменено, вызов и ответ Пример: {'batch_job_queue_action': 'updated', 'changed': False, 'response': {'job_queue_arn': 'arn:aws:batch:....', 'job_queue_name': '<name>', 'priority': 1, 'state': 'DISABLED', 'status': 'UPDATING', 'status_reason': 'JobQueue Healthy'}}

Авторы

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.10/collections/community/aws/aws_batch_job_queue_module.html