v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the virt-disk v1alpha1 API group +kubebuilder:object:generate=true +groupName=virt-disk.gpu-ninja.com

Index

• Variables
• type VirtualDisk
  • func (in *VirtualDisk) DeepCopy() *VirtualDisk
  • func (in *VirtualDisk) DeepCopyInto(out *VirtualDisk)
  • func (in *VirtualDisk) DeepCopyObject() runtime.Object
• type VirtualDiskConditionType
• type VirtualDiskList
  • func (in *VirtualDiskList) DeepCopy() *VirtualDiskList
  • func (in *VirtualDiskList) DeepCopyInto(out *VirtualDiskList)
  • func (in *VirtualDiskList) DeepCopyObject() runtime.Object
• type VirtualDiskPhase
• type VirtualDiskSpec
  • func (in *VirtualDiskSpec) DeepCopy() *VirtualDiskSpec
  • func (in *VirtualDiskSpec) DeepCopyInto(out *VirtualDiskSpec)
• type VirtualDiskStatus
  • func (in *VirtualDiskStatus) DeepCopy() *VirtualDiskStatus
  • func (in *VirtualDiskStatus) DeepCopyInto(out *VirtualDiskStatus)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "virt-disk.gpu-ninja.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type VirtualDisk

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

	Spec   VirtualDiskSpec   `json:"spec,omitempty"`
	Status VirtualDiskStatus `json:"status,omitempty"`
}

VirtualDisk is the Schema for the VirtualDisks API. +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:shortName=vdisk

func (*VirtualDisk) DeepCopy

func (in *VirtualDisk) DeepCopy() *VirtualDisk

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

func (*VirtualDisk) DeepCopyInto

func (in *VirtualDisk) DeepCopyInto(out *VirtualDisk)

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

func (*VirtualDisk) DeepCopyObject

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

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

type VirtualDiskConditionType

type VirtualDiskConditionType string

const (
	VirtualDiskConditionTypePending VirtualDiskConditionType = "Pending"
	VirtualDiskConditionTypeReady   VirtualDiskConditionType = "Ready"
	VirtualDiskConditionTypeFailed  VirtualDiskConditionType = "Failed"
)

type VirtualDiskList

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

VirtualDiskList contains a list of VirtualDisk. +kubebuilder:object:root=true

func (*VirtualDiskList) DeepCopy

func (in *VirtualDiskList) DeepCopy() *VirtualDiskList

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

func (*VirtualDiskList) DeepCopyInto

func (in *VirtualDiskList) DeepCopyInto(out *VirtualDiskList)

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

func (*VirtualDiskList) DeepCopyObject

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

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

type VirtualDiskPhase

type VirtualDiskPhase string

const (
	VirtualDiskPhasePending VirtualDiskPhase = "Pending"
	VirtualDiskPhaseReady   VirtualDiskPhase = "Ready"
	VirtualDiskPhaseFailed  VirtualDiskPhase = "Failed"
)

type VirtualDiskSpec

type VirtualDiskSpec struct {
	// HostPath is the optional path where the virtual disk device will be stored.
	// +kubebuilder:default:="/var/lib/virt-disk"
	HostPath string `json:"hostPath,omitempty"`
	// Size is the size of the virtual disk device.
	Size resource.Quantity `json:"size"`
	// VolumeGroup is the name of the LVM volume group to create.
	VolumeGroup string `json:"volumeGroup"`
	// LogicalVolume is the name of the optional LVM logical volume to create.
	// It will be allocated to use all available space in the volume group.
	LogicalVolume string `json:"logicalVolume,omitempty"`
	// EncryptionKeySecretName is the name of the secret that will be created to store the LUKS encryption key.
	// If specified, the virtual disk device will be encrypted using LUKS.
	EncryptionKeySecretName string `json:"encryptionKeySecretName,omitempty"`
	// NodeSelector allows specifying which nodes a virtual disk device should be created on.
	// If not specified, the virtual disk device will be created on all nodes.
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
	// Resources allows specifying the resource requirements for the virtual disk container.
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
}

func (*VirtualDiskSpec) DeepCopy

func (in *VirtualDiskSpec) DeepCopy() *VirtualDiskSpec

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

func (*VirtualDiskSpec) DeepCopyInto

func (in *VirtualDiskSpec) DeepCopyInto(out *VirtualDiskSpec)

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

type VirtualDiskStatus

type VirtualDiskStatus struct {
	// Phase is the current state of the virtual disk device.
	Phase VirtualDiskPhase `json:"phase,omitempty"`
	// ObservedGeneration is the most recent generation observed for this virtual disk device by the controller.
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Conditions represents the latest available observations of the virtual disk devices current state.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

func (*VirtualDiskStatus) DeepCopy

func (in *VirtualDiskStatus) DeepCopy() *VirtualDiskStatus

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

func (*VirtualDiskStatus) DeepCopyInto

func (in *VirtualDiskStatus) DeepCopyInto(out *VirtualDiskStatus)

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