feat(crd-gen): automate the CRDs generation with validations for APIs (#75)

- To generate the CRD spec `make manifest` generate then under
  deploy/yamls directory
- added a update-crd script to automate the steps to generate
  CRDs and its validation of each types

Signed-off-by: prateekpandey14 <prateek.pandey@mayadata.io>

pkg/apis/openebs.io/zfs/v1alpha1/doc.go

@@ -17,5 +17,5 @@ limitations under the License.
 // +k8s:deepcopy-gen=package,register
 
 // Package v1alpha1 is the API version
-// +groupName=openebs.io
+// +groupName=zfs.openebs.io
 package v1alpha1

pkg/apis/openebs.io/zfs/v1alpha1/zfssnapshot.go

@@ -25,6 +25,8 @@ import (
 // +resource:path=zfssnapshot
 
 // ZFSSnapshot represents a ZFS Snapshot of the zfsvolume
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:scope=Namespaced,shortName=zfssnap
 type ZFSSnapshot struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

pkg/apis/openebs.io/zfs/v1alpha1/zfsvolume.go

@@ -25,6 +25,16 @@ import (
 // +resource:path=zfsvolume
 
 // ZFSVolume represents a ZFS based volume
+// +kubebuilder:object:root=true
+// +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="volblocksize",type=string,JSONPath=`.spec.volblocksize`,description="volblocksize of volume"
+// +kubebuilder:printcolumn:name="recordsize",type=string,JSONPath=`.spec.recordsize`,description="recordsize of created zfs dataset"
+// +kubebuilder:printcolumn:name="Filesystem",type=string,JSONPath=`.spec.fsType`,description="filesystem created on the volume"
+// +kubebuilder:printcolumn:name="CreationTime",type=date,JSONPath=`.status.creationTime`,description="Timestamp when the volume has been created."
+// +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`
 type ZFSVolume struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
@@ -71,12 +81,18 @@ type ZFSVolumeList struct {
 // VolumeInfo contains the volume related info
 // for all types of volumes in ZFSVolume
 type VolumeInfo struct {
+
 	// OwnerNodeID is the Node ID which
 	// is the owner of this Volume
+
+	// +kubebuilder:validation:MinLength=1
+	// +kubebuilder:validation:Required
 	OwnerNodeID string `json:"ownerNodeID"`
 
 	// poolName specifies the name of the
 	// pool where this volume should be created
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:MinLength=1
 	PoolName string `json:"poolName"`
 
 	// SnapName specifies the name of the
@@ -84,41 +100,67 @@ type VolumeInfo struct {
 	SnapName string `json:"snapname,omitempty"`
 
 	// Capacity of the volume
+	// +kubebuilder:validation:MinLength=1
 	Capacity string `json:"capacity"`
 
 	// RecordSize specifies the record size
 	// for the zfs dataset
+	// +kubebuilder:validation:MinLength=1
 	RecordSize string `json:"recordsize,omitempty"`
 
 	// VolBlockSize specifies the block size for the zvol
+	// +kubebuilder:validation:MinLength=1
 	VolBlockSize string `json:"volblocksize,omitempty"`
 
-	// Compression specifies if the it should
-	// enabled on the zvol
+	// Controls the compression algorithm used for this dataset. Compression
+	// specifies if the it should enabled on the zvol. Setting compression to on
+	// indicates that the current default compression algorithm should be used.
+	// The current default compression algorithm is either lzjb or, if the lz4_compress
+	// feature is enabled, lz4.
+	// Changing this property affects only newly-written data.
+	// +kubebuilder:validation:Pattern="^(on|off|lzjb|gzip|gzip-[1-9]|zle|lz4)$"
 	Compression string `json:"compression,omitempty"`
 
-	// Dedup specifies the deduplication
+	// 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
+	// +kubebuilder:validation:Enum=on;off
 	Dedup string `json:"dedup,omitempty"`
 
-	// Encryption specifies the encryption
-	// should be enabled on the zvol
+	// 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).
+	// +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 is the location of key for the encryption
 	KeyLocation string `json:"keylocation,omitempty"`
 
-	// KeyFormat specifies format of the
-	// encryption key
+	// KeyFormat specifies format of the encryption key
 	KeyFormat string `json:"keyformat,omitempty"`
 
 	// Thinprovision specifies if we should
 	// thin provisioned the volume or not
+	// +kubebuilder:validation:Enum=Yes;no
 	ThinProvision string `json:"thinProvision,omitempty"`
 
-	// VolumeType specifies whether the volume is
-	// zvol or a dataset
+	// volumeType determines whether the volume is of type "DATASET" or "ZVOL".
+	// if fsttype provided in the storageclass is "zfs", then it will create a
+	// volume of type "DATASET". If "ext4", "ext3", "ext2" or "xfs" is mentioned as fstype
+	// in the storageclass, it will create a volume of type "ZVOL" so that it can be
+	// further formatted with the fstype provided in the storageclass.
+	// +kubebuilder:validation:Required
+	// +kubebuilder:validation:Enum=ZVOL;DATASET
 	VolumeType string `json:"volumeType"`
 
 	// FsType specifies filesystem type for the