community.aws.eks_fargate_profile 模块 – 管理 EKS Fargate Profile

注意

此模块是 community.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：community.aws.eks_fargate_profile。

community.aws 4.0.0 中的新增功能

概要

• 管理 EKS Fargate Profile。

要求

以下要求需要在执行此模块的主机上满足。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 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 路径	用于验证 SSL 证书的 CA 包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
cluster_name 字符串 / 必需	EKS 集群的名称。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调来输出 playbook 期间制作的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	要连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
name 字符串 / 必需	EKS Fargate Profile 的名称。
profile 别名：aws_profile 字符串	用于身份验证的命名 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 选项互斥。
purge_tags 布尔值	如果 purge_tags=true 且设置了 tags，则现有标签将从资源中清除，以完全匹配 tags 参数定义的标签。 如果未设置 tags 参数，则标签不会被修改，即使 purge_tags=True 也是如此。 以 aws: 开头的标签键由 Amazon 保留，不能修改。因此，为了 purge_tags 参数的目的，它们将被忽略。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。 选项 false true ← (默认)
region 别名: aws_region, ec2_region 字符串	要使用的 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 之后的版本中删除。
role_arn 字符串	EKS 集群使用的 IAM 角色的 ARN。 当 state=present 时为必需项。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
selectors list / elements=dictionary	要在 fargate 配置文件中使用的选择器列表。 当 state=present 时为必需项。
labels 字典	fargate 配置文件中使用的标签字典。 默认值: {}
namespace 字符串	fargate 配置文件中使用的命名空间。
session_token 别名: aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭证的 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 版本中添加，参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
state 字符串	创建或删除 Fargate 配置文件。 选项 "absent" "present" ← (默认)
subnets list / elements=string	Kubernetes 集群的子网 ID 列表。 当 state=present 时为必需项。
tags 别名：resource_tags 字典	表示要应用于资源的标签的字典。 如果未设置 tags 参数，则标签不会被修改。
validate_certs 布尔值	当设置为 false 时，与 AWS API 通信时将不验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑改为设置 aws_ca_bundle。 选项 false true ← (默认)
wait 布尔值	指定模块是否在继续操作之前等待配置文件的创建或删除。 选项 false ← (默认) true
wait_timeout 整数	等待集群变为活动状态的持续时间（以秒为单位）。默认为 1200 秒（20 分钟）。 默认值: 1200

注释

注意

• 注意: 对于模块，环境变量和配置文件是从 Ansible ‘主机’ 上下文而不是 ‘控制器’ 上下文读取的。因此，可能需要将文件显式复制到 ‘主机’。对于查找和连接插件，环境变量和配置文件是从 Ansible ‘控制器’ 上下文而不是 ‘主机’ 上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible ‘主机’ 上下文（通常是 ~/.aws/credentials）中的配置文件读取凭证和其他设置（例如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create an EKS Fargate Profile
  community.aws.eks_fargate_profile:
    name: test_fargate
    cluster_name: test_cluster
    role_arn: my_eks_role
    subnets:
      - subnet-aaaa1111
    selectors:
      - namespace: nm-test
        labels:
          - label1: test
    state: present
    wait: true

- name: Remove an EKS Fargate Profile
  community.aws.eks_fargate_profile:
    name: test_fargate
    cluster_name: test_cluster
    wait: true
    state: absent

返回值

通用返回值在此处记录 此处，以下是此模块独有的字段

键	描述
cluster_name 字符串	EKS 集群的名称。 返回值: 当状态为 present 时 示例: "test-cluster"
created_at 字符串	Fargate 配置文件的创建日期和时间。 返回值: 当状态为 present 时 示例: "2022-01-18T20:00:00.111000+00:00"
fargate_profile_arn 字符串	Fargate 配置文件的 ARN。 返回值: 当状态为 present 时 示例: "arn:aws:eks:us-east-1:1231231123:safd"
fargate_profile_name 字符串	Fargate 配置文件的名称。 返回值: 当状态为 present 时 示例: "test_profile"
pod_execution_role_arn 字符串	Fargate 配置文件使用的 IAM 角色的 ARN。 返回值: 当状态为 present 时 示例: "arn:aws:eks:us-east-1:1231231123:role/asdf"
selectors complex	选择器配置。 返回值: 当状态为 present 时
labels list / elements=string	配置文件中使用的 Kubernetes 标签列表。 返回值: 当状态为 present 时 示例: [{"label1": "test1"}, {"label2": "test2"}]
namespace 字符串	配置文件中使用的 Kubernetes 命名空间的名称。 返回值: 当状态为 present 时 示例: "nm-test"
status 字符串	EKS Fargate 配置文件的状态。 返回值: 当状态为 present 时 示例: "['CREATING', 'ACTIVE']"
subnets list / elements=string	Fargate 配置文件中使用的子网列表。 返回值: 当状态为 present 时 示例: ["subnet-qwerty123", "subnet-asdfg456"]
tags 字典	资源标签的字典。 返回值: 当状态为 present 时 示例: {"env": "test", "foo": "bar"}

作者

• Tiago Jarra (@tjarra)

集合链接

• 问题跟踪器
• 仓库（源代码）
• 通信