v1beta1

package
v0.0.0-...-30e57c9 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 6 Imported by: 3

Documentation

Overview

Package v1beta1 contains definitions of Provisioning Request related objects. +k8s:deepcopy-gen=package +k8s:defaulter-gen=TypeMeta +groupName=autoscaling.x-k8s.io

Package v1beta1 contains definitions of Provisioning Request related objects.

Package v1beta1 contains definitions of Provisioning Request related objects.

Index

Constants

View Source 
const (
	// GroupName represents the group name for ProvisioningRequest resources.
	GroupName = "autoscaling.x-k8s.io"
	// GroupVersion represents the group name for ProvisioningRequest resources.
	GroupVersion = "v1beta1"
)
View Source 
const (
	// Accepted indicates that the ProvisioningRequest was accepted by ClusterAutoscaler,
	// so ClusterAutoscaler will attempt to provision the nodes for it.
	Accepted string = "Accepted"
	// BookingExpired indicates that the ProvisioningRequest had Provisioned condition before
	// and capacity reservation time is expired.
	BookingExpired string = "BookingExpired"
	// CapacityRevoked indicates that requested resources are not longer valid.
	CapacityRevoked string = "CapacityRevoked"
	// Provisioned indicates that all of the requested resources were created
	// and registered in the cluster. CA will set this condition when the
	// VM creation finishes successfully.
	Provisioned string = "Provisioned"
	// Failed indicates that it is impossible to obtain resources to fulfill
	// this ProvisioningRequest.
	// Condition Reason and Message will contain more details about what failed.
	Failed string = "Failed"
)

The following constants list all currently available Conditions Type values. See: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Condition

View Source 
const (
	// ProvisioningClassCheckCapacity denotes that CA will check if current cluster state can fulfill this request,
	// and reserve the capacity for a specified time.
	ProvisioningClassCheckCapacity string = "check-capacity.autoscaling.x-k8s.io"
	// ProvisioningClassBestEffortAtomicScaleUp denotes that CA try to provision the capacity
	// in an atomic manner.
	ProvisioningClassBestEffortAtomicScaleUp string = "best-effort-atomic-scale-up.autoscaling.x-k8s.io"
	// ProvisioningRequestPodAnnotationKey is a key used to annotate pods consuming provisioning request.
	ProvisioningRequestPodAnnotationKey = "autoscaling.x-k8s.io/consume-provisioning-request"
	// ProvisioningClassPodAnnotationKey is a key used to add annotation about Provisioning Class
	ProvisioningClassPodAnnotationKey = "autoscaling.x-k8s.io/provisioning-class-name"
)

Variables

View Source 
var (
	// SchemeBuilder is the scheme builder for ProvisioningRequest.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is the func that applies all the stored functions to the scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: GroupVersion}

SchemeGroupVersion represents the group version object for ProvisioningRequest scheme.

Functions

func RegisterDefaults 

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Detail 

type Detail string

Detail is limited to 32768 characters. +kubebuilder:validation:MaxLength=32768

type Parameter 

type Parameter string

Parameter is limited to 255 characters. +kubebuilder:validation:MaxLength=255

type PodSet 

type PodSet struct {
	// PodTemplateRef is a reference to a PodTemplate object that is representing pods
	// that will consume this reservation (must be within the same namespace).
	// Users need to make sure that the  fields relevant to scheduler (e.g. node selector tolerations)
	// are consistent between this template and actual pods consuming the Provisioning Request.
	//
	// +kubebuilder:validation:Required
	PodTemplateRef Reference `json:"podTemplateRef"`
	// Count contains the number of pods that will be created with a given
	// template.
	//
	// +kubebuilder:validation:Minimum=1
	Count int32 `json:"count"`
}

PodSet represents one group of pods for Provisioning Request to provision capacity.

func (*PodSet) DeepCopy 

func (in *PodSet) DeepCopy() *PodSet

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

func (*PodSet) DeepCopyInto 

func (in *PodSet) DeepCopyInto(out *PodSet)

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

type ProvisioningRequest 

type ProvisioningRequest struct {
	metav1.TypeMeta `json:",inline"`
	// Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	//
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// Spec contains specification of the ProvisioningRequest object.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status.
	// The spec is immutable, to make changes to the request users are expected to delete an existing
	// and create a new object with the corrected fields.
	//
	// +kubebuilder:validation:Required
	Spec ProvisioningRequestSpec `json:"spec"`
	// Status of the ProvisioningRequest. CA constantly reconciles this field.
	//
	// +optional
	Status ProvisioningRequestStatus `json:"status,omitempty"`
}

ProvisioningRequest is a way to express additional capacity that we would like to provision in the cluster. Cluster Autoscaler can use this information in its calculations and signal if the capacity is available in the cluster or actively add capacity if needed.

+kubebuilder:subresource:status +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ProvisioningRequest) DeepCopy 

func (in *ProvisioningRequest) DeepCopy() *ProvisioningRequest

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

func (*ProvisioningRequest) DeepCopyInto 

func (in *ProvisioningRequest) DeepCopyInto(out *ProvisioningRequest)

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

func (*ProvisioningRequest) DeepCopyObject 

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

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

type ProvisioningRequestList 

type ProvisioningRequestList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	//
	// +optional
	metav1.ListMeta `json:"metadata"`
	// Items, list of ProvisioningRequest returned from API.
	//
	// +optional
	Items []ProvisioningRequest `json:"items"`
}

ProvisioningRequestList is a object for list of ProvisioningRequest. +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

func (*ProvisioningRequestList) DeepCopy 

func (in *ProvisioningRequestList) DeepCopy() *ProvisioningRequestList

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

func (*ProvisioningRequestList) DeepCopyInto 

func (in *ProvisioningRequestList) DeepCopyInto(out *ProvisioningRequestList)

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

func (*ProvisioningRequestList) DeepCopyObject 

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

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

type ProvisioningRequestSpec 

type ProvisioningRequestSpec struct {
	// PodSets lists groups of pods for which we would like to provision
	// resources.
	//
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinItems=1
	// +kubebuilder:validation:MaxItems=32
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	PodSets []PodSet `json:"podSets"`

	// ProvisioningClassName describes the different modes of provisioning the resources.
	// Currently there is no support for 'ProvisioningClass' objects.
	// Supported values:
	// * check-capacity.kubernetes.io - check if current cluster state can fullfil this request,
	//   do not reserve the capacity. Users should provide a reference to a valid PodTemplate object.
	//   CA will check if there is enough capacity in cluster to fulfill the request and put
	//   the answer in 'CapacityAvailable' condition.
	// * atomic-scale-up.kubernetes.io - provision the resources in an atomic manner.
	//   Users should provide a reference to a valid PodTemplate object.
	//   CA will try to create the VMs in an atomic manner, clean any partially provisioned VMs
	//   and re-try the operation in a exponential back-off manner. Users can configure the timeout
	//   duration after which the request will fail by 'ValidUntilSeconds' key in 'Parameters'.
	//   CA will set 'Failed=true' or 'Provisioned=true' condition according to the outcome.
	// * ... - potential other classes that are specific to the cloud providers.
	// 'kubernetes.io' suffix is reserved for the modes defined in Kubernetes projects.
	//
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
	// +kubebuilder:validation:MaxLength=253
	ProvisioningClassName string `json:"provisioningClassName"`

	// Parameters contains all other parameters classes may require.
	// 'atomic-scale-up.kubernetes.io' supports 'ValidUntilSeconds' parameter, which should contain
	//  a string denoting duration for which we should retry (measured since creation fo the CR).
	//
	// +optional
	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Value is immutable"
	// +kubebuilder:validation:MaxProperties=100
	Parameters map[string]Parameter `json:"parameters"`
}

ProvisioningRequestSpec is a specification of additional pods for which we would like to provision additional resources in the cluster.

func (*ProvisioningRequestSpec) DeepCopy 

func (in *ProvisioningRequestSpec) DeepCopy() *ProvisioningRequestSpec

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

func (*ProvisioningRequestSpec) DeepCopyInto 

func (in *ProvisioningRequestSpec) DeepCopyInto(out *ProvisioningRequestSpec)

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

type ProvisioningRequestStatus 

type ProvisioningRequestStatus struct {
	// Conditions represent the observations of a Provisioning Request's
	// current state. Those will contain information whether the capacity
	// was found/created or if there were any issues. The condition types
	// may differ between different provisioning classes.
	//
	// +listType=map
	// +listMapKey=type
	// +patchStrategy=merge
	// +patchMergeKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions"`

	// ProvisioningClassDetails contains all other values custom provisioning classes may
	// want to pass to end users.
	//
	// +optional
	// +kubebuilder:validation:MaxProperties=64
	ProvisioningClassDetails map[string]Detail `json:"provisioningClassDetails"`
}

ProvisioningRequestStatus represents the status of the resource reservation.

func (*ProvisioningRequestStatus) DeepCopy 

func (in *ProvisioningRequestStatus) DeepCopy() *ProvisioningRequestStatus

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

func (*ProvisioningRequestStatus) DeepCopyInto 

func (in *ProvisioningRequestStatus) DeepCopyInto(out *ProvisioningRequestStatus)

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

type Reference 

type Reference struct {
	// Name of the referenced object.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
	//
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`
	// +kubebuilder:validation:MaxLength=253
	Name string `json:"name,omitempty"`
}

Reference represents reference to an object within the same namespace.

func (*Reference) DeepCopy 

func (in *Reference) DeepCopy() *Reference

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

func (*Reference) DeepCopyInto 

func (in *Reference) DeepCopyInto(out *Reference)

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.