v1

package
v1.6.0-RC2 Latest Latest
Warning

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

Go to latest
Published: Apr 6, 2021 License: Apache-2.0 Imports: 3 Imported by: 1

Documentation

Overview

Package v1 is the API version +groupName=zfs.openebs.io

Index

Constants

This section is empty.

Variables

View Source
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
)
View Source
var SchemeGroupVersion = schema.GroupVersion{
	Group:   "zfs.openebs.io",
	Version: "v1",
}

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 SnapStatus

type SnapStatus struct {
	State string `json:"state,omitempty"`
}

SnapStatus string that reflects if the snapshot was cretaed successfully

func (*SnapStatus) DeepCopy

func (in *SnapStatus) DeepCopy() *SnapStatus

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

func (*SnapStatus) DeepCopyInto

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;Failed
	State string `json:"state,omitempty"`
}

VolStatus string that specifies the current state of the volume provisioning request.

func (*VolStatus) DeepCopy

func (in *VolStatus) DeepCopy() *VolStatus

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

func (*VolStatus) DeepCopyInto

func (in *VolStatus) DeepCopyInto(out *VolStatus)

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 ZPOOL is running 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"`

	// poolName specifies the name of the pool where the volume has been created.
	// PoolName can not be edited after the volume has been provisioned.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	PoolName string `json:"poolName"`

	// SnapName specifies the name of the snapshot where the volume has been cloned from.
	// Snapname can not be edited after the volume has been provisioned.
	SnapName string `json:"snapname,omitempty"`

	// Capacity of the volume
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	Capacity string `json:"capacity"`

	// Specifies a suggested block size for files in the file system.
	// The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes.
	// RecordSize property can be edited after the volume has been created.
	// Changing the file system's recordsize affects only files created afterward; existing files are unaffected.
	// Default Value: 128k.
	// +kubebuilder:validation:MinLength=1
	RecordSize string `json:"recordsize,omitempty"`

	// VolBlockSize specifies the block size for the zvol.
	// The volsize can only be set to a multiple of volblocksize, and cannot be zero.
	// VolBlockSize can not be edited after the volume has been provisioned.
	// Default Value: 8k.
	// +kubebuilder:validation:MinLength=1
	VolBlockSize string `json:"volblocksize,omitempty"`

	// Compression specifies the block-level compression algorithm to be applied to the ZFS Volume.
	// The value "on" indicates ZFS to use the default compression algorithm. The default compression
	// algorithm used by ZFS will be either lzjb or, if the lz4_compress feature is enabled, lz4.
	// Compression property can be edited after the volume has been created. The change will only
	// be applied to the newly-written data. For instance, if the Volume was created with "off" and
	// the next day the compression was modified to "on", the data written prior to setting "on" will
	// not be compressed.
	// Default Value: off.
	// +kubebuilder:validation:Pattern="^(on|off|lzjb|gzip|gzip-[1-9]|zle|lz4)$"
	Compression string `json:"compression,omitempty"`

	// Deduplication is the process for removing redundant data at the block level,
	// reducing the total amount of data stored. If a file system has the dedup property
	// enabled, duplicate data blocks are removed synchronously.
	// The result is that only unique data is stored and common components are shared among files.
	// Deduplication can consume significant processing power (CPU) and memory as well as generate additional disk IO.
	// Before creating a pool with deduplication enabled, ensure that you have planned your hardware
	// requirements appropriately and implemented appropriate recovery practices, such as regular backups.
	// As an alternative to deduplication consider using compression=lz4, as a less resource-intensive alternative.
	// should be enabled on the zvol.
	// Dedup property can be edited after the volume has been created.
	// Default Value: off.
	// +kubebuilder:validation:Enum=on;off
	Dedup string `json:"dedup,omitempty"`

	// Enabling the encryption feature allows for the creation of
	// encrypted filesystems and volumes. ZFS will encrypt file and zvol data,
	// file attributes, ACLs, permission bits, directory listings, FUID mappings,
	// and userused / groupused data. ZFS will not encrypt metadata related to the
	// pool structure, including dataset and snapshot names, dataset hierarchy,
	// properties, file size, file holes, and deduplication tables
	// (though the deduplicated data itself is encrypted).
	// Default Value: off.
	// +kubebuilder:validation:Pattern="^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$"
	Encryption string `json:"encryption,omitempty"`

	// KeyLocation is the location of key for the encryption
	KeyLocation string `json:"keylocation,omitempty"`

	// KeyFormat specifies format of the encryption key
	// The supported KeyFormats are passphrase, raw, hex.
	// +kubebuilder:validation:Enum=passphrase;raw;hex
	KeyFormat string `json:"keyformat,omitempty"`

	// ThinProvision describes whether space reservation for the source volume is required or not.
	// The value "yes" indicates that volume should be thin provisioned and "no" means thick provisioning of the volume.
	// If thinProvision is set to "yes" then volume can be provisioned even if the ZPOOL does not
	// have the enough capacity.
	// If thinProvision is set to "no" then volume can be provisioned only if the ZPOOL has enough
	// capacity and capacity required by volume can be reserved.
	// ThinProvision can not be modified once volume has been provisioned.
	// Default Value: no.
	// +kubebuilder:validation:Enum=yes;no
	ThinProvision string `json:"thinProvision,omitempty"`

	// volumeType determines whether the volume is of type "DATASET" or "ZVOL".
	// If fstype provided in the storageclass is "zfs", a volume of type dataset will be created.
	// If "ext4", "ext3", "ext2" or "xfs" is mentioned as fstype
	// in the storageclass, then a volume of type zvol will be created, which will be
	// further formatted as the fstype provided in the storageclass.
	// VolumeType can not be modified once volume has been provisioned.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=ZVOL;DATASET
	VolumeType string `json:"volumeType"`

	// FsType specifies filesystem type for the zfs volume/dataset.
	// If FsType is provided as "zfs", then the driver will create a
	// ZFS dataset, formatting is not required as underlying filesystem is ZFS anyway.
	// If FsType is ext2, ext3, ext4 or xfs, then the driver will create a ZVOL and
	// format the volume accordingly.
	// FsType can not be modified once volume has been provisioned.
	// Default Value: ext4.
	FsType string `json:"fsType,omitempty"`

	// Shared specifies whether the volume can be shared among multiple pods.
	// If it is not set to "yes", then the ZFS-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 ZFS volume parameters for all modes in which ZFS volumes can be created like - ZFS volume with filesystem, ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. Some of the parameters can be only set during creation time (as specified in the details of the parameter), and a few are editable. In case of Cloned volumes, the parameters are assigned the same values as the source volume.

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.

type ZFSBackup added in v1.0.0

type ZFSBackup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              ZFSBackupSpec `json:"spec"`
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=Init;Done;Failed;Pending;InProgress;Invalid
	Status ZFSBackupStatus `json:"status"`
}

ZFSBackup describes a zfs backup resource created as a custom resource +kubebuilder:object:root=true +kubebuilder:storageversion +kubebuilder:resource:scope=Namespaced,shortName=zb +kubebuilder:printcolumn:name="PrevSnap",type=string,JSONPath=`.spec.prevSnapName`,description="Previous snapshot for backup" +kubebuilder:printcolumn:name="Status",type=string,JSONPath=`.status`,description="Backup status" +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`,description="Age of the volume"

func (*ZFSBackup) DeepCopy added in v1.0.0

func (in *ZFSBackup) DeepCopy() *ZFSBackup

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

func (*ZFSBackup) DeepCopyInto added in v1.0.0

func (in *ZFSBackup) DeepCopyInto(out *ZFSBackup)

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

func (*ZFSBackup) DeepCopyObject added in v1.0.0

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

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

type ZFSBackupList added in v1.0.0

type ZFSBackupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ZFSBackup `json:"items"`
}

ZFSBackupList is a list of ZFSBackup resources

func (*ZFSBackupList) DeepCopy added in v1.0.0

func (in *ZFSBackupList) DeepCopy() *ZFSBackupList

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

func (*ZFSBackupList) DeepCopyInto added in v1.0.0

func (in *ZFSBackupList) DeepCopyInto(out *ZFSBackupList)

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

func (*ZFSBackupList) DeepCopyObject added in v1.0.0

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

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

type ZFSBackupSpec added in v1.0.0

type ZFSBackupSpec struct {
	// VolumeName is a name of the volume for which this backup is destined
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	VolumeName string `json:"volumeName"`

	// OwnerNodeID is a name of the nodes where the source volume is
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	OwnerNodeID string `json:"ownerNodeID"`

	// SnapName is the snapshot name for backup
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	SnapName string `json:"snapName,omitempty"`

	// PrevSnapName is the last completed-backup's snapshot name
	PrevSnapName string `json:"prevSnapName,omitempty"`

	// BackupDest is the remote address for backup transfer
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Pattern="^([0-9]+.[0-9]+.[0-9]+.[0-9]+:[0-9]+)$"
	BackupDest string `json:"backupDest"`
}

ZFSBackupSpec is the spec for a ZFSBackup resource

func (*ZFSBackupSpec) DeepCopy added in v1.0.0

func (in *ZFSBackupSpec) DeepCopy() *ZFSBackupSpec

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

func (*ZFSBackupSpec) DeepCopyInto added in v1.0.0

func (in *ZFSBackupSpec) DeepCopyInto(out *ZFSBackupSpec)

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

type ZFSBackupStatus added in v1.0.0

type ZFSBackupStatus string

ZFSBackupStatus is to hold status of backup

const (
	// BKPZFSStatusDone , backup is completed.
	BKPZFSStatusDone ZFSBackupStatus = "Done"

	// BKPZFSStatusFailed , backup is failed.
	BKPZFSStatusFailed ZFSBackupStatus = "Failed"

	// BKPZFSStatusInit , backup is initialized.
	BKPZFSStatusInit ZFSBackupStatus = "Init"

	// BKPZFSStatusPending , backup is pending.
	BKPZFSStatusPending ZFSBackupStatus = "Pending"

	// BKPZFSStatusInProgress , backup is in progress.
	BKPZFSStatusInProgress ZFSBackupStatus = "InProgress"

	// BKPZFSStatusInvalid , backup operation is invalid.
	BKPZFSStatusInvalid ZFSBackupStatus = "Invalid"
)

Status written onto ZFSBackup objects.

type ZFSRestore added in v1.0.0

type ZFSRestore struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"` // set name to restore name + volume name + something like csp tag
	Spec              ZFSRestoreSpec              `json:"spec"`
	VolSpec           VolumeInfo                  `json:"volSpec,omitempty"`
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=Init;Done;Failed;Pending;InProgress;Invalid
	Status ZFSRestoreStatus `json:"status"`
}

ZFSRestore describes a cstor restore resource created as a custom resource

func (*ZFSRestore) DeepCopy added in v1.0.0

func (in *ZFSRestore) DeepCopy() *ZFSRestore

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

func (*ZFSRestore) DeepCopyInto added in v1.0.0

func (in *ZFSRestore) DeepCopyInto(out *ZFSRestore)

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

func (*ZFSRestore) DeepCopyObject added in v1.0.0

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

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

type ZFSRestoreList added in v1.0.0

type ZFSRestoreList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ZFSRestore `json:"items"`
}

ZFSRestoreList is a list of ZFSRestore resources

func (*ZFSRestoreList) DeepCopy added in v1.0.0

func (in *ZFSRestoreList) DeepCopy() *ZFSRestoreList

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

func (*ZFSRestoreList) DeepCopyInto added in v1.0.0

func (in *ZFSRestoreList) DeepCopyInto(out *ZFSRestoreList)

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

func (*ZFSRestoreList) DeepCopyObject added in v1.0.0

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

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

type ZFSRestoreSpec added in v1.0.0

type ZFSRestoreSpec struct {
	// volume name to where restore has to be performed
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	VolumeName string `json:"volumeName"`
	// owner node name where restore volume is present
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	OwnerNodeID string `json:"ownerNodeID"`

	// it can be ip:port in case of restore from remote or volumeName in case of local restore
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Pattern="^([0-9]+.[0-9]+.[0-9]+.[0-9]+:[0-9]+)$"
	RestoreSrc string `json:"restoreSrc"`
}

ZFSRestoreSpec is the spec for a ZFSRestore resource

func (*ZFSRestoreSpec) DeepCopy added in v1.0.0

func (in *ZFSRestoreSpec) DeepCopy() *ZFSRestoreSpec

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

func (*ZFSRestoreSpec) DeepCopyInto added in v1.0.0

func (in *ZFSRestoreSpec) DeepCopyInto(out *ZFSRestoreSpec)

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

type ZFSRestoreStatus added in v1.0.0

type ZFSRestoreStatus string

ZFSRestoreStatus is to hold result of action.

const (
	// RSTZFSStatusDone , restore operation is completed.
	RSTZFSStatusDone ZFSRestoreStatus = "Done"

	// RSTZFSStatusFailed , restore operation is failed.
	RSTZFSStatusFailed ZFSRestoreStatus = "Failed"

	// RSTZFSStatusInit , restore operation is initialized.
	RSTZFSStatusInit ZFSRestoreStatus = "Init"

	// RSTZFSStatusPending , restore operation is pending.
	RSTZFSStatusPending ZFSRestoreStatus = "Pending"

	// RSTZFSStatusInProgress , restore operation is in progress.
	RSTZFSStatusInProgress ZFSRestoreStatus = "InProgress"

	// RSTZFSStatusInvalid , restore operation is invalid.
	RSTZFSStatusInvalid ZFSRestoreStatus = "Invalid"
)

Status written onto CStrorRestore object.

type ZFSSnapshot

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

	Spec   VolumeInfo `json:"spec"`
	Status SnapStatus `json:"status"`
}

ZFSSnapshot represents a ZFS Snapshot of the zfsvolume +kubebuilder:storageversion +kubebuilder:object:root=true +kubebuilder:resource:scope=Namespaced,shortName=zfssnap

func (*ZFSSnapshot) DeepCopy

func (in *ZFSSnapshot) DeepCopy() *ZFSSnapshot

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

func (*ZFSSnapshot) DeepCopyInto

func (in *ZFSSnapshot) DeepCopyInto(out *ZFSSnapshot)

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

func (*ZFSSnapshot) DeepCopyObject

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

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

type ZFSSnapshotList

type ZFSSnapshotList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ZFSSnapshot `json:"items"`
}

ZFSSnapshotList is a list of ZFSSnapshot resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +resource:path=zfssnapshots

func (*ZFSSnapshotList) DeepCopy

func (in *ZFSSnapshotList) DeepCopy() *ZFSSnapshotList

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

func (*ZFSSnapshotList) DeepCopyInto

func (in *ZFSSnapshotList) DeepCopyInto(out *ZFSSnapshotList)

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

func (*ZFSSnapshotList) DeepCopyObject

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

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

type ZFSVolume

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

	Spec   VolumeInfo `json:"spec"`
	Status VolStatus  `json:"status,omitempty"`
}

ZFSVolume represents a ZFS based volume +kubebuilder:object:root=true +kubebuilder:storageversion +kubebuilder:resource:scope=Namespaced,shortName=zfsvol;zv +kubebuilder:printcolumn:name="ZPool",type=string,JSONPath=`.spec.poolName`,description="ZFS Pool 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="Filesystem",type=string,JSONPath=`.spec.fsType`,description="filesystem created on the volume" +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`,description="Age of the volume"

func (*ZFSVolume) DeepCopy

func (in *ZFSVolume) DeepCopy() *ZFSVolume

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

func (*ZFSVolume) DeepCopyInto

func (in *ZFSVolume) DeepCopyInto(out *ZFSVolume)

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

func (*ZFSVolume) DeepCopyObject

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

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

type ZFSVolumeList

type ZFSVolumeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ZFSVolume `json:"items"`
}

ZFSVolumeList is a list of ZFSVolume resources +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object +resource:path=zfsvolumes

func (*ZFSVolumeList) DeepCopy

func (in *ZFSVolumeList) DeepCopy() *ZFSVolumeList

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

func (*ZFSVolumeList) DeepCopyInto

func (in *ZFSVolumeList) DeepCopyInto(out *ZFSVolumeList)

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

func (*ZFSVolumeList) DeepCopyObject

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL