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

注意

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

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

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

要在 playbook 中使用它,请指定: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_IDAWS_ACCESS_KEYEC2_ACCESS_KEY 环境变量,按优先级降序排列。

aws_access_keyprofile 选项是互斥的。

为了与 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 回调输出到 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_URLEC2_URL 环境变量,优先级依次降低。

ec2_urls3_url 别名已被弃用,将在 2024-12-01 之后的版本中删除。

EC2_URL 环境变量的支持已被弃用,将在 2024-12-01 之后的版本中删除。

name

string / required

EKS 集群的名称。

profile

别名: aws_profile

字符串

用于身份验证的已命名的 AWS 配置文件。

有关已命名配置文件的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

还可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_keyaws_secret_keysecurity_token 选项互斥。

region

别名: aws_region, ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全局服务,region 将被忽略。

还可以使用 AWS_REGIONEC2_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 secret access key。

有关访问令牌的更多信息,请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

还可以使用 AWS_SECRET_ACCESS_KEYAWS_SECRET_KEYEC2_SECRET_KEY 环境变量,优先级依次降低。

secret_keyprofile 选项互斥。

aws_secret_access_key 别名已在 5.1.0 版本中添加,以与 AWS botocore SDK 保持一致。

ec2_secret_key 别名已被弃用,将在 2024-12-01 之后的版本中删除。

EC2_SECRET_KEY 环境变量的支持已被弃用,将在 2024-12-01 之后的版本中删除。

security_groups

list / elements=string

安全组名称或 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_TOKENAWS_SECURITY_TOKENEC2_SECURITY_TOKEN 环境变量,优先级依次降低。

security_tokenprofile 选项互斥。

别名 aws_session_tokensession_token 在 3.2.0 版本中添加,参数在 6.0.0 版本中从 security_token 重命名为 session_token

security_tokenaws_security_tokenaccess_token 别名已被弃用,将在 2024-12-01 之后的版本中删除。

EC2_SECRET_KEYAWS_SECURITY_TOKEN 环境变量的支持已被弃用,将在 2024-12-01 之后的版本中删除。

state

字符串

EKS 集群的所需状态。

选择

  • "absent"

  • "present" ← (默认)

subnets

list / elements=string

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

integer

等待集群变为活动状态的持续时间(以秒为单位)。默认为 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

返回值

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

Key

描述

arn

字符串

EKS 集群的 ARN

返回: 当状态为 present 时

示例: "arn:aws:eks:us-west-2:123456789012:cluster/my-eks-cluster"

certificate_authority

complex

包含集群证书颁发机构数据的字典

返回: 创建后

data

字符串

集群的 Base-64 编码的证书颁发机构数据

返回: 当集群已创建并处于活动状态时

created_at

字符串

集群创建日期和时间

返回: 当状态为 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 集群名称

返回: 当状态为 present 时

示例: "my-eks-cluster"

resources_vpc_config

complex

集群的 VPC 配置

返回: 当状态为 present 时

security_group_ids

list / elements=string

安全组 ID 列表

返回: 始终

示例: ["sg-abcd1234", "sg-aaaa1111"]

subnet_ids

list / elements=string

子网 ID 列表

返回: 始终

示例: ["subnet-abcdef12", "subnet-345678ab", "subnet-cdef1234"]

vpc_id

字符串

VPC ID

返回: 始终

示例: "vpc-a1b2c3d4"

role_arn

字符串

集群使用的 IAM 角色的 ARN

返回: 当状态为 present 时

示例: "arn:aws:iam::123456789012:role/eks_cluster_role"

status

字符串

EKS 集群的状态

返回: 当状态为 present 时

示例: "['CREATING', 'ACTIVE']"

version

字符串

集群的 Kubernetes 版本

返回: 当状态为 present 时

示例: "1.10"

作者

  • Will Thames (@willthames)