amazon.cloud.eks_fargate_profile module – Creates and manage AWS Fargate profiles

Note

This module is part of the amazon.cloud collection (version 0.4.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.cloud.eks_fargate_profile.

New in amazon.cloud 0.2.0

Synopsis

• Creates and manage AWS Fargate profiles for your Amazon EKS cluster.

• You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.9

• boto3 >= 1.25.0

• botocore >= 1.28.0

• jsonpatch

Parameters

Parameter	Comments
access_key aliases: aws_access_key_id, aws_access_key, ec2_access_key string	AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference. The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
aws_ca_bundle path	The location of a CA Bundle to use when validating SSL certificates. The AWS_CA_BUNDLE environment variable may also be used.
aws_config dictionary	A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
cluster_name string	Name of the Cluster.
debug_botocore_endpoint_logs boolean	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. Choices: false ← (default) true
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference. The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.
fargate_profile_name string	Name of FargateProfile.
force boolean	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. Choices: false ← (default) true
identifier string	For compound primary identifiers, to specify the primary identifier as a string, list each in the order that they are specified in the identifier list definition, separated by ‘|’. For more details, visit https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html.
pod_execution_role_arn string	The IAM policy arn for pods.
profile aliases: aws_profile string	A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The AWS_PROFILE environment variable may also be used. The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.
purge_tags boolean	Remove tags not listed in tags. Choices: false true ← (default)
region aliases: aws_region, ec2_region string	The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The AWS_REGION or EC2_REGION environment variables may also be used. See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01 Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key string	AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference. The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.
selectors list / elements=dictionary	Not Provived.
labels list / elements=dictionary	A key-value pair to associate with a pod.
key string	The key name of the label.
value string	The value for the label.
namespace string	Not Provived.
session_token aliases: aws_session_token, security_token, aws_security_token, access_token string	AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference. The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.
state string	Goal state for resource. state=present creates the resource if it doesn’t exist, or updates to the provided state if the resource already exists. state=absent ensures an existing instance is deleted. state=list get all the existing resources. state=describe or state=get retrieves information on an existing resource. Choices: "present" ← (default) "absent" "list" "describe" "get"
subnets list / elements=string	Not Provived.
tags aliases: resource_tags dictionary	A dict of tags to apply to the resource. To remove all tags set tags={} and purge_tags=true.
validate_certs boolean	When set to false, SSL certificates will not be validated for communication with the AWS APIs. Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices: false true ← (default)
wait boolean	Wait for operation to complete before returning. Choices: false ← (default) true
wait_timeout integer	How many seconds to wait for an operation to complete before timing out. Default: 320

Notes

Note

• Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

• The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

- name: Set the cluster name
  set_fact:
    eks_cluster_name: '{{ _resource_prefix }}-cluster'

- name: Define EKS facts
  set_fact:
    eks_fargate_profile_name_a: '{{ _resource_prefix }}-fp-a'
    eks_fargate_profile_name_b: '{{ _resource_prefix }}-fp-b'
    eks_subnets:
    - zone: a
      cidr: 10.0.1.0/24
      type: private
      tag: internal-elb
    - zone: b
      cidr: 10.0.2.0/24
      type: public
      tag: elb
    eks_security_groups:
    - name: '{{ eks_cluster_name }}-control-plane-sg'
      description: EKS Control Plane Security Group
      rules:
      - group_name: '{{ eks_cluster_name }}-workers-sg'
        group_desc: EKS Worker Security Group
        ports: 443
        proto: tcp
      rules_egress:
      - group_name: '{{ eks_cluster_name }}-workers-sg'
        group_desc: EKS Worker Security Group
        from_port: 1025
        to_port: 65535
        proto: tcp
    - name: '{{ eks_cluster_name }}-workers-sg'
      description: EKS Worker Security Group
      rules:
      - group_name: '{{ eks_cluster_name }}-workers-sg'
        proto: tcp
        from_port: 1
        to_port: 65535
      - group_name: '{{ eks_cluster_name }}-control-plane-sg'
        ports: 10250
        proto: tcp

- name: Define selector
  set_fact:
    selectors:
    - labels:
      - key: test
        value: test
      namespace: fp-default

- name: Define the tags
  set_fact:
    tags:
      Foo: foo
      bar: Bar

- name: Create Fargate Profile a with wait
  amazon.cloud.eks_fargate_profile:
    fargate_profile_name: '{{ eks_fargate_profile_name_a }}'
    state: present
    cluster_name: '{{ eks_cluster_name }}'
    pod_execution_role_arn: '{{ _result_create_iam_role_fp.arn }}'
    subnets: "{{_result_create_subnets.results|selectattr('subnet.tags.Name', 'contains', 'private') | map(attribute='subnet.id') }}"
    selectors: '{{ selectors }}'
    wait: true
    tags: '{{ tags }}'
  register: _result_create_fp

- name: List Fargate Profiles
  amazon.cloud.eks_fargate_profile:
    state: list
    cluster_name: '{{ eks_cluster_name }}'
  register: _result_list_fp

- name: Update tags in Fargate Profile a with wait (check mode)
  amazon.cloud.eks_fargate_profile:
    fargate_profile_name: '{{ eks_fargate_profile_name_a }}'
    state: present
    cluster_name: '{{ eks_cluster_name }}'
    pod_execution_role_arn: '{{ _result_create_iam_role_fp.arn }}'
    subnets: "{{_result_create_subnets.results|selectattr('subnet.tags.Name', 'contains', 'private') | map(attribute='subnet.id') }}"
    selectors: '{{ selectors }}'
    wait: true
    tags:
      env: test
      test: foo
  check_mode: true
  register: _result_update_tags_fp

- name: Delete Fargate Profile a
  amazon.cloud.eks_fargate_profile:
    fargate_profile_name: '{{ eks_fargate_profile_name_a }}'
    cluster_name: '{{ eks_cluster_name }}'
    state: absent
    wait: true
    wait_timeout: 900
  register: _result_delete_fp

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
result complex	When state=list, it is a list containing dictionaries of resource information. Otherwise, it is a dictionary of resource information. When state=absent, it is an empty dictionary. Returned: always
identifier string	The unique identifier of the resource. Returned: success
properties dictionary	The resource properties. Returned: success

Authors

• Ansible Cloud Team (@ansible-collections)

Collection links

• Issue Tracker
• Repository (Sources)
• Communication