community.aws.eks_cluster 模块 – 管理弹性 Kubernetes 服务 (EKS) 集群

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：community.aws.eks_cluster。

community.aws 1.0.0 中的新增功能

概要

• 管理弹性 Kubernetes 服务 (EKS) 集群。

• 在 5.0.0 版本之前，此模块称为 community.aws.aws_eks_cluster。用法没有改变。

别名：aws_eks_cluster

要求

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

• 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 botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 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。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到剧本期间进行的总列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 还可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的一个版本中移除。 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的一个版本中移除。
name 字符串 / 必需	EKS 集群的名称。
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 选项互斥。
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。
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之后的一个版本中移除。
security_groups 列表 / 元素=字符串	安全组名称或ID列表。
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选项互斥。 在3.2.0版本中添加了aws_session_token和session_token别名，并在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 字符串	EKS集群的期望状态。 选项 "absent" "present" ← (默认)
subnets 列表 / 元素=字符串	Kubernetes集群的子网ID列表。
tags 字典 在community.aws 5.3.0中添加	要添加到EKS集群的标签字典。
validate_certs 布尔值	设置为false时，将不会验证与AWS API通信的SSL证书。 强烈建议不要设置validate_certs=false，可以考虑改用aws_ca_bundle。 选项 false true ← (默认)
version 字符串	Kubernetes版本。 默认为latest。
wait 布尔值	指定模块是否在继续操作之前等待集群变为活动状态或被删除。根据AWS文档，这通常“需要不到10分钟”。 选项 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 cluster
  community.aws.eks_cluster:
    name: my_cluster
    version: 1.14
    role_arn: my_eks_role
    subnets:
      - subnet-aaaa1111
    security_groups:
      - my_eks_sg
      - sg-abcd1234
  register: caller_facts

- name: Remove an EKS cluster
  community.aws.eks_cluster:
    name: my_cluster
    wait: true
    state: absent

返回值

常见的返回值已在此处记录，以下是此模块独有的字段

键	描述
arn 字符串	EKS集群的ARN 返回：当state为present时 示例： "arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster"
certificate_authority 复杂类型	包含集群证书颁发机构数据的字典 返回：创建后
data 字符串	集群证书颁发机构数据的Base-64编码数据 返回：集群创建完毕且处于活动状态时
created_at 字符串	集群创建日期和时间 返回：当state为present时 示例： "2018-06-06T11:56:56.242000+00:00"
endpoint 字符串	Kubernetes API服务器端点 返回：集群创建完毕且处于活动状态时 示例： "https://API_SERVER_ENDPOINT.yl4.us-west-2.eks.amazonaws.com"
name 字符串	EKS集群名称 返回：当state为present时 示例： "my-eks-cluster"
resources_vpc_config 复杂类型	集群的VPC配置 返回：当state为present时
security_group_ids 列表 / 元素=字符串	安全组ID列表 返回：始终返回 示例： ["sg-abcd1234", "sg-aaaa1111"]
subnet_ids 列表 / 元素=字符串	子网ID列表 返回：始终返回 示例： ["subnet-abcdef12", "subnet-345678ab", "subnet-cdef1234"]
vpc_id 字符串	VPC ID 返回：始终返回 示例： "vpc-a1b2c3d4"
role_arn 字符串	集群使用的IAM角色的ARN 返回：当state为present时 示例： "arn:aws:iam::123456789012:role/eks_cluster_role"
status 字符串	EKS集群的状态 返回：当state为present时 示例： "['CREATING', 'ACTIVE']"
version 字符串	集群的Kubernetes版本 返回：当state为present时 示例： "1.10"

作者

• Will Thames (@willthames)

集合链接

• 问题追踪器
• 代码库 (源代码)
• 沟通