[ aws . eks ]

create-nodegroup

Description

Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Launch template support .

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS-optimized Amazon Linux 2 AMI. For more information, see Managed Node Groups in the Amazon EKS User Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-nodegroup
--cluster-name <value>
--nodegroup-name <value>
[--scaling-config <value>]
[--disk-size <value>]
--subnets <value>
[--instance-types <value>]
[--ami-type <value>]
[--remote-access <value>]
--node-role <value>
[--labels <value>]
[--tags <value>]
[--client-request-token <value>]
[--launch-template <value>]
[--release-version <value>]
[--kubernetes-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--cluster-name (string)

The name of the cluster to create the node group in.

--nodegroup-name (string)

The unique name to give your node group.

--scaling-config (structure)

The scaling configuration details for the Auto Scaling group that is created for your node group.

minSize -> (integer)

The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.

maxSize -> (integer)

The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.

desiredSize -> (integer)

The current number of worker nodes that the managed node group should maintain.

Shorthand Syntax:

minSize=integer,maxSize=integer,desiredSize=integer

JSON Syntax:

{
  "minSize": integer,
  "maxSize": integer,
  "desiredSize": integer
}

--disk-size (integer)

The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB. If you specify launchTemplate , then don’t specify diskSize , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

--subnets (list)

The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared , where CLUSTER_NAME is replaced with the name of your cluster. If you specify launchTemplate , then don’t specify ` SubnetId https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html`__ in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

(string)

Syntax:

"string" "string" ...

--instance-types (list)

The instance type to use for your node group. You can specify a single instance type for a node group. The default value for instanceTypes is t3.medium . If you choose a GPU instance type, be sure to specify AL2_x86_64_GPU with the amiType parameter. If you specify launchTemplate , then don’t specify instanceTypes , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

(string)

Syntax:

"string" "string" ...

--ami-type (string)

The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI. If you specify launchTemplate , and your launch template uses a custom AMI, then don’t specify amiType , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

Possible values:

  • AL2_x86_64

  • AL2_x86_64_GPU

  • AL2_ARM_64

--remote-access (structure)

The remote access (SSH) configuration to use with your node group. If you specify launchTemplate , then don’t specify remoteAccess , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

ec2SshKey -> (string)

The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances .

sourceSecurityGroups -> (list)

The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .

(string)

Shorthand Syntax:

ec2SshKey=string,sourceSecurityGroups=string,string

JSON Syntax:

{
  "ec2SshKey": "string",
  "sourceSecurityGroups": ["string", ...]
}

--node-role (string)

The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM Role in the * Amazon EKS User Guide * . If you specify launchTemplate , then don’t specify ` IamInstanceProfile https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html`__ in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

--labels (map)

The Kubernetes labels to be applied to the nodes in the node group when they are created.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--tags (map)

The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--client-request-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

--launch-template (structure)

An object representing a node group’s launch template specification. If specified, then do not specify instanceTypes , diskSize , or remoteAccess . If specified, make sure that the launch template meets the requirements in launchTemplateSpecification .

name -> (string)

The name of the launch template.

version -> (string)

The version of the launch template to use. If no version is specified, then the template’s default version is used.

id -> (string)

The ID of the launch template.

Shorthand Syntax:

name=string,version=string,id=string

JSON Syntax:

{
  "name": "string",
  "version": "string",
  "id": "string"
}

--release-version (string)

The AMI version of the Amazon EKS-optimized AMI to use with your node group. By default, the latest available AMI version for the node group’s current Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux AMI Versions in the Amazon EKS User Guide . If you specify launchTemplate , and your launch template uses a custom AMI, then don’t specify releaseVersion , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

--kubernetes-version (string)

The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate , and your launch template uses a custom AMI, then don’t specify version , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

nodegroup -> (structure)

The full description of your new node group.

nodegroupName -> (string)

The name associated with an Amazon EKS managed node group.

nodegroupArn -> (string)

The Amazon Resource Name (ARN) associated with the managed node group.

clusterName -> (string)

The name of the cluster that the managed node group resides in.

version -> (string)

The Kubernetes version of the managed node group.

releaseVersion -> (string)

If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren’t deployed using a launch template, this is the version of the Amazon EKS-optimized AMI that the node group was deployed with.

createdAt -> (timestamp)

The Unix epoch timestamp in seconds for when the managed node group was created.

modifiedAt -> (timestamp)

The Unix epoch timestamp in seconds for when the managed node group was last modified.

status -> (string)

The current status of the managed node group.

scalingConfig -> (structure)

The scaling configuration details for the Auto Scaling group that is associated with your node group.

minSize -> (integer)

The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.

maxSize -> (integer)

The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.

desiredSize -> (integer)

The current number of worker nodes that the managed node group should maintain.

instanceTypes -> (list)

If the node group wasn’t deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then instanceTypes is null .

(string)

subnets -> (list)

The subnets that were specified for the Auto Scaling group that is associated with your node group.

(string)

remoteAccess -> (structure)

If the node group wasn’t deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then remoteAccess is null .

ec2SshKey -> (string)

The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux Instances .

sourceSecurityGroups -> (list)

The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .

(string)

amiType -> (string)

If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM . For node groups that weren’t deployed using a launch template, this is the AMI type that was specified in the node group configuration.

nodeRole -> (string)

The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies.

labels -> (map)

The Kubernetes labels applied to the nodes in the node group.

Note

Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.

key -> (string)

value -> (string)

resources -> (structure)

The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

autoScalingGroups -> (list)

The Auto Scaling groups associated with the node group.

(structure)

An Auto Scaling group that is associated with an Amazon EKS managed node group.

name -> (string)

The name of the Auto Scaling group associated with an Amazon EKS managed node group.

remoteAccessSecurityGroup -> (string)

The remote access security group associated with the node group. This security group controls SSH access to the worker nodes.

diskSize -> (integer)

If the node group wasn’t deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then diskSize is null .

health -> (structure)

The health status of the node group. If there are issues with your node group’s health, they are listed here.

issues -> (list)

Any issues that are associated with the node group.

(structure)

An object representing an issue with an Amazon EKS resource.

code -> (string)

A brief description of the error.

  • AutoScalingGroupNotFound : We couldn’t find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.

  • Ec2SecurityGroupNotFound : We couldn’t find the cluster security group for the cluster. You must recreate your cluster.

  • Ec2SecurityGroupDeletionFailure : We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.

  • Ec2LaunchTemplateNotFound : We couldn’t find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.

  • Ec2LaunchTemplateVersionMismatch : The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.

  • Ec2SubnetInvalidConfiguration : One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the auto-assign public IP address setting for the subnet. See Modifying the public IPv4 addressing attribute for your subnet in the Amazon VPC User Guide.

  • IamInstanceProfileNotFound : We couldn’t find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.

  • IamNodeRoleNotFound : We couldn’t find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.

  • AsgInstanceLaunchFailures : Your Auto Scaling group is experiencing failures while attempting to launch instances.

  • NodeCreationFailure : Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient worker node IAM role permissions or lack of outbound internet access for the nodes.

  • InstanceLimitExceeded : Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.

  • InsufficientFreeAddresses : One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.

  • AccessDenied : Amazon EKS or one or more of your managed nodes is unable to communicate with your cluster API server.

  • InternalFailure : These errors are usually caused by an Amazon EKS server-side issue.

message -> (string)

The error message associated with the issue.

resourceIds -> (list)

The AWS resources that are afflicted by this issue.

(string)

launchTemplate -> (structure)

If a launch template was used to create the node group, then this is the launch template that was used.

name -> (string)

The name of the launch template.

version -> (string)

The version of the launch template to use. If no version is specified, then the template’s default version is used.

id -> (string)

The ID of the launch template.

tags -> (map)

The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

key -> (string)

value -> (string)