zfs-localpv/pkg/apis/openebs.io/zfs/v1/zfsvolume.go

/*
Copyright 2020 The OpenEBS Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +resource:path=zfsvolume

// 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="NodeID",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"
type ZFSVolume struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

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

// ZFSVolumeList is a list of ZFSVolume resources
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +resource:path=zfsvolumes
type ZFSVolumeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

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

// 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.
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|zstd|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"`
}

// VolStatus string that specifies the current state of the volume provisioning request.
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"`
}