v1alpha5

package
v0.8.2 Latest Latest
Warning

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

 Go to latest Published: Apr 11, 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"
	LabelCapacityType    = KarpenterLabelDomain + "/capacity-type"

	// RestrictedLabelDomains are either prohibited by the kubelet or reserved by karpenter
	RestrictedLabelDomains = stringsets.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 = stringsets.NewString(
		"kops.k8s.io",
	)

	// 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 = stringsets.NewString(
		v1.LabelTopologyZone,
		v1.LabelInstanceTypeStable,
		v1.LabelArchStable,
		v1.LabelOSStable,
		LabelCapacityType,
	)

	// RestrictedLabels are labels that should not be used
	// because they may interfer the internall provisioning logic.
	RestrictedLabels = stringsets.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,
	}
	// IgnoredLables are not considered in scheduling decisions
	// and prevent validation errors when specified
	IgnoredLabels = stringsets.NewString(
		v1.LabelTopologyRegion,
	)
)
View Source 
var (
	SupportedNodeSelectorOps sets.String = sets.NewString(string(v1.NodeSelectorOpIn), string(v1.NodeSelectorOpNotIn), string(v1.NodeSelectorOpExists), string(v1.NodeSelectorOpDoesNotExist))
	SupportedProvisionerOps  sets.String = sets.NewString(string(v1.NodeSelectorOpIn), string(v1.NodeSelectorOpNotIn), string(v1.NodeSelectorOpExists))
)
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
	})
	ProvisionerNameLabelKey         = Group + "/provisioner-name"
	NotReadyTaintKey                = Group + "/not-ready"
	DoNotEvictPodAnnotationKey      = Group + "/do-not-evict"
	EmptinessTimestampAnnotationKey = Group + "/emptiness-timestamp"
	TerminationFinalizer            = Group + "/termination"
)

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

Types

type Constraints 

type Constraints 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 Taints `json:"taints,omitempty"`
	// Requirements are layered with Labels and applied to every node.
	Requirements Requirements `json:"requirements,inline,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"`
}

Constraints are applied to all nodes created by the provisioner.

func (*Constraints) DeepCopy 

func (in *Constraints) DeepCopy() *Constraints

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

func (*Constraints) DeepCopyInto 

func (in *Constraints) DeepCopyInto(out *Constraints)

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

func (*Constraints) ToNode added in v0.7.3 

func (c *Constraints) ToNode() *v1.Node

func (*Constraints) ValidatePod 

func (c *Constraints) ValidatePod(pod *v1.Pod) error

ValidatePod returns an error if the pod's requirements are not met by the constraints

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"`
}

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.

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

type ProvisionerSpec 

type ProvisionerSpec struct {
	// Constraints are applied to all nodes launched by this provisioner.
	Constraints `json:",inline"`
	// 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 underutilization 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"`
}

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.

type Requirements 

type Requirements struct {
	// Requirements are layered with Labels and applied to every node.
	Requirements []v1.NodeSelectorRequirement `json:"requirements,omitempty"`
	// contains filtered or unexported fields
}

Requirements are an alias type that wrap []v1.NodeSelectorRequirement and include an efficient set representation under the hood. Since its underlying types are slices and maps, this type should not be used as a pointer.

func NewLabelRequirements added in v0.6.1 

func NewLabelRequirements(labels map[string]string) Requirements

NewLabelRequirements constructs requirements from labels

func NewPodRequirements added in v0.6.1 

func NewPodRequirements(pod *v1.Pod) Requirements

NewPodRequirements constructs requirements from a pod

func NewRequirements added in v0.6.1 

func NewRequirements(requirements ...v1.NodeSelectorRequirement) Requirements

NewRequirements constructs requirements from NodeSelectorRequirements

func (Requirements) Add added in v0.5.4 

func (r Requirements) Add(requirements ...v1.NodeSelectorRequirement) Requirements

Add function returns a new Requirements object with new requirements inserted.

func (Requirements) Architectures 

func (r Requirements) Architectures() stringsets.String

func (Requirements) CapacityTypes 

func (r Requirements) CapacityTypes() stringsets.String

func (Requirements) Compatible added in v0.6.1 

func (r Requirements) Compatible(requirements Requirements) (errs error)

Compatible ensures the provided requirements can be met.

func (*Requirements) DeepCopy 

func (in *Requirements) DeepCopy() *Requirements

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

func (*Requirements) DeepCopyInto 

func (in *Requirements) DeepCopyInto(out *Requirements)

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

func (Requirements) Get added in v0.6.1 

func (r Requirements) Get(key string) sets.Set

func (Requirements) Has added in v0.7.3 

func (r Requirements) Has(key string) bool

func (Requirements) InstanceTypes 

func (r Requirements) InstanceTypes() stringsets.String

func (Requirements) Keys 

func (r Requirements) Keys() stringsets.String

Keys returns unique set of the label keys from the requirements

func (*Requirements) MarshalJSON added in v0.6.1 

func (r *Requirements) MarshalJSON() ([]byte, error)

func (Requirements) OperatingSystems added in v0.5.2 

func (r Requirements) OperatingSystems() stringsets.String

func (Requirements) String added in v0.8.0 

func (r Requirements) String() string

func (*Requirements) UnmarshalJSON added in v0.6.1 

func (r *Requirements) UnmarshalJSON(b []byte) error

func (Requirements) Validate added in v0.6.1 

func (r Requirements) Validate() (errs error)

Validate validates the feasibility of the requirements. Do not apply validation to requirements after merging with other requirements.

func (Requirements) Zones 

func (r Requirements) Zones() stringsets.String

type Taints 

type Taints []v1.Taint

Taints is a decorated alias type for []v1.Taint

func (Taints) DeepCopy 

func (in Taints) DeepCopy() Taints

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

func (Taints) DeepCopyInto 

func (in Taints) DeepCopyInto(out *Taints)

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

func (Taints) Has 

func (ts Taints) Has(taint v1.Taint) bool

Has returns true if taints has a taint for the given key and effect

func (Taints) HasKey added in v0.5.6 

func (ts Taints) HasKey(taintKey string) bool

HasKey returns true if taints has a taint for the given key

func (Taints) Tolerates 

func (ts Taints) Tolerates(pod *v1.Pod) (errs error)

Tolerates returns true if the pod tolerates all taints

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.