Fix typos and structure parameter comments

Fixed some typos in the test-operator code and reordered
parameter comments to ensure a consistent structure across all
resource types.

Author: kstrenkova

api/bases/test.openstack.org_ansibletests.yaml

@@ -55,13 +55,13 @@ spec:
                 type: string
               ansibleCollections:
                 default: ""
-                description: AnsibleCollections - extra ansible collections to instal
-                  in additionn to the ones exist in the requirements.yaml
+                description: |-
+                  AnsibleCollections - extra ansible collections to install in addition
+                  to the ones existing in the requirements.yaml
                 type: string
               ansibleExtraVars:
                 default: ""
                 description: AnsibleExtraVars - string to pass parameters to ansible
-                  using
                 type: string
               ansibleGitRepo:
                 default: ""
@@ -78,8 +78,10 @@ spec:
                 type: string
               ansibleVarFiles:
                 default: ""
-                description: AnsibleVarFiles - interface to create ansible var files
-                  Those get added to the
+                description: |-
+                  AnsibleVarFiles - interface to create ansible var files. Those get added
+                  to the service config dir in /etc/test_operator/<file> and passed to the
+                  ansible command using -e @/etc/test_operator/<file>
                 type: string
               backoffLimit:
                 default: 0
@@ -1334,8 +1336,9 @@ spec:
                         operator.
                       type: string
                     ansibleCollections:
-                      description: AnsibleCollections - extra ansible collections
-                        to instal in additionn to the ones exist in the requirements.yaml
+                      description: |-
+                        AnsibleCollections - extra ansible collections to install in addition
+                        to the ones existing in the requirements.yaml
                       type: string
                     ansibleExtraVars:
                       description: AnsibleExtraVars - interface to pass parameters
@@ -1353,8 +1356,9 @@ spec:
                       type: string
                     ansibleVarFiles:
                       description: |-
-                        AnsibleVarFiles - interface to create ansible var files Those get added to the
-                        service config dir in /etc/test_operator/<file> and passed to the ansible command using -e @/etc/test_operator/<file>
+                        AnsibleVarFiles - interface to create ansible var files. Those get added
+                        to the service config dir in /etc/test_operator/<file> and passed to the
+                        ansible command using -e @/etc/test_operator/<file>
                       type: string
                     backoffLimit:
                       default: 0

api/bases/test.openstack.org_tempests.yaml

@@ -1393,7 +1393,7 @@ spec:
                               description: Cloud that should be used for authentication
                               type: string
                             vcpus:
-                              description: How many vcpus should be be allocated when
+                              description: How many vcpus should be allocated when
                                 this flavor is used
                               format: int64
                               type: integer
@@ -1584,7 +1584,7 @@ spec:
                   testAccounts:
                     default: ""
                     description: A content of accounts.yaml that is passed to tempest
-                      via --test-acounts
+                      via --test-accounts
                     type: string
                   timeout:
                     default: 0
@@ -1642,7 +1642,7 @@ spec:
                 type: array
               workflow:
                 description: |-
-                  Workflow - can be used to specify a multiple executions of tempest with
+                  Workflow - can be used to specify multiple executions of tempest with
                   a different configuration in a single CR. Accepts a list of dictionaries
                   where each member of the list accepts the same values as the Tempest CR
                   does in the `spec`` section. Values specified using the workflow section have
@@ -1862,7 +1862,7 @@ spec:
                             - repository
                             type: object
                           type: array
-                        extraImagesType:
+                        extraImages:
                           description: |-
                             Extra images that should be downloaded inside the test pod and uploaded to
                             openstack.
@@ -1916,7 +1916,7 @@ spec:
                                     description: Cloud that should be used for authentication
                                     type: string
                                   vcpus:
-                                    description: How many vcpus should be be allocated
+                                    description: How many vcpus should be allocated
                                       when this flavor is used
                                     format: int64
                                     type: integer
@@ -2080,7 +2080,7 @@ spec:
                           type: boolean
                         testAccounts:
                           description: A content of accounts.yaml that is passed to
-                            tempest via --test-acounts
+                            tempest via --test-accounts
                           type: string
                         timeout:
                           description: |-

api/bases/test.openstack.org_tobikoes.yaml

@@ -1182,7 +1182,7 @@ spec:
               numProcesses:
                 default: 4
                 description: Number of processes/workers used to run tobiko tests
-                  - value 0 results in automatic decission
+                  - value 0 results in automatic decision
                 type: integer
               parallel:
                 default: false

api/v1beta1/ansibletest_types.go

@@ -22,9 +22,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // AnsibleTestSpec defines the desired state of AnsibleTest
 type AnsibleTestSpec struct {
 	CommonOptions         `json:",inline"`
@@ -35,66 +32,68 @@ type AnsibleTestSpec struct {
 	// spawned using the AnsibleTest CR. https://pkg.go.dev/k8s.io/api/core/v1#ResourceRequirements
 	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:default:="dataplane-ansible-ssh-private-key-secret"
 	// ComputeSSHKeySecretName is the name of the k8s secret that contains an ssh key for computes.
 	// The key is mounted to ~/.ssh/id_ecdsa in the ansible pod
 	ComputesSSHKeySecretName string `json:"computeSSHKeySecretName"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:default:=""
 	// WorkloadSSHKeySecretName is the name of the k8s secret that contains an ssh key for the ansible workload.
 	// The key is mounted to ~/test_keypair.key in the ansible pod
 	WorkloadSSHKeySecretName string `json:"workloadSSHKeySecretName"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Required
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:default:=""
 	// AnsibleGitRepo - git repo to clone into container
 	AnsibleGitRepo string `json:"ansibleGitRepo"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Required
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:default:=""
 	// AnsiblePlaybookPath - path to ansible playbook
 	AnsiblePlaybookPath string `json:"ansiblePlaybookPath"`
 
+	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// +kubebuilder:validation:optional
 	// +kubebuilder:default:=""
-	// AnsibleCollections - extra ansible collections to instal in additionn to the ones exist in the requirements.yaml
+	// AnsibleCollections - extra ansible collections to install in addition
+	// to the ones existing in the requirements.yaml
 	AnsibleCollections string `json:"ansibleCollections,omitempty"`
 
+	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// +kubebuilder:validation:optional
 	// +kubebuilder:default:=""
-	// AnsibleVarFiles - interface to create ansible var files Those get added to the
+	// AnsibleVarFiles - interface to create ansible var files. Those get added
+	// to the service config dir in /etc/test_operator/<file> and passed to the
+	// ansible command using -e @/etc/test_operator/<file>
 	AnsibleVarFiles string `json:"ansibleVarFiles,omitempty"`
 
+	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// +kubebuilder:validation:optional
 	// +kubebuilder:default:=""
-	// AnsibleExtraVars - string to pass parameters to ansible using
+	// AnsibleExtraVars - string to pass parameters to ansible
 	AnsibleExtraVars string `json:"ansibleExtraVars,omitempty"`
 
+	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// +kubebuilder:validation:optional
 	// +kubebuilder:default:=""
 	// AnsibleInventory - string that contains the inventory file content
 	AnsibleInventory string `json:"ansibleInventory,omitempty"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:default:=false
 	// Run ansible playbook with -vvvv
 	Debug bool `json:"debug"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// A parameter that contains a workflow definition.
 	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:number"}
+	// A parameter that contains a workflow definition.
 	Workflow []AnsibleTestWorkflowSpec `json:"workflow,omitempty"`
 }
 
@@ -113,51 +112,53 @@ type AnsibleTestWorkflowSpec struct {
 	// spawned using the AnsibleTest CR. https://pkg.go.dev/k8s.io/api/core/v1#ResourceRequirements
 	Resources *corev1.ResourceRequirements `json:"resources,omitempty"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// ComputeSSHKeySecretName is the name of the k8s secret that contains an ssh key for computes.
 	// The key is mounted to ~/.ssh/id_ecdsa in the ansible pod
 	ComputesSSHKeySecretName string `json:"computeSSHKeySecretName"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// WorkloadSSHKeySecretName is the name of the k8s secret that contains an ssh key for the ansible workload.
 	// The key is mounted to ~/test_keypair.key in the ansible pod
 	WorkloadSSHKeySecretName string `json:"workloadSSHKeySecretName"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// AnsibleGitRepo - git repo to clone into container
 	AnsibleGitRepo string `json:"ansibleGitRepo,omitempty"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// AnsiblePlaybookPath - path to ansible playbook
 	AnsiblePlaybookPath string `json:"ansiblePlaybookPath,omitempty"`
 
+	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// +kubebuilder:validation:optional
-	// AnsibleCollections - extra ansible collections to instal in additionn to the ones exist in the requirements.yaml
+	// AnsibleCollections - extra ansible collections to install in addition
+	// to the ones existing in the requirements.yaml
 	AnsibleCollections string `json:"ansibleCollections,omitempty"`
 
+	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// +kubebuilder:validation:optional
-	// AnsibleVarFiles - interface to create ansible var files Those get added to the
-	// service config dir in /etc/test_operator/<file> and passed to the ansible command using -e @/etc/test_operator/<file>
+	// AnsibleVarFiles - interface to create ansible var files. Those get added
+	// to the service config dir in /etc/test_operator/<file> and passed to the
+	// ansible command using -e @/etc/test_operator/<file>
 	AnsibleVarFiles string `json:"ansibleVarFiles,omitempty"`
 
+	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// +kubebuilder:validation:optional
 	// AnsibleExtraVars - interface to pass parameters to ansible using -e
 	AnsibleExtraVars string `json:"ansibleExtraVars,omitempty"`
 
+	// +kubebuilder:validation:Optional
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
-	// +kubebuilder:validation:optional
 	// AnsibleInventory - string that contains the inventory file content
 	AnsibleInventory string `json:"ansibleInventory,omitempty"`
 
-	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// +kubebuilder:validation:Optional
+	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	// Run ansible playbook with -vvvv
 	Debug bool `json:"debug,omitempty"`
 }