v1alpha5

package
v0.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 19, 2022 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

+k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=karpenter.sh

Index

Constants

View Source 
const (
	// Active is a condition implemented by all resources. It indicates that the
	// controller is able to take actions: it's correctly configured, can make
	// necessary API calls, and isn't disabled.
	Active apis.ConditionType = "Active"
)

Variables

View Source 
var (
	ArchitectureAmd64    = "amd64"
	ArchitectureArm64    = "arm64"
	OperatingSystemLinux = "linux"

	// Karpenter specific domains and labels
	KarpenterLabelDomain = "karpenter.sh"

	ProvisionerNameLabelKey           = Group + "/provisioner-name"
	DoNotEvictPodAnnotationKey        = Group + "/do-not-evict"
	DoNotConsolidateNodeAnnotationKey = KarpenterLabelDomain + "/do-not-consolidate"
	EmptinessTimestampAnnotationKey   = Group + "/emptiness-timestamp"
	TerminationFinalizer              = Group + "/termination"

	LabelCapacityType    = KarpenterLabelDomain + "/capacity-type"
	LabelNodeInitialized = KarpenterLabelDomain + "/initialized"

	// RestrictedLabelDomains are either prohibited by the kubelet or reserved by karpenter
	RestrictedLabelDomains = sets.NewString(
		"kubernetes.io",
		"k8s.io",
		KarpenterLabelDomain,
	)

	// LabelDomainException are sub-domains of the RestrictedLabelDomains but allowed because
	// they are not used in a context where they may be passed as argument to kubelet.
	LabelDomainExceptions = sets.NewString(
		"kops.k8s.io",
		v1.LabelNamespaceSuffixNode,
	)

	// WellKnownLabels are labels that belong to the RestrictedLabelDomains but allowed.
	// Karpenter is aware of these labels, and they can be used to further narrow down
	// the range of the corresponding values by either provisioner or pods.
	WellKnownLabels = sets.NewString(
		ProvisionerNameLabelKey,
		v1.LabelTopologyZone,
		v1.LabelTopologyRegion,
		v1.LabelInstanceTypeStable,
		v1.LabelArchStable,
		v1.LabelOSStable,
		LabelCapacityType,
	)

	// RestrictedLabels are labels that should not be used
	// because they may interfere with the internal provisioning logic.
	RestrictedLabels = sets.NewString(
		EmptinessTimestampAnnotationKey,
		v1.LabelHostname,
	)

	// NormalizedLabels translate aliased concepts into the controller's
	// WellKnownLabels. Pod requirements are translated for compatibility.
	NormalizedLabels = map[string]string{
		v1.LabelFailureDomainBetaZone:   v1.LabelTopologyZone,
		"beta.kubernetes.io/arch":       v1.LabelArchStable,
		"beta.kubernetes.io/os":         v1.LabelOSStable,
		v1.LabelInstanceType:            v1.LabelInstanceTypeStable,
		v1.LabelFailureDomainBetaRegion: v1.LabelTopologyRegion,
	}
)
View Source 
var (
	SupportedNodeSelectorOps = sets.NewString(
		string(v1.NodeSelectorOpIn),
		string(v1.NodeSelectorOpNotIn),
		string(v1.NodeSelectorOpGt),
		string(v1.NodeSelectorOpLt),
		string(v1.NodeSelectorOpExists),
		string(v1.NodeSelectorOpDoesNotExist),
	)

	SupportedReservedResources = sets.NewString(
		v1.ResourceCPU.String(),
		v1.ResourceMemory.String(),
		v1.ResourceEphemeralStorage.String(),
		"pid",
	)

	SupportedEvictionSignals = sets.NewString(
		"memory.available",
		"nodefs.available",
		"nodefs.inodesFree",
		"imagefs.available",
		"imagefs.inodesFree",
		"pid.available",
	)
)
View Source 
var (
	DefaultHook  = func(ctx context.Context, provisoner *Provisioner) {}
	ValidateHook = func(ctx context.Context, provisoner *Provisioner) *apis.FieldError { return nil }
)
View Source 
var (
	Group              = "karpenter.sh"
	ExtensionsGroup    = "extensions." + Group
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: "v1alpha5"}
	SchemeBuilder      = runtime.NewSchemeBuilder(func(scheme *runtime.Scheme) error {
		scheme.AddKnownTypes(SchemeGroupVersion,
			&Provisioner{},
			&ProvisionerList{},
		)
		metav1.AddToGroupVersion(scheme, SchemeGroupVersion)
		return nil
	})
)

Functions

func IsRestrictedLabel added in v0.7.0 

func IsRestrictedLabel(key string) error

IsRestrictedLabel returns an error if the label is restricted.

func IsRestrictedNodeLabel added in v0.7.0 

func IsRestrictedNodeLabel(key string) bool

IsRestrictedNodeLabel returns true if a node label should not be injected by Karpenter. They are either known labels that will be injected by cloud providers, or label domain managed by other software (e.g., kops.k8s.io managed by kOps).

func ValidateRequirement added in v0.14.0 

func ValidateRequirement(requirement v1.NodeSelectorRequirement) error

Types

type Consolidation added in v0.15.0 

type Consolidation struct {
	// Enabled enables consolidation if it has been set
	Enabled *bool `json:"enabled,omitempty"`
}

func (*Consolidation) DeepCopy added in v0.15.0 

func (in *Consolidation) DeepCopy() *Consolidation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Consolidation.

func (*Consolidation) DeepCopyInto added in v0.15.0 

func (in *Consolidation) DeepCopyInto(out *Consolidation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type KubeletConfiguration added in v0.5.3 

type KubeletConfiguration struct {
	// clusterDNS is a list of IP addresses for the cluster DNS server.
	// Note that not all providers may use all addresses.
	//+optional
	ClusterDNS []string `json:"clusterDNS,omitempty"`
	// ContainerRuntime is the container runtime to be used with your worker nodes.
	// +optional
	ContainerRuntime *string `json:"containerRuntime,omitempty"`
	// MaxPods is an override for the maximum number of pods that can run on
	// a worker node instance.
	// +kubebuilder:validation:Minimum:=0
	// +optional
	MaxPods *int32 `json:"maxPods,omitempty"`
	// 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.
	// +kubebuilder:validation:Minimum:=0
	// +optional
	PodsPerCore *int32 `json:"podsPerCore,omitempty"`
	// SystemReserved contains resources reserved for OS system daemons and kernel memory.
	// +optional
	SystemReserved v1.ResourceList `json:"systemReserved,omitempty"`
	// KubeReserved contains resources reserved for Kubernetes system components.
	// +optional
	KubeReserved v1.ResourceList `json:"kubeReserved,omitempty"`
	// EvictionHard is the map of signal names to quantities that define hard eviction thresholds
	// +optional
	EvictionHard map[string]string `json:"evictionHard,omitempty"`
	// EvictionSoft is the map of signal names to quantities that define soft eviction thresholds
	// +optional
	EvictionSoft map[string]string `json:"evictionSoft,omitempty"`
	// EvictionSoftGracePeriod is the map of signal names to quantities that define grace periods for each eviction signal
	// +optional
	EvictionSoftGracePeriod map[string]metav1.Duration `json:"evictionSoftGracePeriod,omitempty"`
	// EvictionMaxPodGracePeriod is the maximum allowed grace period (in seconds) to use when terminating pods in
	// response to soft eviction thresholds being met.
	// +optional
	EvictionMaxPodGracePeriod *int32 `json:"evictionMaxPodGracePeriod,omitempty"`
}

KubeletConfiguration 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. https://pkg.go.dev/k8s.io/kubelet/config/v1beta1#KubeletConfiguration https://github.com/kubernetes/kubernetes/blob/9f82d81e55cafdedab619ea25cabf5d42736dacf/cmd/kubelet/app/options/options.go#L53

func (*KubeletConfiguration) DeepCopy added in v0.5.3 

func (in *KubeletConfiguration) DeepCopy() *KubeletConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeletConfiguration.

func (*KubeletConfiguration) DeepCopyInto added in v0.5.3 

func (in *KubeletConfiguration) DeepCopyInto(out *KubeletConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Limits 

type Limits struct {
	// Resources contains all the allocatable resources that Karpenter supports for limiting.
	Resources v1.ResourceList `json:"resources,omitempty"`
}

Limits define bounds on the resources being provisioned by Karpenter

func (*Limits) DeepCopy 

func (in *Limits) DeepCopy() *Limits

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Limits.

func (*Limits) DeepCopyInto 

func (in *Limits) DeepCopyInto(out *Limits)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Limits) ExceededBy 

func (l *Limits) ExceededBy(resources v1.ResourceList) error

type Provider added in v0.6.0 

type Provider = runtime.RawExtension

+kubebuilder:object:generate=false

type ProviderRef added in v0.11.0 

type ProviderRef struct {
	// Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
	Kind string `json:"kind,omitempty"`
	// Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
	Name string `json:"name,omitempty"`
	// API version of the referent
	// +optional
	APIVersion string `json:"apiVersion,omitempty"`
}

func (*ProviderRef) DeepCopy added in v0.11.0 

func (in *ProviderRef) DeepCopy() *ProviderRef

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderRef.

func (*ProviderRef) DeepCopyInto added in v0.11.0 

func (in *ProviderRef) DeepCopyInto(out *ProviderRef)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Provisioner 

type Provisioner struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ProvisionerSpec   `json:"spec,omitempty"`
	Status ProvisionerStatus `json:"status,omitempty"`
}

Provisioner is the Schema for the Provisioners API +kubebuilder:object:root=true +kubebuilder:resource:path=provisioners,scope=Cluster,categories=karpenter +kubebuilder:subresource:status

func (*Provisioner) DeepCopy 

func (in *Provisioner) DeepCopy() *Provisioner

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Provisioner.

func (*Provisioner) DeepCopyInto 

func (in *Provisioner) DeepCopyInto(out *Provisioner)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Provisioner) DeepCopyObject 

func (in *Provisioner) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Provisioner) GetConditions 

func (p *Provisioner) GetConditions() apis.Conditions

func (*Provisioner) SetConditions 

func (p *Provisioner) SetConditions(conditions apis.Conditions)

func (*Provisioner) SetDefaults 

func (p *Provisioner) SetDefaults(ctx context.Context)

SetDefaults for the provisioner

func (*Provisioner) StatusConditions 

func (p *Provisioner) StatusConditions() apis.ConditionManager

func (*Provisioner) Validate 

func (p *Provisioner) Validate(ctx context.Context) (errs *apis.FieldError)

type ProvisionerList 

type ProvisionerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Provisioner `json:"items"`
}

ProvisionerList contains a list of Provisioner +kubebuilder:object:root=true

func (*ProvisionerList) DeepCopy 

func (in *ProvisionerList) DeepCopy() *ProvisionerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProvisionerList.

func (*ProvisionerList) DeepCopyInto 

func (in *ProvisionerList) DeepCopyInto(out *ProvisionerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProvisionerList) DeepCopyObject 

func (in *ProvisionerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ProvisionerList) OrderByWeight added in v0.16.0 

func (pl *ProvisionerList) OrderByWeight()

OrderByWeight orders the provisioners in the ProvisionerList by their priority weight in-place

type ProvisionerSpec 

type ProvisionerSpec struct {
	// Labels are layered with Requirements and applied to every node.
	//+optional
	Labels map[string]string `json:"labels,omitempty"`
	// Taints will be applied to every node launched by the Provisioner. If
	// specified, the provisioner will not provision nodes for pods that do not
	// have matching tolerations. Additional taints will be created that match
	// pod tolerations on a per-node basis.
	// +optional
	Taints []v1.Taint `json:"taints,omitempty"`
	// 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.
	// +optional
	StartupTaints []v1.Taint `json:"startupTaints,omitempty"`
	// Requirements are layered with Labels and applied to every node.
	Requirements []v1.NodeSelectorRequirement `json:"requirements,omitempty"`
	// KubeletConfiguration are options passed to the kubelet when provisioning nodes
	//+optional
	KubeletConfiguration *KubeletConfiguration `json:"kubeletConfiguration,omitempty"`
	// Provider contains fields specific to your cloudprovider.
	// +kubebuilder:pruning:PreserveUnknownFields
	Provider *Provider `json:"provider,omitempty"`
	// ProviderRef is a reference to a dedicated CRD for the chosen provider, that holds
	// additional configuration options
	// +optional
	ProviderRef *ProviderRef `json:"providerRef,omitempty"`
	// TTLSecondsAfterEmpty is the number of seconds the controller will wait
	// before attempting to delete a node, measured from when the node is
	// detected to be empty. A Node is considered to be empty when it does not
	// have pods scheduled to it, excluding daemonsets.
	//
	// Termination due to no utilization is disabled if this field is not set.
	// +optional
	TTLSecondsAfterEmpty *int64 `json:"ttlSecondsAfterEmpty,omitempty"`
	// TTLSecondsUntilExpired is the number of seconds 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.
	//
	// Termination due to expiration is disabled if this field is not set.
	// +optional
	TTLSecondsUntilExpired *int64 `json:"ttlSecondsUntilExpired,omitempty"`
	// Limits define a set of bounds for provisioning capacity.
	Limits *Limits `json:"limits,omitempty"`
	// 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.
	// +kubebuilder:validation:Minimum:=1
	// +kubebuilder:validation:Maximum:=100
	// +optional
	Weight *int32 `json:"weight,omitempty"`
	// Consolidation are the consolidation parameters
	// +optional
	Consolidation *Consolidation `json:"consolidation,omitempty"`
}

ProvisionerSpec 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.

func (*ProvisionerSpec) DeepCopy 

func (in *ProvisionerSpec) DeepCopy() *ProvisionerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProvisionerSpec.

func (*ProvisionerSpec) DeepCopyInto 

func (in *ProvisionerSpec) DeepCopyInto(out *ProvisionerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProvisionerSpec) Validate added in v0.8.1 

func (s *ProvisionerSpec) Validate(ctx context.Context) (errs *apis.FieldError)

Validate the constraints

type ProvisionerStatus 

type ProvisionerStatus struct {
	// LastScaleTime is the last time the Provisioner scaled the number
	// of nodes
	// +optional
	// +kubebuilder:validation:Format="date-time"
	LastScaleTime *apis.VolatileTime `json:"lastScaleTime,omitempty"`

	// Conditions is the set of conditions required for this provisioner to scale
	// its target, and indicates whether or not those conditions are met.
	// +optional
	Conditions apis.Conditions `json:"conditions,omitempty"`

	// Resources is the list of resources that have been provisioned.
	Resources v1.ResourceList `json:"resources,omitempty"`
}

ProvisionerStatus defines the observed state of Provisioner

func (*ProvisionerStatus) DeepCopy 

func (in *ProvisionerStatus) DeepCopy() *ProvisionerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProvisionerStatus.

func (*ProvisionerStatus) DeepCopyInto 

func (in *ProvisionerStatus) DeepCopyInto(out *ProvisionerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.