Minor spec comments update (#1042)

Signed-off-by: Prajyot-Parab <[email protected]>

Signed-off-by: Prajyot-Parab <[email protected]>

Author: Prajyot-Parab

api/v1beta2/ibmpowervsmachine_types.go

@@ -54,7 +54,8 @@ type IBMPowerVSMachineSpec struct {
 	// SSHKey is the name of the SSH key pair provided to the vsi for authenticating users.
 	SSHKey string `json:"sshKey,omitempty"`
 
-	// Image is the reference to the Image from which to create the machine instance.
+	// Image the reference to the image which is used to create the instance.
+	// supported image identifier in IBMPowerVSResourceReference are Name and ID and that can be obtained from IBM Cloud UI or IBM Cloud cli.
 	// +optional
 	Image *IBMPowerVSResourceReference `json:"image,omitempty"`
 
@@ -114,15 +115,16 @@ type IBMPowerVSMachineSpec struct {
 	MemoryGiB int32 `json:"memoryGiB,omitempty"`
 
 	// Network is the reference to the Network to use for this instance.
+	// supported network identifier in IBMPowerVSResourceReference are Name, ID and RegEx and that can be obtained from IBM Cloud UI or IBM Cloud cli.
 	Network IBMPowerVSResourceReference `json:"network"`
 
 	// ProviderID is the unique identifier as specified by the cloud provider.
 	// +optional
 	ProviderID *string `json:"providerID,omitempty"`
 }
 
-// IBMPowerVSResourceReference is a reference to a specific PowerVS resource by ID or Name
-// Only one of ID or Name may be specified. Specifying more than one will result in
+// IBMPowerVSResourceReference is a reference to a specific PowerVS resource by ID, Name or RegEx
+// Only one of ID, Name or RegEx may be specified. Specifying more than one will result in
 // a validation error.
 type IBMPowerVSResourceReference struct {
 	// ID of resource

config/crd/bases/infrastructure.cluster.x-k8s.io_ibmpowervsmachines.yaml

@@ -329,8 +329,10 @@ spec:
             description: IBMPowerVSMachineSpec defines the desired state of IBMPowerVSMachine.
             properties:
               image:
-                description: Image is the reference to the Image from which to create
-                  the machine instance.
+                description: Image the reference to the image which is used to create
+                  the instance. supported image identifier in IBMPowerVSResourceReference
+                  are Name and ID and that can be obtained from IBM Cloud UI or IBM
+                  Cloud cli.
                 properties:
                   id:
                     description: ID of resource
@@ -372,7 +374,9 @@ spec:
                 type: integer
               network:
                 description: Network is the reference to the Network to use for this
-                  instance.
+                  instance. supported network identifier in IBMPowerVSResourceReference
+                  are Name, ID and RegEx and that can be obtained from IBM Cloud UI
+                  or IBM Cloud cli.
                 properties:
                   id:
                     description: ID of resource

config/crd/bases/infrastructure.cluster.x-k8s.io_ibmpowervsmachinetemplates.yaml

@@ -183,8 +183,10 @@ spec:
                       IBMPowerVSMachine.
                     properties:
                       image:
-                        description: Image is the reference to the Image from which
-                          to create the machine instance.
+                        description: Image the reference to the image which is used
+                          to create the instance. supported image identifier in IBMPowerVSResourceReference
+                          are Name and ID and that can be obtained from IBM Cloud
+                          UI or IBM Cloud cli.
                         properties:
                           id:
                             description: ID of resource
@@ -227,7 +229,9 @@ spec:
                         type: integer
                       network:
                         description: Network is the reference to the Network to use
-                          for this instance.
+                          for this instance. supported network identifier in IBMPowerVSResourceReference
+                          are Name, ID and RegEx and that can be obtained from IBM
+                          Cloud UI or IBM Cloud cli.
                         properties:
                           id:
                             description: ID of resource