Try SpotterManage AWS Batch Compute Environments
| "added in version" 2.5 of ansible.builtin"
Authors: Jon Meran (@jonmer85)
preview | supported by community
pipInstall with pip install ansible==2.9.17
This module allows the management of AWS Batch Compute Environments. It is idempotent and supports "Check" mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.
---
- 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>
register: aws_batch_compute_environment_action
- name: show results
debug:
var: aws_batch_compute_environment_action
tags:
description:
- Key-value pair tags to be applied to resources that are launched in the compute
environment.
type:
choices:
- MANAGED
- UNMANAGED
description:
- The type of the compute environment.
required: true
state:
choices:
- present
- absent
default: present
description:
- Describes the desired state.
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
subnets:
description:
- The VPC subnets into which the compute resources are launched.
required: true
image_id:
description:
- The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
maxv_cpus:
description:
- The maximum number of EC2 vCPUs that an environment can reach.
required: true
minv_cpus:
description:
- The minimum number of EC2 vCPUs that an environment should maintain.
required: true
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
ec2_key_pair:
description:
- The EC2 key pair that is used for instances launched in the compute environment.
service_role:
description:
- The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make
calls to other AWS services on your behalf.
required: true
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
desiredv_cpus:
description:
- The desired number of EC2 vCPUS in the compute environment.
instance_role:
description:
- The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.
required: true
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
bid_percentage:
description:
- The minimum percentage that a Spot Instance price must be when compared with the
On-Demand price for that instance type before instances are launched. For example,
if your bid percentage is 20%, then the Spot price must be below 20% of the current
On-Demand price for that EC2 instance.
instance_types:
description:
- The instance types that may be launched.
required: true
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
security_group_ids:
description:
- The EC2 security groups that are associated with instances launched in the compute
environment.
required: true
spot_iam_fleet_role:
description:
- The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to
a SPOT compute environment.
compute_resource_type:
choices:
- EC2
- SPOT
description:
- The type of compute resource.
required: true
compute_environment_name:
description:
- The name for your compute environment. Up to 128 letters (uppercase and lowercase),
numbers, and underscores are allowed.
required: true
compute_environment_state:
choices:
- ENABLED
- DISABLED
default: ENABLED
description:
- The state of the compute environment. If the state is ENABLED, then the compute
environment accepts jobs from a queue and can scale out automatically based on queues.
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
output:
description: returns what action was taken, whether something was changed, invocation
and response
returned: always
sample:
batch_compute_environment_action: none
changed: false
invocation:
module_args:
aws_access_key: null
aws_secret_key: null
bid_percentage: null
compute_environment_name: <name>
compute_environment_state: ENABLED
compute_resource_type: EC2
desiredv_cpus: 0
ec2_key_pair: null
ec2_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
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
type: dict