NodeClaim is the Schema for the NodeClaims API
Last changed in Karpenter v0.34.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
NodeClaimSpec describes the desired state of the NodeClaim
ExpireAfter is the duration the controller will wait before terminating a node, measured from when the node is created. This is useful to implement features like eventually consistent node upgrade, memory leak protection, and disruption testing.
NodeClassRef is a reference to an object that defines provider specific configuration
API version of the referent
Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
Requirements are layered with GetLabels and applied to every node.
The label key that the selector applies to.
This field is ALPHA and can be dropped or replaced at any time MinValues is the minimum number of unique values required to define the flexibility of the specific requirement.
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.
Resources models the resource requirements for the NodeClaim to launch
Requests describes the minimum required resources for the NodeClaim to launch
StartupTaints are taints that are applied to nodes upon startup which are expected to be removed automatically within a short period of time, typically by a DaemonSet that tolerates the taint. These are commonly used by daemonsets to allow initialization and enforce startup ordering. StartupTaints are ignored for provisioning purposes in that pods are not required to tolerate a StartupTaint in order to have nodes provisioned for them.
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
Required. The taint key to be applied to a node.
TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
The taint value corresponding to the taint key.
Taints will be applied to the NodeClaim's node.
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
Required. The taint key to be applied to a node.
TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
The taint value corresponding to the taint key.
TerminationGracePeriod is the maximum duration the controller will wait before forcefully deleting the pods on a node, measured from when deletion is first initiated. Warning: this feature takes precedence over a Pod's terminationGracePeriodSeconds value, and bypasses any blocked PDBs or the karpenter.sh/do-not-disrupt annotation. This field is intended to be used by cluster administrators to enforce that nodes can be cycled within a given time period. When set, drifted nodes will begin draining even if there are pods blocking eviction. Draining will respect PDBs and the do-not-disrupt annotation until the TGP is reached. Karpenter will preemptively delete pods so their terminationGracePeriodSeconds align with the node's terminationGracePeriod. If a pod would be terminated without being granted its full terminationGracePeriodSeconds prior to the node timeout, that pod will be deleted at T = node timeout - pod terminationGracePeriodSeconds. The feature can also be used to allow maximum time limits for long-running jobs which can delay node termination with preStop hooks. If left undefined, the controller will wait indefinitely for pods to be drained.
NodeClaimStatus defines the observed state of NodeClaim
Allocatable is the estimated allocatable capacity of the node
Capacity is the estimated full capacity of the node
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.
ImageID is an identifier for the image that runs on the node
LastPodEventTime is updated with the last time a pod was scheduled or removed from the node. A pod going terminal or terminating is also considered as removed.
NodeName is the name of the corresponding node object
ProviderID of the corresponding node object
Source: karpenter.sh_nodeclaims.yaml
Changes to NodeClaim (karpenter.sh/v1) in each Karpenter version, compared to the version before it.
2 properties have changed the description
Released · View NodeClaim in v0.34.9
2 properties have changed the description
Released · View NodeClaim in v0.33.8
NodeClaim was first seen on this version of Karpenter
Released · View NodeClaim in v0.33.6
A ready-to-use manifest of NodeClaim to start from.
apiVersion: karpenter.sh/v1 kind: NodeClaim metadata: annotations: compatibility.karpenter.k8s.aws/cluster-name-tagged: "true" karpenter.k8s.aws/ec2nodeclass-hash: "17027975244315209952" karpenter.k8s.aws/ec2nodeclass-hash-version: v4 karpenter.k8s.aws/tagged: "true" karpenter.sh/nodepool-hash: "7192598826009892108" karpenter.sh/nodepool-hash-version: v3 creationTimestamp: "2025-03-31T15:59:25Z" finalizers: - karpenter.sh/termination generateName: default- generation: 1 labels: karpenter.k8s.aws/ec2nodeclass: private karpenter.k8s.aws/instance-category: m karpenter.k8s.aws/instance-cpu: "2" karpenter.k8s.aws/instance-cpu-manufacturer: amd karpenter.k8s.aws/instance-cpu-sustained-clock-speed-mhz: "2500" karpenter.k8s.aws/instance-ebs-bandwidth: "2880" karpenter.k8s.aws/instance-encryption-in-transit-supported: "false" karpenter.k8s.aws/instance-family: m5a karpenter.k8s.aws/instance-generation: "5" karpenter.k8s.aws/instance-hypervisor: nitro karpenter.k8s.aws/instance-memory: "8192" karpenter.k8s.aws/instance-network-bandwidth: "750" karpenter.k8s.aws/instance-size: large karpenter.sh/capacity-type: on-demand karpenter.sh/nodepool: default kubernetes.io/arch: amd64 kubernetes.io/os: linux node.kubernetes.io/instance-type: m5a.large topology.k8s.aws/zone-id: use1-az2 topology.kubernetes.io/region: us-east-1 topology.kubernetes.io/zone: us-east-1b name: default-qmhg4 ownerReferences: - apiVersion: karpenter.sh/v1 blockOwnerDeletion: true kind: NodePool name: default uid: 1e1334cf-9696-406a-9a7f-e92780d6042b resourceVersion: "688079106" uid: e0d67077-3c60-4e1b-8c03-fe2a294485b5 spec: expireAfter: Never nodeClassRef: group: karpenter.k8s.aws kind: EC2NodeClass name: private requirements: - key: karpenter.sh/capacity-type operator: In values: - on-demand - key: topology.kubernetes.io/zone operator: In values: - us-east-1b - key: karpenter.k8s.aws/ec2nodeclass operator: In values: - private - key: node.kubernetes.io/instance-type operator: In values: - c3.xlarge - c4.xlarge - c5.xlarge - c5a.xlarge - c5ad.xlarge - c5d.xlarge - c5n.large - c5n.xlarge - c6a.xlarge - c6i.xlarge - c6id.xlarge - c6in.xlarge - c7a.xlarge - c7i-flex.xlarge - c7i.xlarge - m3.large - m4.large - m4.xlarge - m5.large - m5.xlarge - m5a.large - m5a.xlarge - m5ad.large - m5ad.xlarge - m5d.large - m5d.xlarge - m5dn.large - m5n.large - m5zn.large - m6a.large - m6a.xlarge - m6i.large - m6i.xlarge - m6id.large - m6idn.large - m6in.large - m7a.large - m7i-flex.large - m7i-flex.xlarge - m7i.large - m7i.xlarge - r3.large - r4.large - r5.large - r5a.large - r5a.xlarge - r5ad.large - r5b.large - r5d.large - r5dn.large - r5n.large - r6a.large - r6a.xlarge - r6i.large - r6id.large - r6idn.large - r6in.large - r7a.large - r7i.large - r7iz.large - key: kubernetes.io/os operator: In values: - linux - key: karpenter.k8s.aws/instance-category operator: In values: - c - m - r - key: kubernetes.io/arch operator: In values: - amd64 - key: karpenter.sh/nodepool operator: In values: - default - key: karpenter.k8s.aws/instance-generation operator: Gt values: - "2" resources: requests: cpu: 885m memory: 4288Mi pods: "13"