Documentation
¶
Overview ¶
Package v1alpha1 is the API version +groupName=local.openebs.io
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeBuilder is the scheme builder // with scheme init functions to run // for this API package SchemeBuilder runtime.SchemeBuilder // AddToScheme is a global function that // registers this API group & version to // a scheme AddToScheme = localSchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{
Group: "local.openebs.io",
Version: "v1alpha1",
}
SchemeGroupVersion is group version used to register custom resources
NOTE:
This variable name should not be changed
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type LVMSnapshot ¶ added in v0.2.0
type LVMSnapshot struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec VolumeInfo `json:"spec"` Status SnapStatus `json:"status"` }
LVMSnapshot represents an LVM Snapshot of the lvm volume
func (*LVMSnapshot) DeepCopy ¶ added in v0.2.0
func (in *LVMSnapshot) DeepCopy() *LVMSnapshot
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LVMSnapshot.
func (*LVMSnapshot) DeepCopyInto ¶ added in v0.2.0
func (in *LVMSnapshot) DeepCopyInto(out *LVMSnapshot)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LVMSnapshot) DeepCopyObject ¶ added in v0.2.0
func (in *LVMSnapshot) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type LVMSnapshotList ¶ added in v0.2.0
type LVMSnapshotList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []LVMSnapshot `json:"items"` }
LVMSnapshotList is a list of LVMSnapshot resources
func (*LVMSnapshotList) DeepCopy ¶ added in v0.2.0
func (in *LVMSnapshotList) DeepCopy() *LVMSnapshotList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LVMSnapshotList.
func (*LVMSnapshotList) DeepCopyInto ¶ added in v0.2.0
func (in *LVMSnapshotList) DeepCopyInto(out *LVMSnapshotList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LVMSnapshotList) DeepCopyObject ¶ added in v0.2.0
func (in *LVMSnapshotList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type LVMVolume ¶
type LVMVolume struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec VolumeInfo `json:"spec"` Status VolStatus `json:"status,omitempty"` }
LVMVolume represents a LVM based volume +kubebuilder:object:root=true +kubebuilder:resource:scope=Namespaced,shortName=lvmvol +kubebuilder:printcolumn:name="VolGroup",type=string,JSONPath=`.spec.volGroup`,description="volume group where the volume is created" +kubebuilder:printcolumn:name="Node",type=string,JSONPath=`.spec.ownerNodeID`,description="Node where the volume is created" +kubebuilder:printcolumn:name="Size",type=string,JSONPath=`.spec.capacity`,description="Size of the volume" +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status.state`,description="Status of the volume" +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`,description="Age of the volume"
func (*LVMVolume) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LVMVolume.
func (*LVMVolume) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LVMVolume) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type LVMVolumeList ¶
type LVMVolumeList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []LVMVolume `json:"items"` }
LVMVolumeList is a list of LVMVolume resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +resource:path=lvmvolumes
func (*LVMVolumeList) DeepCopy ¶
func (in *LVMVolumeList) DeepCopy() *LVMVolumeList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LVMVolumeList.
func (*LVMVolumeList) DeepCopyInto ¶
func (in *LVMVolumeList) DeepCopyInto(out *LVMVolumeList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*LVMVolumeList) DeepCopyObject ¶
func (in *LVMVolumeList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SnapStatus ¶ added in v0.2.0
type SnapStatus struct {
State string `json:"state,omitempty"`
}
SnapStatus string that reflects if the snapshot was created successfully
func (*SnapStatus) DeepCopy ¶ added in v0.2.0
func (in *SnapStatus) DeepCopy() *SnapStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SnapStatus.
func (*SnapStatus) DeepCopyInto ¶ added in v0.2.0
func (in *SnapStatus) DeepCopyInto(out *SnapStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VolStatus ¶
type VolStatus struct { // State specifies the current state of the volume provisioning request. // The state "Pending" means that the volume creation request has not // processed yet. The state "Ready" means that the volume has been created // and it is ready for the use. // +kubebuilder:validation:Enum=Pending;Ready State string `json:"state,omitempty"` }
VolStatus string that specifies the current state of the volume provisioning request.
func (*VolStatus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolStatus.
func (*VolStatus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VolumeInfo ¶
type VolumeInfo struct { // OwnerNodeID is the Node ID where the volume group is present which is where // the volume has been provisioned. // OwnerNodeID can not be edited after the volume has been provisioned. // +kubebuilder:validation:MinLength=1 // +kubebuilder:validation:Required OwnerNodeID string `json:"ownerNodeID"` // VolGroup specifies the name of the volume group where the volume has been created. // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 VolGroup string `json:"volGroup"` // Capacity of the volume // +kubebuilder:validation:Required // +kubebuilder:validation:MinLength=1 Capacity string `json:"capacity"` // If it is not set to "yes", then the LVM LocalPV Driver will not allow // the volumes to be mounted by more than one pods. // +kubebuilder:validation:Required // +kubebuilder:validation:Enum=yes;no Shared string `json:"shared,omitempty"` }
VolumeInfo defines LVM info
func (*VolumeInfo) DeepCopy ¶
func (in *VolumeInfo) DeepCopy() *VolumeInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeInfo.
func (*VolumeInfo) DeepCopyInto ¶
func (in *VolumeInfo) DeepCopyInto(out *VolumeInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.