v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the cns v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=sigs.k8s.io/vsphere-csi-driver/v3/pkg/apis/cns +k8s:defaulter-gen=TypeMeta +groupName=cns.vmware.com

Package v1alpha1 contains API Schema definitions for the cns v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=sigs.k8s.io/vsphere-csi-driver/v3/pkg/apis/cns +k8s:defaulter-gen=TypeMeta +groupName=cns.vmware.com

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type PoolCapacity
• type StoragePool
  • func (in *StoragePool) DeepCopy() *StoragePool
  • func (in *StoragePool) DeepCopyInto(out *StoragePool)
  • func (in *StoragePool) DeepCopyObject() runtime.Object
• type StoragePoolError
• type StoragePoolList
  • func (in *StoragePoolList) DeepCopy() *StoragePoolList
  • func (in *StoragePoolList) DeepCopyInto(out *StoragePoolList)
  • func (in *StoragePoolList) DeepCopyObject() runtime.Object
• type StoragePoolSpec
  • func (in *StoragePoolSpec) DeepCopy() *StoragePoolSpec
  • func (in *StoragePoolSpec) DeepCopyInto(out *StoragePoolSpec)
• type StoragePoolStatus
  • func (in *StoragePoolStatus) DeepCopy() *StoragePoolStatus
  • func (in *StoragePoolStatus) DeepCopyInto(out *StoragePoolStatus)

Constants

const (
	ErrStateNoError                = ""
	ErrStateNoAccessibleHosts      = "NoAccessibleHosts"
	ErrStateDatastoreInMM          = "DatastoreInMM"
	ErrStateAllHostsInMM           = "AllHostsInMM"
	ErrStateDatastoreNotAccessible = "NotAccessible"
)

ErrStates used in StoragePool.Status.Error.State

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "cns.vmware.com", Version: "v1alpha1"}

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

	// AddToScheme is required by pkg/client/...
	AddToScheme = SchemeBuilder.AddToScheme
)

var (
	// SpErrors maps ErrStates to error messages used in StoragePool.Status.Error.Message
	SpErrors = map[string]*StoragePoolError{
		ErrStateNoError:                {ErrStateNoError, ""},
		ErrStateNoAccessibleHosts:      {ErrStateNoAccessibleHosts, "No Accessible hosts to reach this Datastore"},
		ErrStateDatastoreInMM:          {ErrStateDatastoreInMM, "Datastore in maintenance mode"},
		ErrStateAllHostsInMM:           {ErrStateAllHostsInMM, "All hosts in maintenance mode"},
		ErrStateDatastoreNotAccessible: {ErrStateDatastoreNotAccessible, "Datastore not accessible"},
	}
)

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource is required by pkg/client/listers/...

Types

type PoolCapacity

type PoolCapacity struct {
	// Total capacity of the storage pool
	// +optional
	Total *resource.Quantity `json:"total,omitempty"`
	// Free Space of the storage pool
	// +optional
	FreeSpace *resource.Quantity `json:"freeSpace,omitempty"`
	// allocatable capacity of storage pool
	// +optional
	AllocatableSpace *resource.Quantity `json:"allocatableSpace,omitempty"`
}

PoolCapacity is the storage capacity of the storage pool

type StoragePool

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

	Spec   StoragePoolSpec   `json:"spec,omitempty"`
	Status StoragePoolStatus `json:"status,omitempty"`
}

StoragePool is the Schema for the storagepools API +k8s:openapi-gen=true +kubebuilder:resource:scope=Cluster

func (*StoragePool) DeepCopy

func (in *StoragePool) DeepCopy() *StoragePool

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

func (*StoragePool) DeepCopyInto

func (in *StoragePool) DeepCopyInto(out *StoragePool)

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

func (*StoragePool) DeepCopyObject

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

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

type StoragePoolError

type StoragePoolError struct {
	// State indicates a single word description of the error state that has occurred on the StoragePool,
	// "InMaintenance", "NotAccessible", etc.
	// +optional
	State string `json:"state,omitempty"`

	// Message details of the encountered error
	// +optional
	Message string `json:"message,omitempty"`
}

StoragePoolError describes an error encountered on the pool

type StoragePoolList

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

StoragePoolList contains a list of StoragePool

func (*StoragePoolList) DeepCopy

func (in *StoragePoolList) DeepCopy() *StoragePoolList

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

func (*StoragePoolList) DeepCopyInto

func (in *StoragePoolList) DeepCopyInto(out *StoragePoolList)

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

func (*StoragePoolList) DeepCopyObject

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

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

type StoragePoolSpec

type StoragePoolSpec struct {
	// Name of the driver
	Driver string `json:"driver"`

	// Opaque parameters describing attributes of the storage pool
	// +optional
	Parameters map[string]string `json:"parameters,omitempty"`
}

StoragePoolSpec defines the desired state of StoragePool

func (*StoragePoolSpec) DeepCopy

func (in *StoragePoolSpec) DeepCopy() *StoragePoolSpec

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

func (*StoragePoolSpec) DeepCopyInto

func (in *StoragePoolSpec) DeepCopyInto(out *StoragePoolSpec)

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

type StoragePoolStatus

type StoragePoolStatus struct {
	// Nodes the storage pool has access to
	// +optional
	AccessibleNodes []string `json:"accessibleNodes,omitempty"`
	// StorageClasses that can be used with this storage pool
	// +optional
	CompatibleStorageClasses []string `json:"compatibleStorageClasses,omitempty"`
	// Total Capacity of the storage pool
	// +optional
	Capacity *PoolCapacity `json:"capacity,omitempty"`
	// Error that has occurred on the storage pool. Present only when there is an error.
	// +optional
	Error StoragePoolError `json:"error,omitempty"`
	// DiskDecomm indicates the status of disk decommission for the given storagepool
	// +optional
	DiskDecomm map[string]string `json:"diskDecomm,omitempty"`
}

StoragePoolStatus defines the observed state of StoragePool

func (*StoragePoolStatus) DeepCopy

func (in *StoragePoolStatus) DeepCopy() *StoragePoolStatus

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

func (*StoragePoolStatus) DeepCopyInto

func (in *StoragePoolStatus) DeepCopyInto(out *StoragePoolStatus)

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