NodePool is the Schema for the NodePools API
Last changed in Karpenter v0.32.2
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
NodePoolSpec is the top level provisioner specification. Provisioners launch nodes in response to pods that are unschedulable. A single provisioner is capable of managing a diverse set of nodes. Node properties are determined from a combination of provisioner and pod scheduling constraints.
Disruption contains the parameters that relate to Karpenter's disruption logic
ConsolidateAfter is the duration the controller will wait before attempting to terminate nodes that are underutilized. Refer to ConsolidationPolicy for how underutilization is considered.
ConsolidationPolicy describes which nodes Karpenter can disrupt through its consolidation algorithm. This policy defaults to "WhenUnderutilized" if not specified
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.
Limits define a set of bounds for provisioning capacity.
Template contains the template of possibilities for the provisioning logic to launch a NodeClaim with. NodeClaims launched from this NodePool will often be further constrained than the template specifies.
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
NodeClaimSpec describes the desired state of the NodeClaim
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.
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.
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.
Weight is the priority given to the provisioner during scheduling. A higher numerical weight indicates that this provisioner will be ordered ahead of other provisioners with lower weights. A provisioner with no weight will be treated as if it is a provisioner with a weight of 0.
NodePoolStatus defines the observed state of NodePool
Resources is the list of resources that have been provisioned.
Source: karpenter.sh_nodepools.yaml
Changes to NodePool (karpenter.sh/v1beta1) in each Karpenter version, compared to the version before it.
2 properties are now required
Released · View NodePool in v0.32.2
1 property has been added
4 properties have been removed
2 properties have changed the description
Released · View NodePool in v0.32.0
7 properties have been added
2 properties have been removed
1 property is now required
The description of NodePool has changed
Released · View NodePool in v0.31.0
NodePool was first seen on this version of Karpenter
Released · View NodePool in v0.30.0
No examples of NodePool yet. Contribute one on GitHub.
kubespec.dev