community.aws.eks_nodegroup 模块 – 管理 EKS 节点组模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install community.aws。

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

community.aws 5.3.0 中的新增功能

概要

• 管理 EKS 节点组。

参数

参数	注释
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 之后的版本中删除。
ami_type 字符串	节点组的 AMI 类型。 选项 "AL2_x86_64" "AL2_x86_64_GPU" "AL2_ARM_64" "CUSTOM" "BOTTLEROCKET_ARM_64" "BOTTLEROCKET_x86_64"
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。
capacity_type 字符串	节点组的容量类型。 选项 "ON_DEMAND" ← (默认) "SPOT"
cluster_name 字符串 / 必需	EKS 集群的名称。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间进行的唯一（而非总计）"resource:action" API 调用，将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出 playbook 期间进行的全部列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
disk_size 整数	节点组节点中的磁盘大小。如果指定 launch_template，则不要指定 disk_size，否则节点组部署将失败。
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 之后的版本中删除。
instance_types 列表 / 元素=字符串	指定节点组的实例类型。如果指定 launch_template，则不要指定 instance_types，否则节点组部署将失败。
labels 字典	在创建节点时应用于节点组中节点的 Kubernetes 标签。 默认： {}
launch_template 字典	表示节点组启动模板规范的对象。 如果指定，则不要指定 instanceTypes、diskSize 或 remoteAccess。
id 字符串	启动模板的 ID。
name 字符串	启动模板的名称。
version 字符串	要使用的启动模板的版本。 如果未指定版本，则使用模板的默认版本。
name 字符串 / 必需	EKS 节点组的名称。
node_role 字符串	EKS 集群节点组使用的 IAM 角色的 ARN。
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 布尔值	清除节点组中不存在的现有标签。 选项 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 之后的版本中删除。
release_version 字符串	要用于节点组的 Amazon EKS 优化 AMI 的 AMI 版本。
remote_access 字典	要用于节点组的远程访问 (SSH) 配置。如果指定 launch_template，则不要指定 remote_access，否则节点组部署将失败。
ec2_ssh_key 字符串	Amazon EC2 SSH 密钥，用于提供与托管节点组中节点的 SSH 通信访问。
source_sg 列表 / 元素=字符串	允许对节点进行 SSH 访问（端口 22）的安全组。
scaling_config 字典	为您的节点组创建的 Auto Scaling 组的扩展配置详细信息。 默认: {"desired_size": 1, "max_size": 2, "min_size": 1}
desired_size 整数	托管节点组应维护的当前节点数。
max_size 整数	托管节点组可以扩展到的最大节点数。
min_size 整数	托管节点组可以缩减到的最小节点数。
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 之后的版本中删除。
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 字符串	创建或删除节点组。 选项 "absent" "present" ← (默认)
subnets 列表 / 元素=字符串	Kubernetes 集群的子网 ID 列表。
tags 别名: resource_tags 字典	资源标签字典。
taints 列表 / 元素=字典	要应用于节点组中节点的 Kubernetes 污点。 默认: []
effect 字符串	污点的效果。 选项 "NO_SCHEDULE" "NO_EXECUTE" "PREFER_NO_SCHEDULE"
key 字符串	污点的键。
value 字符串	污点的值。
update_config 字典	节点组更新配置。 默认: {"max_unavailable": 1}
max_unavailable 整数	在版本更新期间，一次最多不可用的节点数。
max_unavailable_percentage 整数	在版本更新期间不可用的最大节点百分比。
validate_certs 布尔值	设置为 false 时，将不会验证用于与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)
wait 布尔值	指定模块是否等待配置文件创建或删除后再继续。 选项 false ← (默认) true
wait_timeout 整数	等待节点组变为活动状态的持续时间（以秒为单位）。默认为 1200 秒。 默认: 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 nodegroup
  community.aws.eks_nodegroup:
    name: test_nodegroup
    state: present
    cluster_name: test_cluster
    node_role: arn:aws:eks:us-east-1:1231231123:role/asdf
    subnets:
      - subnet-qwerty123
      - subnet-asdfg456
    scaling_config:
      min_size: 1
      max_size: 2
      desired_size: 1
    disk_size: 20
    instance_types: 't3.micro'
    ami_type: 'AL2_x86_64'
    labels:
      'teste': 'test'
    taints:
      - key: 'test'
        value: 'test'
        effect: 'NO_SCHEDULE'
    capacity_type: 'ON_DEMAND'

- name: Remove an EKS Nodegrop
  community.aws.eks_nodegroup:
    name: test_nodegroup
    cluster_name: test_cluster
    wait: true
    state: absent

返回值

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

Key	描述
ami_type 字符串	这是在节点组配置中指定的 AMI 类型。 返回: 当状态为 present 时 示例: "need_validate"
capacity_type 字符串	您的托管节点组的容量类型。 返回: 当状态为 present 时 示例: "need_validate"
cluster_name 字符串	EKS 集群的名称 返回: 当状态为 present 时 示例: "test_cluster"
created_at 字符串	节点组创建日期和时间。 返回: 当状态为 present 时 示例: "2022-01-18T20:00:00.111000+00:00"
diskSize 整数	这是节点组配置中的磁盘大小。 返回: 当状态为 present 时 示例: 20
health 字典	节点组的健康状态。 返回: 当状态为 present 时 示例: "need_validate"
instance_types 列表 / 元素=字符串	这是与节点组关联的实例类型。 返回: 当状态为 present 时 示例: ["need_validate"]
labels 字典	应用于节点组中节点的 Kubernetes 标签。 返回: 当状态为 present 时 示例: "need_validate"
launch_template 字典	如果使用启动模板创建节点组，则这是使用的启动模板。 返回: 当状态为 present 时 示例: "need_validate"
modified_at 字符串	节点组修改日期和时间。 返回: 当状态为 present 时 示例: "2022-01-18T20:00:00.111000+00:00"
node_role 字符串	节点组使用的 IAM 角色的 ARN。 返回: 当状态为 present 时 示例: "arn:aws:eks:us-east-1:1231231123:role/asdf"
nodegroup_arn 字符串	与托管节点组关联的 Amazon 资源名称 (ARN)。 返回: 当状态为 present 时 示例: "arn:aws:eks:us-east-1:1231231123:safd"
nodegroup_name 字符串	与 Amazon EKS 托管节点组关联的名称。 返回: 当状态为 present 时 示例: "test_cluster"
release_version 字符串	这是部署节点组的 Amazon EKS 优化 AMI 的版本。 返回: 当状态为 present 时 示例: "need_validate"
remote_access 字典	这是与节点组关联的远程访问配置。 返回: 当状态为 present 时 示例: "need_validate"
resources 复杂	与节点组关联的资源。 返回: 当状态为 present 时
autoScalingGroups 列表 / 元素=字典	与节点组关联的 Auto Scaling 组。 返回: 当状态为 present 时
remoteAccessSecurityGroup 字符串	与节点组关联的远程访问安全组。 返回: 当状态为 present 时
scaling_config 字典	与您的节点组关联的 Auto Scaling 组的扩展配置详细信息。 返回: 当状态为 present 时 示例: "need_validate"
status 字符串	EKS 节点组的状态。 返回: 当状态为 present 时 示例: "['CREATING', 'ACTIVE']"
subnets 列表 / 元素=字符串	Fargate Profile 中使用的子网列表。 返回: 当状态为 present 时 示例: ["subnet-qwerty123", "subnet-asdfg456"]
tags 字典	节点组标签。 返回: 当状态为 present 时 示例: {"foo": "bar"}
taints 列表 / 元素=字符串	在创建节点组时，将应用于节点组中节点的 Kubernetes 污点。 返回: 当状态为 present 时 示例: ["need_validate"]
update_config 字典	节点组更新配置。 返回: 当状态为 present 时
maxUnavailable 整数	在版本更新期间，一次最多不可用的节点数。 返回: 成功
maxUnavailablePercentage 整数	在版本更新期间不可用的最大节点百分比。 返回: 成功
version 字符串	托管节点组的 Kubernetes 版本。 返回: 当状态为 present 时 示例: "need_validate"

作者

• Tiago Jarra (@tjarra)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 交流