Try SpotterCreate and manages Amazon EKS control planes
| "added in version" 0.1.0 of amazon.cloud"
Authors: Ansible Cloud Team (@ansible-collections)
Install with ansible-galaxy collection install amazon.cloud:==0.4.0
collections:
- name: amazon.cloud
version: 0.4.0Create and manage Amazon EKS control planes.
- name: Set the cluster name
set_fact:
eks_cluster_name: '{{ _resource_prefix }}-cluster'
- name: Create EKS cluster
amazon.cloud.eks_cluster:
name: '{{ eks_cluster_name }}'
resources_vpc_config:
security_group_ids: "{{ _result_create_security_groups.results | map(attribute='group_id') }}"
subnet_ids: "{{ _result_create_subnets.results | map(attribute='subnet.id') }}"
endpoint_public_access: true
endpoint_private_access: false
public_access_cidrs:
- 0.0.0.0/0
role_arn: '{{ _result_create_iam_role.arn }}'
tags:
Name: '{{ _resource_prefix }}-eks-cluster'
wait_timeout: 900
register: _result_create_cluster
- name: Describe EKS cluster
amazon.cloud.eks_cluster:
name: '{{ eks_cluster_name }}'
state: describe
register: _result_get_cluster
- name: List EKS clusters
amazon.cloud.eks_cluster:
state: list
register: _result_list_clusters
name:
description:
- The unique name to give to your cluster.
type: str
tags:
aliases:
- resource_tags
description:
- A dict of tags to apply to the resource.
- To remove all tags set I(tags={}) and I(purge_tags=true).
type: dict
wait:
default: false
description:
- Wait for operation to complete before returning.
type: bool
force:
default: false
description:
- Cancel IN_PROGRESS and PENDING resource requestes.
- Because you can only perform a single operation on a given resource at a time, there
might be cases where you need to cancel the current resource operation to make the
resource available so that another operation may be performed on it.
type: bool
state:
choices:
- present
- absent
- list
- describe
- get
default: present
description:
- Goal state for resource.
- I(state=present) creates the resource if it doesn't exist, or updates to the provided
state if the resource already exists.
- I(state=absent) ensures an existing instance is deleted.
- I(state=list) get all the existing resources.
- I(state=describe) or I(state=get) retrieves information on an existing resource.
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
logging:
description:
- Enable exporting the Kubernetes control plane logs for your cluster to CloudWatch
Logs based on log types.
- By default, cluster control plane logs arent exported to CloudWatch Logs.
suboptions:
cluster_logging:
description:
- The cluster control plane logging configuration for your cluster.
- The cluster control plane logging configuration for your cluster.
suboptions:
enabled_types:
description:
- Enabled Logging Type.
elements: dict
suboptions:
type:
choices:
- api
- audit
- authenticator
- controllerManager
- scheduler
description:
- name of the log type.
type: str
type: list
type: dict
type: dict
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
version:
description:
- The desired Kubernetes version for your cluster.
- If you dont specify a value here, the latest version available in Amazon EKS is
used.
type: str
role_arn:
description:
- The Amazon Resource Name (ARN) of the IAM role that provides permissions for the
Kubernetes control plane to make calls to AWS API operations on your behalf.
type: str
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
purge_tags:
default: true
description:
- Remove tags not listed in I(tags).
type: bool
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
wait_timeout:
default: 320
description:
- How many seconds to wait for an operation to complete before timing out.
type: int
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
outpost_config:
description:
- An object representing the Outpost configuration to use for AWS EKS outpost cluster.
suboptions:
control_plane_instance_type:
description:
- Specify the Instance type of the machines that should be used to create your
cluster.
type: str
control_plane_placement:
description:
- Specify the placement group of the control plane machines for your cluster.Specify
the placement group of the control plane machines for your cluster.
suboptions:
group_name:
description:
- Specify the placement group name of the control place machines for your
cluster.
type: str
type: dict
outpost_arns:
description:
- Specify one or more Arn(s) of Outpost(s) on which you would like to create your
cluster.
elements: str
type: list
type: dict
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
encryption_config:
description:
- The encryption configuration for the cluster.
elements: dict
suboptions:
provider:
description:
- The encryption provider for the cluster.
suboptions:
key_arn:
description:
- Amazon Resource Name (ARN) or alias of the KMS key.
- The KMS key must be symmetric, created in the same region as the cluster,
and if the KMS key was created in a different account, the user must have
access to the KMS key.
type: str
type: dict
resources:
description:
- Specifies the resources to be encrypted.
- The only supported value is secrets.
elements: str
type: list
type: list
resources_vpc_config:
description:
- An object representing the VPC configuration to use for an Amazon EKS cluster.
suboptions:
endpoint_private_access:
description:
- Set this value to true to enable private access for your clusters Kubernetes
API server endpoint.
- If you enable private access, Kubernetes API requests from within your clusters
VPC use the private VPC endpoint.
- The default value for this parameter is false, which disables private access
for your Kubernetes API server.
- If you disable private access and you have nodes or AWS Fargate pods in the
cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks
for communication with the nodes or Fargate pods.
type: bool
endpoint_public_access:
description:
- Set this value to false to disable public access to your clusters Kubernetes
API server endpoint.
- If you disable public access, your clusters Kubernetes API server can only receive
requests from within the cluster VPC. The default value for this parameter is
true, which enables public access for your Kubernetes API server.
type: bool
public_access_cidrs:
description:
- The CIDR blocks that are allowed access to your clusters public Kubernetes API
server endpoint.
- Communication to the endpoint from addresses outside of the CIDR blocks that
you specify is denied.
- The default value is 0.0.0.0/0.
- If youve disabled private endpoint access and you have nodes or AWS Fargate
pods in the cluster, then ensure that you specify the necessary CIDR blocks.
elements: str
type: list
security_group_ids:
description:
- Specify one or more security groups for the cross-account elastic network interfaces
that Amazon EKS creates to use to allow communication between your worker nodes
and the Kubernetes control plane.
- If you dont specify a security group, the default security group for your VPC
is used.
elements: str
type: list
subnet_ids:
description:
- Specify subnets for your Amazon EKS nodes.
- Amazon EKS creates cross-account elastic network interfaces in these subnets
to allow communication between your nodes and the Kubernetes control plane.
elements: str
type: list
type: dict
kubernetes_network_config:
description:
- The Kubernetes network configuration for the cluster.
suboptions:
ip_family:
choices:
- ipv4
- ipv6
description:
- Ipv4 or Ipv6.
- You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1
or later of the Amazon VPC CNI add-on.
type: str
service_ipv4_cidr:
description:
- The CIDR block to assign Kubernetes service IP addresses from.
- If you dont specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16
or 172.20.0.0/16 CIDR blocks.
- We recommend that you specify a block that does not overlap with resources in
other networks that are peered or connected to your VPC.
type: str
type: dict
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
result:
contains:
identifier:
description: The unique identifier of the resource.
type: str
properties:
description: The resource properties.
type: dict
description:
- When I(state=list), it is a list containing dictionaries of resource information.
- Otherwise, it is a dictionary of resource information.
- When I(state=absent), it is an empty dictionary.
returned: always
type: complex