community.aws.batch_compute_environment модуль – Управление средами вычислений AWS Batch

Примечание

Этот модуль является частью коллекции community.aws (версия 8.0.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.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_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` или `EC2_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в версии 5.1.0 для обеспечения согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в выпуске после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в выпуске после 2024-12-01.
aws_ca_bundle path	Расположение пакета CA, используемого при проверке 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	Минимальный процент, который должна составлять цена экземпляра Spot по сравнению с ценой по запросу для этого типа экземпляра, прежде чем будут запущены экземпляры. Например, если ваш процент ставки составляет 20%, то цена Spot должна быть ниже 20% текущей цены по запросу для этого экземпляра EC2.
compute_environment_name string / required	Имя вашей среды выполнения. Допускается до 128 букв (прописных и строчных), цифр и знаков подчеркивания.
compute_environment_state string	Состояние среды выполнения. Если состояние равно `ENABLED`, то среда выполнения принимает задания из очереди и может автоматически масштабироваться на основе очередей. Варианты: `"ENABLED"` ← (по умолчанию) `"DISABLED"`
compute_resource_type string / required	Тип вычислительного ресурса. Варианты: `"EC2"` `"SPOT"`
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, созданный во время выполнения playbook. Также может использоваться переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
desiredv_cpus integer	Требуемое количество EC2 vCPUS в среде выполнения.
ec2_key_pair string	Пара ключей EC2, используемая для экземпляров, запущенных в среде выполнения.
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Также могут использоваться переменные среды `AWS_URL` или `EC2_URL` в порядке убывания приоритета. Псевдонимы ec2_url и s3_url устарели и будут удалены в выпуске после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в выпуске после 2024-12-01.
image_id string	Идентификатор образа Amazon Machine Image (AMI), используемый для экземпляров, запущенных в среде выполнения.
instance_role string / required	Роль экземпляра Amazon ECS, применяемая к экземплярам Amazon EC2 в среде выполнения.
instance_types list / elements=string / required	Типы экземпляров, которые могут быть запущены.
maxv_cpus integer / required	Максимальное количество EC2 vCPUS, которого может достичь среда.
minv_cpus integer / required	Минимальное количество EC2 vCPUS, которое должна поддерживать среда.

profile aliases: 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 и security_token.
region aliases: aws_region, ec2_region string	Регион 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 aliases: aws_secret_access_key, aws_secret_key, ec2_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` или `EC2_SECRET_KEY` в порядке убывания предпочтения. Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной окружения `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.
security_group_ids list / elements=string / required	Группы безопасности EC2, связанные с экземплярами, запущенными в вычислительной среде.
service_role string / required	Полное имя ресурса Amazon (ARN) роли IAM, которая позволяет AWS Batch выполнять вызовы другим службам AWS от вашего имени.
session_token aliases: aws_session_token, security_token, aws_security_token, access_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`, `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.
spot_iam_fleet_role string	Имя ресурса Amazon (ARN) роли Amazon EC2 Spot Fleet, применяемой к вычислительной среде SPOT.
state string	Описывает желаемое состояние. Варианты: `"present"` ← (default) `"absent"`
subnets list / elements=string / required	Подсети VPC, в которые запускаются вычислительные ресурсы.
tags dictionary	Теги пар «ключ-значение», которые нужно применять к ресурсам, запускаемым в вычислительной среде.
type string / required	Тип вычислительной среды. Варианты: `"MANAGED"` `"UNMANAGED"`
validate_certs boolean	Когда установлено значение `false`, SSL-сертификаты не будут проверяться для связи с API AWS. Установка validate_certs=false настоятельно не рекомендуется, в качестве альтернативы рассмотрите возможность установки aws_ca_bundle вместо этого. Варианты: `false` `true` ← (default)

Примечания

Примечание

Предупреждение: Для модулей переменные среды и конфигурационные файлы считываются из контекста Ansible «хост», а не из контекста «контроллер». Таким образом, файлы могут нуждаться в явном копировании на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы считываются из контекста Ansible «контроллер», а не из контекста «хост».
SDK AWS (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте 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 словарь	возвращает выполненное действие, изменение, вызов и ответ Возвращается: всегда Пример: {"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"}}

Ключ

Описание

output

словарь

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

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

Пример: {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/batch_compute_environment_module.html