Fix API review comments for CnsNodeVMBatachAttachment API

Author: skogta

pkg/apis/cnsoperator/cnsnodevmbatchattachment/v1alpha1/cnsnodebatchvmattachment_types.go

@@ -21,32 +21,38 @@ import (
 )
 
 // DiskMode describes the desired mode to use when attaching the volume.
+// +kubebuilder:validation:Enum=independent_persistent;persistent;independent_nonpersistent
 type DiskMode string
 
 const (
-	// By setting DiskMode to independent_persistent, a virtual machine's disk is not captured in snapshots and
+	// IndependentPersistent is the diskMode in which, a virtual machine's disk is not captured in snapshots and
 	// changes are permanently written to the disk, regardless of snapshot operations.
 	IndependentPersistent DiskMode = "independent_persistent"
-	// Changes are immediately and permanently written to the virtual disk.
+	// Persistent diskMode changes are immediately and permanently written to the virtual disk.
 	Persistent DiskMode = "persistent"
+	// Changes to virtual disk are made to a redo log and discarded at power off.
+	// It is not affected by snapshots.
+	IndependentNonPersistent = "independent_nonpersistent"
 )
 
-// The sharing mode of the virtual disk.
+// SharingMode is the sharing mode of the virtual disk.
+// +kubebuilder:validation:Enum=sharingMultiWriter;sharingNone
 type SharingMode string
 
 const (
-	// The virtual disk is shared between multiple virtual machines.
+	// SharingMultiWriter: The virtual disk is shared between multiple virtual machines.
 	SharingMultiWriter SharingMode = "sharingMultiWriter"
-	// The virtual disk is not shared.
+	// SharingNone: The virtual disk is not shared.
 	SharingNone SharingMode = "sharingNone"
 )
 
-// CnsNodeVmBatchAttachmentSpec defines the desired state of CnsNodeVmBatchAttachment
+// CnsNodeVMBatchAttachmentSpec defines the desired state of CnsNodeVMBatchAttachment
 // +k8s:openapi-gen=true
-type CnsNodeVmBatchAttachmentSpec struct {
+type CnsNodeVMBatchAttachmentSpec struct {
+	// +required
 	// NodeUUID indicates the UUID of the node where the volume needs to be attached to.
 	// Here NodeUUID is the instance UUID of the node.
-	NodeUUID string `json:"nodeuuid"`
+	NodeUUID string `json:"nodeUUID"`
 
 	// +listType=map
 	// +listMapKey=name
@@ -63,20 +69,25 @@ type VolumeSpec struct {
 
 type PersistentVolumeClaimSpec struct {
 	// ClaimName is the PVC name.
+	// +required
 	ClaimName string `json:"claimName"`
 	// DiskMode is the desired mode to use when attaching the volume
+	// +optional
 	DiskMode DiskMode `json:"diskMode,omitempty"`
-	// SharingMode indicates the shraring mode if the virtual disk while attaching.
+	// SharingMode indicates the sharing mode if the virtual disk while attaching.
+	// +optional
 	SharingMode SharingMode `json:"sharingMode,omitempty"`
 	// ControllerKey is the object key for the controller object for this device.
+	// +optional
 	ControllerKey string `json:"controllerKey,omitempty"`
 	// UnitNumber of this device on its controller.
+	// +optional
 	UnitNumber string `json:"unitNumber,omitempty"`
 }
 
-// CnsNodeVmBatchAttachmentStatus defines the observed state of CnsNodeVmBatchAttachment
+// CnsNodeVMBatchAttachmentStatus defines the observed state of CnsNodeVMBatchAttachment
 // +k8s:openapi-gen=true
-type CnsNodeVmBatchAttachmentStatus struct {
+type CnsNodeVMBatchAttachmentStatus struct {
 	// Error is the overall error status for the instance.
 	Error string `json:"error,omitempty"`
 	// +listType=map
@@ -95,6 +106,7 @@ type VolumeStatus struct {
 type PersistentVolumeClaimStatus struct {
 	// ClaimName is the PVC name.
 	ClaimName string `json:"claimName"`
+	// Attached indicates the attach status of a PVC.
 	// If volume is not attached, Attached will be set to false.
 	// If volume is attached, Attached will be set to true.
 	// If volume is detached successfully, its entry will be removed from VolumeStatus.
@@ -103,30 +115,33 @@ type PersistentVolumeClaimStatus struct {
 	Error string `json:"error,omitempty"`
 	// CnsVolumeID is the volume ID for the PVC.
 	CnsVolumeID string `json:"cnsVolumeId,omitempty"`
-	// Diskuuid is the ID obtained when volume is attached to a VM.
-	Diskuuid string `json:"diskuuid,omitempty"`
+	// DiskUUID is the ID obtained when volume is attached to a VM.
+	DiskUUID string `json:"DiskUUID,omitempty"`
 }
 
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
 // +k8s:openapi-gen=true
 // +kubebuilder:subresource:status
+// +kubebuilder:object:root=true
+// +kubebuilder:resource:shortName=batchattach
+// +kubebuilder:printcolumn:name="NodeUUID",type="string",JSONPath=".spec.nodeUUID"
 
-// CnsNodeVmBatchAttachment is the Schema for the cnsnodevmbatchattachments API
-type CnsNodeVmBatchAttachment struct {
+// CnsNodeVMBatchAttachment is the Schema for the cnsnodevmbatchattachments API
+type CnsNodeVMBatchAttachment struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   CnsNodeVmBatchAttachmentSpec   `json:"spec,omitempty"`
-	Status CnsNodeVmBatchAttachmentStatus `json:"status,omitempty"`
+	Spec   CnsNodeVMBatchAttachmentSpec   `json:"spec,omitempty"`
+	Status CnsNodeVMBatchAttachmentStatus `json:"status,omitempty"`
 }
 
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 
-// CnsNodeVmBatchAttachmentList contains a list of CnsNodeVmBatchAttachment
-type CnsNodeVmBatchAttachmentList struct {
+// CnsNodeVMBatchAttachmentList contains a list of CnsNodeVMBatchAttachment
+type CnsNodeVMBatchAttachmentList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
-	Items           []CnsNodeVmBatchAttachment `json:"items"`
+	Items           []CnsNodeVMBatchAttachment `json:"items"`
 }

pkg/apis/cnsoperator/cnsnodevmbatchattachment/v1alpha1/zz_generated.deepcopy.go

@@ -8,16 +8,22 @@ metadata:
 spec:
   group: cns.vmware.com
   names:
-    kind: CnsNodeVmBatchAttachment
-    listKind: CnsNodeVmBatchAttachmentList
+    kind: CnsNodeVMBatchAttachment
+    listKind: CnsNodeVMBatchAttachmentList
     plural: cnsnodevmbatchattachments
+    shortNames:
+    - batchattach
     singular: cnsnodevmbatchattachment
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - jsonPath: .spec.nodeUUID
+      name: NodeUUID
+      type: string
+    name: v1alpha1
     schema:
       openAPIV3Schema:
-        description: CnsNodeVmBatchAttachment is the Schema for the cnsnodevmbatchattachments
+        description: CnsNodeVMBatchAttachment is the Schema for the cnsnodevmbatchattachments
           API
         properties:
           apiVersion:
@@ -38,13 +44,13 @@ spec:
           metadata:
             type: object
           spec:
-            description: CnsNodeVmBatchAttachmentSpec defines the desired state of
-              CnsNodeVmBatchAttachment
+            description: CnsNodeVMBatchAttachmentSpec defines the desired state of
+              CnsNodeVMBatchAttachment
             properties:
-              nodeuuid:
+              nodeUUID:
                 description: |-
                   NodeUUID indicates the UUID of the node where the volume needs to be attached to.
-                  Here NodeUUID is the bios UUID of the node.
+                  Here NodeUUID is the instance UUID of the node.
                 type: string
               volumes:
                 description: VolumeSpec reflects the desired state for each volume.
@@ -67,10 +73,17 @@ spec:
                         diskMode:
                           description: DiskMode is the desired mode to use when attaching
                             the volume
+                          enum:
+                          - independent_persistent
+                          - persistent
+                          - independent_nonpersistent
                           type: string
                         sharingMode:
-                          description: SharingMode indicates the shraring mode if
-                            the virtual disk while attaching.
+                          description: SharingMode indicates the sharing mode if the
+                            virtual disk while attaching.
+                          enum:
+                          - sharingMultiWriter
+                          - sharingNone
                           type: string
                         unitNumber:
                           description: UnitNumber of this device on its controller.
@@ -87,12 +100,12 @@ spec:
                 - name
                 x-kubernetes-list-type: map
             required:
-            - nodeuuid
+            - nodeUUID
             - volumes
             type: object
           status:
-            description: CnsNodeVmBatchAttachmentStatus defines the observed state
-              of CnsNodeVmBatchAttachment
+            description: CnsNodeVMBatchAttachmentStatus defines the observed state
+              of CnsNodeVMBatchAttachment
             properties:
               error:
                 description: Error is the overall error status for the instance.
@@ -108,8 +121,13 @@ spec:
                       description: PersistentVolumeClaim contains details about the
                         volume's current state.
                       properties:
+                        DiskUUID:
+                          description: DiskUUID is the ID obtained when volume is
+                            attached to a VM.
+                          type: string
                         attached:
                           description: |-
+                            Attached indicates the attach status of a PVC.
                             If volume is not attached, Attached will be set to false.
                             If volume is attached, Attached will be set to true.
                             If volume is detached successfully, its entry will be removed from VolumeStatus.
@@ -120,10 +138,6 @@ spec:
                         cnsVolumeId:
                           description: CnsVolumeID is the volume ID for the PVC.
                           type: string
-                        diskuuid:
-                          description: Diskuuid is the ID obtained when volume is
-                            attached to a VM.
-                          type: string
                         error:
                           description: Error indicates the error which may have occurred
                             during attach/detach.
@@ -151,4 +165,4 @@ status:
     kind: ""
     plural: ""
   conditions: []
-  storedVersions: []
+  storedVersions: []

pkg/apis/cnsoperator/config/cns.vmware.com_cnsnodevmbatchattachments.yaml

@@ -8,7 +8,7 @@ var EmbedCnsNodeVmAttachmentCRFile embed.FS
 const EmbedCnsNodeVmAttachmentCRFileName = "cns.vmware.com_cnsnodevmattachments.yaml"
 
 //go:embed cns.vmware.com_cnsnodevmbatchattachments.yaml
-var EmbedCnsNodeVmBatchAttachmentCRFile embed.FS
+var EmbedCnsNodeVMBatchAttachmentCRFile embed.FS
 
 const EmbedCnsNodeVmABatchttachmentCRFileName = "cns.vmware.com_cnsnodevmbatchattachments.yaml"
 

pkg/apis/cnsoperator/config/config.go

@@ -51,8 +51,8 @@ var (
 	CnsNodeVMAttachmentSingular = "cnsnodevmattachment"
 	// CnsNodeVMAttachmentPlural is plural of CnsNodeVmAttachment
 	CnsNodeVMAttachmentPlural = "cnsnodevmattachments"
-	// CnsNodeVmBatchAttachmentPlural is plural of CnsNodeVmBatchAttachment
-	CnsNodeVmBatchAttachmentPlural = "cnsnodevmbatchattachments"
+	// CnsNodeVMBatchAttachmentPlural is plural of CnsNodeVMBatchAttachment
+	CnsNodeVMBatchAttachmentPlural = "cnsnodevmbatchattachments"
 	// CnsVolumeMetadataSingular is Singular of CnsVolumeMetadata
 	CnsVolumeMetadataSingular = "cnsvolumemetadata"
 	// CnsVolumeMetadataPlural is plural of CnsVolumeMetadata
@@ -133,8 +133,8 @@ func addKnownTypes(scheme *runtime.Scheme) error {
 
 	scheme.AddKnownTypes(
 		SchemeGroupVersion,
-		&cnsnodevmbatchattachmentv1alpha1.CnsNodeVmBatchAttachment{},
-		&cnsnodevmbatchattachmentv1alpha1.CnsNodeVmBatchAttachmentList{},
+		&cnsnodevmbatchattachmentv1alpha1.CnsNodeVMBatchAttachment{},
+		&cnsnodevmbatchattachmentv1alpha1.CnsNodeVMBatchAttachmentList{},
 	)
 
 	scheme.AddKnownTypes(

pkg/apis/cnsoperator/register.go

@@ -41,7 +41,7 @@ import (
 type BatchAttachRequest struct {
 	// The volume ID for the given PVC.
 	VolumeID string
-	// SharingMode indicates the shraring mode if the virtual disk while attaching.
+	// SharingMode indicates the sharing mode if the virtual disk while attaching.
 	SharingMode string
 	// DiskMode is the desired mode to use when attaching the volume
 	DiskMode string