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

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

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

Обзор

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

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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
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 логический добавлено в 2.8	Варианты: нет ← да	Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», сделанных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, сделанный во время выполнения сценария. Также может быть использована переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.
desiredv_cpus -		Желаемое количество EC2 виртуальных ядер в среде выполнения.
ec2_key_pair -		EC2 пара ключей, используемая для экземпляров, запущенных в среде выполнения.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать адреса EC2). Игнорируется для модулей, где регион требуется. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной среды EC2_URL, если таковая есть.
image_id -		Идентификатор Amazon Machine Image (AMI), используемый для экземпляров, запущенных в среде выполнения.
instance_role - / обязательно		Роль экземпляра Amazon ECS, применяемая к экземплярам Amazon EC2 в среде выполнения.
instance_types - / обязательно		Типы экземпляров, которые могут быть запущены.
maxv_cpus - / обязательно		Максимальное количество EC2 виртуальных ядер, которое может достичь среда.
minv_cpus - / обязательно		Минимальное количество EC2 виртуальных ядер, которые должна поддерживать среда.
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0.
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. псевдонимы: access_token
service_role - / обязательно		Полное имя Amazon Resource Name (ARN) роли IAM, которая позволяет AWS Batch выполнять вызовы к другим службам AWS от вашего имени.
spot_iam_fleet_role -		Amazon Resource Name (ARN) роли IAM Amazon EC2 Spot Fleet, применённой к среде выполнения SPOT.
state - / обязательно	Варианты: present ← absent	Описывает желаемое состояние.
subnets - / обязательно		Подсети VPC, в которые запускаются вычислительные ресурсы.
tags -		Теги в формате ключ-значение, которые нужно применить к ресурсам, запущенным в среде выполнения.
type - / обязательно	Варианты: MANAGED UNMANAGED	Тип среды выполнения.
validate_certs логический	Варианты: нет да ←	Если установлено «нет», сертификаты SSL не будут проверены для версий boto >= 2.6.0.

Примечания

Примечание

Если параметры не заданы в модуле, следующие переменные среды могут использоваться в порядке убывания приоритета 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 Compute Environment
    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>

  - name: show results
    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'}}

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/aws_batch_compute_environment_module.html