storage

package
v0.0.12 Latest Latest
Warning

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

 Go to latest Published: Jun 2, 2022 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package storage is the internal version of the API.

Package storage contains API Schema definitions for the storage internal API group +kubebuilder:object:generate=true +groupName=storage.api.onmetal.de

Index

Constants

This section is empty.

Variables

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "storage.api.onmetal.de", Version: runtime.APIVersionInternal}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var VolumeGK = schema.GroupKind{
	Group: SchemeGroupVersion.Group,
	Kind:  "Volume",
}

VolumeGK is a helper to easily access the GroupKind information of an Volume

Functions

func Resource 

func Resource(name string) schema.GroupResource

Types

type Volume 

type Volume struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   VolumeSpec
	Status VolumeStatus
}

Volume is the Schema for the volumes API

func (*Volume) DeepCopy 

func (in *Volume) DeepCopy() *Volume

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

func (*Volume) DeepCopyInto 

func (in *Volume) DeepCopyInto(out *Volume)

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

func (*Volume) DeepCopyObject 

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

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

type VolumeAccess 

type VolumeAccess struct {
	// SecretRef references the Secret containing the access credentials to consume a Volume.
	SecretRef *corev1.LocalObjectReference
	// Driver is the name of the drive to use for this volume. Required.
	Driver string
	// VolumeAttributes are attributes of the volume to use.
	VolumeAttributes map[string]string
}

VolumeAccess represents information on how to access a volume.

func (*VolumeAccess) DeepCopy 

func (in *VolumeAccess) DeepCopy() *VolumeAccess

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

func (*VolumeAccess) DeepCopyInto 

func (in *VolumeAccess) DeepCopyInto(out *VolumeAccess)

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

type VolumeClass 

type VolumeClass struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// Capabilities describes the capabilities of a volume class
	Capabilities corev1.ResourceList
}

VolumeClass is the Schema for the volumeclasses API

func (*VolumeClass) DeepCopy 

func (in *VolumeClass) DeepCopy() *VolumeClass

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

func (*VolumeClass) DeepCopyInto 

func (in *VolumeClass) DeepCopyInto(out *VolumeClass)

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

func (*VolumeClass) DeepCopyObject 

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

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

type VolumeClassList 

type VolumeClassList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []VolumeClass
}

VolumeClassList contains a list of VolumeClass

func (*VolumeClassList) DeepCopy 

func (in *VolumeClassList) DeepCopy() *VolumeClassList

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

func (*VolumeClassList) DeepCopyInto 

func (in *VolumeClassList) DeepCopyInto(out *VolumeClassList)

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

func (*VolumeClassList) DeepCopyObject 

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

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

type VolumeCondition added in v0.0.11 

type VolumeCondition struct {
	// Type is the type of the condition.
	Type VolumeConditionType
	// Status is the status of the condition.
	Status corev1.ConditionStatus
	// Reason is a machine-readable indication of why the condition is in a certain state.
	Reason string
	// Message is a human-readable explanation of why the condition has a certain reason / state.
	Message string
	// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
	ObservedGeneration int64
	// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
	LastTransitionTime metav1.Time
}

VolumeCondition is one of the conditions of a volume.

func (*VolumeCondition) DeepCopy added in v0.0.11 

func (in *VolumeCondition) DeepCopy() *VolumeCondition

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

func (*VolumeCondition) DeepCopyInto added in v0.0.11 

func (in *VolumeCondition) DeepCopyInto(out *VolumeCondition)

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

type VolumeConditionType added in v0.0.11 

type VolumeConditionType string

VolumeConditionType is a type a VolumeCondition can have.

type VolumeList 

type VolumeList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []Volume
}

VolumeList contains a list of Volume

func (*VolumeList) DeepCopy 

func (in *VolumeList) DeepCopy() *VolumeList

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

func (*VolumeList) DeepCopyInto 

func (in *VolumeList) DeepCopyInto(out *VolumeList)

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

func (*VolumeList) DeepCopyObject 

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

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

type VolumePhase 

type VolumePhase string

VolumePhase represents the binding phase of a Volume. 

const (
	// VolumePhaseUnbound is used for any Volume that not bound.
	VolumePhaseUnbound VolumePhase = "Unbound"
	// VolumePhasePending is used for any Volume that is currently awaiting binding.
	VolumePhasePending VolumePhase = "Pending"
	// VolumePhaseBound is used for any Volume that is properly bound.
	VolumePhaseBound VolumePhase = "Bound"
)

type VolumePool 

type VolumePool struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	Spec   VolumePoolSpec
	Status VolumePoolStatus
}

VolumePool is the Schema for the volumepools API

func (*VolumePool) DeepCopy 

func (in *VolumePool) DeepCopy() *VolumePool

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

func (*VolumePool) DeepCopyInto 

func (in *VolumePool) DeepCopyInto(out *VolumePool)

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

func (*VolumePool) DeepCopyObject 

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

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

type VolumePoolCondition 

type VolumePoolCondition struct {
	// Type is the type of the condition.
	Type VolumePoolConditionType
	// Status is the status of the condition.
	Status corev1.ConditionStatus
	// Reason is a machine-readable indication of why the condition is in a certain state.
	Reason string
	// Message is a human-readable explanation of why the condition has a certain reason / state.
	Message string
	// ObservedGeneration represents the .metadata.generation that the condition was set based upon.
	ObservedGeneration int64
	// LastTransitionTime is the last time the status of a condition has transitioned from one state to another.
	LastTransitionTime metav1.Time
}

VolumePoolCondition is one of the conditions of a volume.

func (*VolumePoolCondition) DeepCopy 

func (in *VolumePoolCondition) DeepCopy() *VolumePoolCondition

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

func (*VolumePoolCondition) DeepCopyInto 

func (in *VolumePoolCondition) DeepCopyInto(out *VolumePoolCondition)

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

type VolumePoolConditionType 

type VolumePoolConditionType string

VolumePoolConditionType is a type a VolumePoolCondition can have.

type VolumePoolList 

type VolumePoolList struct {
	metav1.TypeMeta
	metav1.ListMeta
	Items []VolumePool
}

VolumePoolList contains a list of VolumePool

func (*VolumePoolList) DeepCopy 

func (in *VolumePoolList) DeepCopy() *VolumePoolList

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

func (*VolumePoolList) DeepCopyInto 

func (in *VolumePoolList) DeepCopyInto(out *VolumePoolList)

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

func (*VolumePoolList) DeepCopyObject 

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

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

type VolumePoolSpec 

type VolumePoolSpec struct {
	// ProviderID identifies the VolumePool on provider side.
	ProviderID string
	// Taints of the VolumePool. Only Volumes who tolerate all the taints
	// will land in the VolumePool.
	Taints []commonv1alpha1.Taint
}

VolumePoolSpec defines the desired state of VolumePool

func (*VolumePoolSpec) DeepCopy 

func (in *VolumePoolSpec) DeepCopy() *VolumePoolSpec

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

func (*VolumePoolSpec) DeepCopyInto 

func (in *VolumePoolSpec) DeepCopyInto(out *VolumePoolSpec)

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

type VolumePoolState 

type VolumePoolState string
const (
	VolumePoolStateAvailable    VolumePoolState = "Available"
	VolumePoolStatePending      VolumePoolState = "Pending"
	VolumePoolStateNotAvailable VolumePoolState = "NotAvailable"
)

type VolumePoolStatus 

type VolumePoolStatus struct {
	State      VolumePoolState
	Conditions []VolumePoolCondition
	// AvailableVolumeClasses list the references of any supported VolumeClass of this pool
	AvailableVolumeClasses []corev1.LocalObjectReference
	// Available list the available capacity of a volume pool
	Available corev1.ResourceList
	// Used indicates how much capacity has been used in a volume pool
	Used corev1.ResourceList
}

VolumePoolStatus defines the observed state of VolumePool

func (*VolumePoolStatus) DeepCopy 

func (in *VolumePoolStatus) DeepCopy() *VolumePoolStatus

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

func (*VolumePoolStatus) DeepCopyInto 

func (in *VolumePoolStatus) DeepCopyInto(out *VolumePoolStatus)

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

type VolumeSpec 

type VolumeSpec struct {
	// VolumeClassRef is the volume class of a volume
	VolumeClassRef corev1.LocalObjectReference
	// VolumePoolSelector selects a suitable VolumePoolRef by the given labels.
	VolumePoolSelector map[string]string
	// VolumePoolRef indicates which volume pool to use for a volume.
	// If unset, the scheduler will figure out a suitable VolumePoolRef.
	VolumePoolRef *corev1.LocalObjectReference
	// ClaimRef is the reference to the claiming entity of the Volume.
	ClaimRef *commonv1alpha1.LocalUIDReference
	// Resources is a description of the volume's resources and capacity.
	Resources corev1.ResourceList
	// Image is an optional image to bootstrap the volume with.
	Image string
	// ImagePullSecretRef is an optional secret for pulling the image of a volume.
	ImagePullSecretRef *corev1.LocalObjectReference
	// Unclaimable marks the volume as unclaimable.
	Unclaimable bool
	// Tolerations define tolerations the Volume has. Only a VolumePool whose taints
	// covered by Tolerations will be considered to host the Volume.
	Tolerations []commonv1alpha1.Toleration
}

VolumeSpec defines the desired state of Volume

func (*VolumeSpec) DeepCopy 

func (in *VolumeSpec) DeepCopy() *VolumeSpec

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

func (*VolumeSpec) DeepCopyInto 

func (in *VolumeSpec) DeepCopyInto(out *VolumeSpec)

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

type VolumeState 

type VolumeState string

VolumeState represents the infrastructure state of a Volume. 

const (
	// VolumeStateAvailable reports whether the volume is available to be used.
	VolumeStateAvailable VolumeState = "Available"
	// VolumeStatePending reports whether the volume is about to be ready.
	VolumeStatePending VolumeState = "Pending"
	// VolumeStateError reports that the volume is in an error state.
	VolumeStateError VolumeState = "Error"
)

type VolumeStatus 

type VolumeStatus struct {
	// State represents the infrastructure state of a Volume.
	State VolumeState
	// LastStateTransitionTime is the last time the State transitioned between values.
	LastStateTransitionTime *metav1.Time

	// Phase represents the binding phase of a Volume.
	Phase VolumePhase
	// LastPhaseTransitionTime is the last time the Phase transitioned between values.
	LastPhaseTransitionTime *metav1.Time

	// Access specifies how to access a Volume.
	// This is set by the volume provider when the volume is provisioned.
	Access *VolumeAccess

	// Conditions are the conditions of a volume.
	Conditions []VolumeCondition
}

VolumeStatus defines the observed state of Volume

func (*VolumeStatus) DeepCopy 

func (in *VolumeStatus) DeepCopy() *VolumeStatus

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

func (*VolumeStatus) DeepCopyInto 

func (in *VolumeStatus) DeepCopyInto(out *VolumeStatus)

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

type VolumeTemplateSpec added in v0.0.12 

type VolumeTemplateSpec struct {
	metav1.ObjectMeta
	Spec VolumeSpec
}

VolumeTemplateSpec is the specification of a Volume template.

func (*VolumeTemplateSpec) DeepCopy added in v0.0.12 

func (in *VolumeTemplateSpec) DeepCopy() *VolumeTemplateSpec

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

func (*VolumeTemplateSpec) DeepCopyInto added in v0.0.12 

func (in *VolumeTemplateSpec) DeepCopyInto(out *VolumeTemplateSpec)

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

Source Files

View all Source files

Directories

Path Synopsis
Package v1alpha1 is the v1alpha1 version of the API.
 Package v1alpha1 is the v1alpha1 version of the API.

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.