Spec-Zone.ru › Ansible

Модуль community.aws.batch_compute_environment — управление вычислительными средами AWS Batch

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.aws.batch_compute_environment.

Добавлено в 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_compute_environment. Использование не изменилось.

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

Требования

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

  • python >= 3.6
  • boto3 >= 1.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа 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 (в порядке убывания приоритета).

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

aws_ca_bundle

path

Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов.

Также можно использовать переменную окружения AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

bid_percentage

integer

Минимальный процент от цены On-Demand для данного типа экземпляра, которому должна соответствовать цена Spot Instance, прежде чем будут запущены экземпляры.

Например, если процент ставки равен 20%, цена Spot должна быть ниже 20% от текущей цены On-Demand для этого экземпляра EC2.

compute_environment_name

string / обязательный

Имя вычислительной среды.

Допускается до 128 букв (в верхнем и нижнем регистре), цифр и символов подчёркивания.

compute_environment_state

string

Состояние вычислительной среды.

Если состояние равно ENABLED, вычислительная среда принимает задания из очереди и может автоматически масштабироваться в зависимости от очередей.

Варианты:

  • "ENABLED" ← (по умолчанию)
  • "DISABLED"

compute_resource_type

string / обязательный

Тип вычислительного ресурса.

Варианты:

  • "EC2"
  • "SPOT"

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего числа) вызовов API "resource:action", выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте обработчик aws_resource_action, чтобы вывести общий список вызовов, выполненных в рамках плейбука.

Также можно использовать переменную окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

  • false ← (по умолчанию)
  • true

desiredv_cpus

integer

Желаемое количество виртуальных процессоров EC2 в вычислительной среде.

ec2_key_pair

string

Пара ключей EC2, используемая для экземпляров, запускаемых в вычислительной среде.

endpoint_url

псевдонимы: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим совместимым с AWS сервисам, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную окружения AWS_URL.

image_id

string

Идентификатор Amazon Machine Image (AMI), используемого для экземпляров, запускаемых в вычислительной среде.

instance_role

string / обязательный

Роль экземпляра Amazon ECS, назначаемая экземплярам Amazon EC2 в вычислительной среде.

instance_types

list / элементы=string / обязательный

Типы экземпляров, которые можно запускать.

maxv_cpus

integer / обязательный

Максимальное количество виртуальных процессоров EC2, которого может достичь среда.

minv_cpus

integer / обязательный

Минимальное количество виртуальных процессоров EC2, которое должна поддерживать среда.

profile

псевдонимы: aws_profile

string

Именованный профиль AWS для аутентификации.

Подробнее об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную окружения AWS_PROFILE.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.

region

псевдонимы: aws_region

string

Регион AWS, который следует использовать.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную окружения AWS_REGION.

Подробнее см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа 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 (в порядке убывания приоритета).

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для единообразия с AWS SDK botocore.

security_group_ids

list / элементы=string / обязательный

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

service_role

string / обязательный

Полное имя ресурса Amazon (ARN) роли IAM, позволяющей AWS Batch вызывать от вашего имени другие сервисы AWS.

session_token

псевдонимы: aws_session_token

string

Токен сеанса 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.

Параметры session_token и profile являются взаимоисключающими.

spot_iam_fleet_role

string

Имя ресурса Amazon (ARN) роли IAM для Amazon EC2 Spot Fleet, назначаемой вычислительной среде типа SPOT.

state

string

Описывает желаемое состояние.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

subnets

list / элементы=string / обязательный

Подсети VPC, в которых запускаются вычислительные ресурсы.

tags

dictionary

Теги в виде пар «ключ-значение», назначаемые ресурсам, запускаемым в вычислительной среде.

type

string / обязательный

Тип вычислительной среды.

Варианты:

  • "MANAGED"
  • "UNMANAGED"

validate_certs

boolean

Если установлено значение false, SSL-сертификаты для обмена данными с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: My Batch Compute Environment
  community.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

dictionary

возвращает сведения о выполненном действии, изменениях, вызове и ответе

Возвращается: всегда

Пример: {"batch_compute_environment_action": "none", "changed": false, "invocation": {"module_args": {"access_key": null, "bid_percentage": null, "compute_environment_name": "<name>", "compute_environment_state": "ENABLED", "compute_resource_type": "EC2", "desiredv_cpus": 0, "ec2_key_pair": null, "endpoint_url": null, "image_id": null, "instance_role": "arn:aws:iam::...", "instance_types": ["optimal"], "maxv_cpus": 8, "minv_cpus": 0, "profile": null, "region": "us-east-1", "secret_key": null, "security_group_ids": ["*******"], "security_token": null, "service_role": "arn:aws:iam::....", "spot_iam_fleet_role": null, "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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/aws/batch_compute_environment_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API