community.aws.aws_batch_compute_environment – Управление средами выполнения AWS Batch

Примечание

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

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

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

Новое в версии 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
bid_percentage целое число		Минимальный процент, на который цена Spot Instance должна быть ниже цены On-Demand для данного типа экземпляра, прежде чем экземпляры будут запущены. Например, если ваш процент предложения составляет 20%, то цена Spot должна быть ниже 20% от текущей цены On-Demand для данного экземпляра EC2.
compute_environment_name строка / обязательно		Имя вашей вычислительной среды. Разрешается до 128 букв (строчные и прописные), цифр и символов подчеркивания.
compute_environment_state строка	Варианты: ENABLED ← DISABLED	Состояние вычислительной среды. Если состояние `ENABLED`, то вычислительная среда принимает задачи из очереди и может масштабироваться автоматически в зависимости от очередей.
compute_resource_type строка / обязательно	Варианты: EC2 SPOT	Тип вычислительного ресурса.
debug_botocore_endpoint_logs логический тип	Варианты: нет ← да	Используйте логирователь botocore.endpoint для анализа уникальных (а не суммарных) API-вызовов «ресурс:действие», выполненных во время задачи, выводив набор в ключ resource_actions результатов задачи. Используйте обратный вызов aws_resource_action для вывода полного списка, сделанного во время исполнения playbook. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
desiredv_cpus целое число		Желаемое количество EC2 vCPUs в вычислительной среде.
ec2_key_pair строка		Ключ пары EC2, используемый для экземпляров, запущенных в вычислительной среде.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая имеется. Псевдонимы: aws_endpoint_url, endpoint_url
image_id строка		Идентификатор Amazon Machine Image (AMI), используемый для экземпляров, запущенных в вычислительной среде.
instance_role строка / обязательно		Роль экземпляра Amazon ECS, применяемая к экземплярам Amazon EC2 в вычислительной среде.
instance_types список / элементы=строка / обязательно		Типы экземпляров, которые могут быть запущены.
maxv_cpus целое число / обязательно		Максимальное количество EC2 vCPUs, которое может достичь среда.
minv_cpus целое число / обязательно		Минимальное количество EC2 vCPUs, которое должна поддерживать среда.
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_group_ids список / элементы=строка / обязательно		EC2 группы безопасности, которые связаны с запущенными в вычислительной среде экземплярами.
security_token строка		AWS STS токен безопасности. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающим после 2022-06-01. Псевдонимы: aws_security_token, access_token
service_role строка / обязательно		Полный Amazon Resource Name (ARN) IAM-роли, которая позволяет AWS Batch делать вызовы к другим AWS-сервисам от вашего имени.
spot_iam_fleet_role строка		Amazon Resource Name (ARN) Amazon EC2 Spot Fleet IAM-роли, применяемой к вычислительной среде SPOT.
state строка	Варианты: present ← absent	Описывает желаемое состояние.
subnets список / элементы=строка / обязательно		VPC-подсети, в которые запускаются вычислительные ресурсы.
tags словарь		Метки с парами ключ-значение, которые должны быть применены к ресурсам, запущенным в вычислительной среде.
type строка / обязательно	Варианты: MANAGED UNMANAGED	Тип вычислительной среды.
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 Compute Environment
  community.aws.aws_batch_compute_environment:
    compute_environment_name: computeEnvironmentName
    state: present
    region: us-east-1
    compute_environment_state: ENABLED
    type: MANAGED
    compute_resource_type: EC2
    minv_cpus: 0
    maxv_cpus: 2
    desiredv_cpus: 1
    instance_types:
      - optimal
    subnets:
      - my-subnet1
      - my-subnet2
    security_group_ids:
      - my-sg1
      - my-sg2
    instance_role: arn:aws:iam::<account>:instance-profile/<role>
    tags:
      tag1: value1
      tag2: value2
    service_role: arn:aws:iam::<account>:role/service-role/<role>
  register: aws_batch_compute_environment_action

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

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

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

Ключ	Возвращаемое значение	Описание
output словарь	всегда	возвращает, что было выполнено, было ли что-то изменено, вызов и ответ Пример: {'batch_compute_environment_action': 'none', 'changed': False, 'invocation': {'module_args': {'aws_access_key': None, 'aws_secret_key': None, 'bid_percentage': None, 'compute_environment_name': '<name>', 'compute_environment_state': 'ENABLED', 'compute_resource_type': 'EC2', 'desiredv_cpus': 0, 'ec2_key_pair': None, 'ec2_url': None, 'image_id': None, 'instance_role': 'arn:aws:iam::...', 'instance_types': ['optimal'], 'maxv_cpus': 8, 'minv_cpus': 0, 'profile': None, 'region': 'us-east-1', 'security_group_ids': ['*****'], 'security_token': None, 'service_role': 'arn:aws:iam::....', 'spot_iam_fleet_role': None, 'state': 'present', 'subnets': ['**'], 'tags': {'Environment': '<name>', 'Name': '<name>'}, 'type': 'MANAGED', 'validate_certs': True}}, 'response': {'computeEnvironmentArn': 'arn:aws:batch:....', 'computeEnvironmentName': '<name>', 'computeResources': {'desiredvCpus': 0, 'instanceRole': 'arn:aws:iam::...', 'instanceTypes': ['optimal'], 'maxvCpus': 8, 'minvCpus': 0, 'securityGroupIds': ['**'], 'subnets': ['*****'], 'tags': {'Environment': '<name>', 'Name': '<name>'}, 'type': 'EC2'}, 'ecsClusterArn': 'arn:aws:ecs:.....', 'serviceRole': 'arn:aws:iam::...', 'state': 'ENABLED', 'status': 'VALID', 'statusReason': 'ComputeEnvironment Healthy', 'type': 'MANAGED'}}

Авторы

Jon Meran (@jonmer85)

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