EC2NodeClass is the Schema for the EC2NodeClass API
Last changed in Karpenter v0.35.9
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
EC2NodeClassSpec is the top level specification for the AWS Karpenter Provider. This will contain configuration necessary to launch instances in AWS.
AMIFamily dictates the UserData format and default BlockDeviceMappings used when generating launch templates. This field is optional when using an alias amiSelectorTerm, and the value will be inferred from the alias' family. When an alias is specified, this field may only be set to its corresponding family or 'Custom'. If no alias is specified, this field is required. NOTE: We ignore the AMIFamily for hashing here because we hash the AMIFamily dynamically by using the alias using the AMIFamily() helper function
AMISelectorTerms is a list of or ami selector terms. The terms are ORed.
Alias specifies which EKS optimized AMI to select. Each alias consists of a family and an AMI version, specified as "family@version". Valid families include: al2, al2023, bottlerocket, windows2019, and windows2022. The version can either be pinned to a specific AMI release, with that AMIs version format (ex: "al2023@v20240625" or "bottlerocket@v1.10.0"). The version can also be set to "latest" for any family. Setting the version to latest will result in drift when a new AMI is released. This is **not** recommended for production environments. Note: The Windows families do **not** support version pinning, and only latest may be used.
ID is the ami id in EC2
Name is the ami name in EC2. This value is the name field, which is different from the name tag.
Owner is the owner for the ami. You can specify a combination of AWS account IDs, "self", "amazon", and "aws-marketplace"
Tags is a map of key/value tags used to select subnets Specifying '*' for a value selects all values for a given tag key.
AssociatePublicIPAddress controls if public IP addresses are assigned to instances that are launched with the nodeclass.
BlockDeviceMappings to be applied to provisioned nodes.
The device name (for example, /dev/sdh or xvdh).
EBS contains parameters used to automatically set up EBS volumes when an instance is launched.
DeleteOnTermination indicates whether the EBS volume is deleted on instance termination.
Encrypted indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
IOPS is the number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: * gp3: 3,000-16,000 IOPS * io1: 100-64,000 IOPS * io2: 100-64,000 IOPS For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). Other instance families guarantee performance up to 32,000 IOPS. This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.
KMSKeyID (ARN) of the symmetric Key Management Service (KMS) CMK used for encryption.
SnapshotID is the ID of an EBS snapshot
Throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s. Valid Range: Minimum value of 125. Maximum value of 1000.
VolumeSize in `Gi`, `G`, `Ti`, or `T`. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type: * gp2 and gp3: 1-16,384 * io1 and io2: 4-16,384 * st1 and sc1: 125-16,384 * standard: 1-1,024
VolumeType of the block device. For more information, see Amazon EBS volume types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the Amazon Elastic Compute Cloud User Guide.
RootVolume is a flag indicating if this device is mounted as kubelet root dir. You can configure at most one root volume in BlockDeviceMappings.
Context is a Reserved field in EC2 APIs https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html
DetailedMonitoring controls if detailed monitoring is enabled for instances that are launched
InstanceProfile is the AWS entity that instances use. This field is mutually exclusive from role. The instance profile should already have a role assigned to it that Karpenter has PassRole permission on for instance launch using this instanceProfile to succeed.
InstanceStorePolicy specifies how to handle instance-store disks.
Kubelet defines args to be used when configuring kubelet on provisioned nodes. They are a subset of the upstream types, recognizing not all options may be supported. Wherever possible, the types and names should reflect the upstream kubelet types.
clusterDNS is a list of IP addresses for the cluster DNS server. Note that not all providers may use all addresses.
CPUCFSQuota enables CPU CFS quota enforcement for containers that specify CPU limits.
EvictionHard is the map of signal names to quantities that define hard eviction thresholds
EvictionMaxPodGracePeriod is the maximum allowed grace period (in seconds) to use when terminating pods in response to soft eviction thresholds being met.
EvictionSoft is the map of signal names to quantities that define soft eviction thresholds
EvictionSoftGracePeriod is the map of signal names to quantities that define grace periods for each eviction signal
ImageGCHighThresholdPercent is the percent of disk usage after which image garbage collection is always run. The percent is calculated by dividing this field value by 100, so this field must be between 0 and 100, inclusive. When specified, the value must be greater than ImageGCLowThresholdPercent.
ImageGCLowThresholdPercent is the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated by dividing this field value by 100, so the field value must be between 0 and 100, inclusive. When specified, the value must be less than imageGCHighThresholdPercent
KubeReserved contains resources reserved for Kubernetes system components.
MaxPods is an override for the maximum number of pods that can run on a worker node instance.
PodsPerCore is an override for the number of pods that can run on a worker node instance based on the number of cpu cores. This value cannot exceed MaxPods, so, if MaxPods is a lower value, that value will be used.
SystemReserved contains resources reserved for OS system daemons and kernel memory.
MetadataOptions for the generated launch template of provisioned nodes. This specifies the exposure of the Instance Metadata Service to provisioned EC2 nodes. For more information, see Instance Metadata and User Data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the Amazon Elastic Compute Cloud User Guide. Refer to recommended, security best practices (https://aws.github.io/aws-eks-best-practices/security/docs/iam/#restrict-access-to-the-instance-profile-assigned-to-the-worker-node) for limiting exposure of Instance Metadata and User Data to pods. If omitted, defaults to httpEndpoint enabled, with httpProtocolIPv6 disabled, with httpPutResponseLimit of 1, and with httpTokens required.
HTTPEndpoint enables or disables the HTTP metadata endpoint on provisioned nodes. If metadata options is non-nil, but this parameter is not specified, the default state is "enabled". If you specify a value of "disabled", instance metadata will not be accessible on the node.
HTTPProtocolIPv6 enables or disables the IPv6 endpoint for the instance metadata service on provisioned nodes. If metadata options is non-nil, but this parameter is not specified, the default state is "disabled".
HTTPPutResponseHopLimit is the desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Possible values are integers from 1 to 64. If metadata options is non-nil, but this parameter is not specified, the default value is 1.
HTTPTokens determines the state of token usage for instance metadata requests. If metadata options is non-nil, but this parameter is not specified, the default state is "required". If the state is optional, one can choose to retrieve instance metadata with or without a signed token header on the request. If one retrieves the IAM role credentials without a token, the version 1.0 role credentials are returned. If one retrieves the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned. If the state is "required", one must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.
Role is the AWS identity that nodes use. This field is immutable. This field is mutually exclusive from instanceProfile. Marking this field as immutable avoids concerns around terminating managed instance profiles from running instances. This field may be made mutable in the future, assuming the correct garbage collection and drift handling is implemented for the old instance profiles on an update.
SecurityGroupSelectorTerms is a list of or security group selector terms. The terms are ORed.
ID is the security group id in EC2
Name is the security group name in EC2. This value is the name field, which is different from the name tag.
Tags is a map of key/value tags used to select subnets Specifying '*' for a value selects all values for a given tag key.
SubnetSelectorTerms is a list of or subnet selector terms. The terms are ORed.
ID is the subnet id in EC2
Tags is a map of key/value tags used to select subnets Specifying '*' for a value selects all values for a given tag key.
Tags to be applied on ec2 resources like instances and launch templates.
UserData to be applied to the provisioned nodes. It must be in the appropriate format based on the AMIFamily in use. Karpenter will merge certain fields into this UserData to ensure nodes are being provisioned with the correct configuration.
EC2NodeClassStatus contains the resolved state of the EC2NodeClass
AMI contains the current AMI values that are available to the cluster under the AMI selectors.
ID of the AMI
Name of the AMI
Requirements of the AMI to be utilized on an instance type
The label key that the selector applies to.
Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.
Conditions contains signals for health and readiness
lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message is a human readable message indicating details about the transition. This may be an empty string.
observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
status of the condition, one of True, False, Unknown.
type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
InstanceProfile contains the resolved instance profile for the role
SecurityGroups contains the current Security Groups values that are available to the cluster under the SecurityGroups selectors.
ID of the security group
Name of the security group
Subnets contains the current Subnet values that are available to the cluster under the subnet selectors.
ID of the subnet
The associated availability zone
The associated availability zone ID
Source: karpenter.k8s.aws_ec2nodeclasses.yaml
Changes to EC2NodeClass (karpenter.k8s.aws/v1) in each Karpenter version, compared to the version before it.
6 properties have changed the description
Released · View EC2NodeClass in v0.35.9
6 properties have changed the description
Released · View EC2NodeClass in v0.34.10
6 properties have changed the description
Released · View EC2NodeClass in v0.33.9
EC2NodeClass was first seen on this version of Karpenter
Released · View EC2NodeClass in v0.33.6
A ready-to-use manifest of EC2NodeClass to start from.
apiVersion: karpenter.k8s.aws/v1 kind: EC2NodeClass metadata: name: private spec: metadataOptions: # Set the hop limit to 2 to allow containers to contact the Instance Metadata # Service (IMDS) https://github.com/kubernetes-sigs/karpenter/issues/1769 httpPutResponseHopLimit: 2 blockDeviceMappings: # Use encrypted, gp3, 50Gi root volumes - deviceName: /dev/xvda ebs: volumeSize: 50Gi volumeType: gp3 encrypted: true # Required: Use an specific Amazon Linux 2023 AMI release compatible with the instance type # https://github.com/awslabs/amazon-eks-ami/releases amiFamily: AL2023 amiSelectorTerms: - alias: al2023@v20250317 # IAM role name to use as the node role role: KarpenterNode # Don't associate a public IP address with the node, even if the subnet defaults to doing so associatePublicIPAddress: false subnetSelectorTerms: # Required: Launch nodes in subnets with the following tags - tags: karpenter.sh/discovery: cluster-private karpenter.sh/discovery/private: "true" securityGroupSelectorTerms: # Required: Launch nodes in security groups with the following tags - tags: karpenter.sh/discovery: cluster-worke tags: # Propagate AWS tags to the EC2 instances launched using this class karpenter.sh/discovery: cluster-private
kubespec.dev