feat: Change field of IntOrStringStore

Makefile

@@ -56,6 +56,10 @@ vet:
 generate: controller-gen
 	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."
 
+# Generate doc
+generate-doc:
+	./scripts/gen-doc.sh
+
 # Build the docker image
 docker-build: test 
 	docker build . -t $(REGISTRY)/onecloud-service-operator:$(VERSION)

api/v1/value.go

@@ -30,14 +30,14 @@ type IValue interface {
 
 // +kubebuilder:object:generate=false
 type IStore interface {
-	Value(ctx context.Context) (IValue, error)
+	GetValue(ctx context.Context) (IValue, error)
 }
 
 type StringStore struct {
 	// +optional
-	Direct string `json:"direct,omitempty"`
+	Value string `json:"value,omitempty"`
 	// +optional
-	Indirect *ObjectFieldReference `json:"indirect,omitempty"`
+	Reference *ObjectFieldReference `json:"reference,omitempty"`
 }
 
 type String string
@@ -54,11 +54,11 @@ func (sv String) Interface() interface{} {
 	return sv.String()
 }
 
-func (st *StringStore) Value(ctx context.Context) (IValue, error) {
-	if len(st.Direct) > 0 {
-		return String(st.Direct), nil
+func (st *StringStore) GetValue(ctx context.Context) (IValue, error) {
+	if len(st.Value) > 0 {
+		return String(st.Value), nil
 	}
-	in, err := st.Indirect.Value(ctx)
+	in, err := st.Reference.Value(ctx)
 	if err != nil {
 		return nil, err
 	}
@@ -75,9 +75,9 @@ func (st *StringStore) Value(ctx context.Context) (IValue, error) {
 
 type IntOrStringStore struct {
 	// +optional
-	Direct *IntOrString `json:"direct,omitempty"`
+	Value *IntOrString `json:"value,omitempty"`
 	// +optional
-	Indirect *ObjectFieldReference `json:"indirect,omitempty"`
+	Reference *ObjectFieldReference `json:"reference,omitempty"`
 }
 
 type IntOrString struct {
@@ -121,11 +121,11 @@ func (isv *IntOrString) Interface() interface{} {
 	return isv
 }
 
-func (ist *IntOrStringStore) Value(ctx context.Context) (IValue, error) {
-	if ist.Direct != nil {
-		return ist.Direct, nil
+func (ist *IntOrStringStore) GetValue(ctx context.Context) (IValue, error) {
+	if ist.Value != nil {
+		return ist.Value, nil
 	}
-	in, err := ist.Indirect.Value(ctx)
+	in, err := ist.Reference.Value(ctx)
 	if err != nil {
 		return nil, err
 	}

config/crd/bases/onecloud.yunion.io_ansibleplaybooks.yaml

@@ -43,13 +43,7 @@ spec:
                   vars:
                     additionalProperties:
                       properties:
-                        direct:
-                          anyOf:
-                          - type: integer
-                          - type: string
-                          type: object
-                          x-kubernetes-int-or-string: true
-                        indirect:
+                        reference:
                           properties:
                             fieldPath:
                               type: string
@@ -69,6 +63,12 @@ spec:
                           - name
                           - namespace
                           type: object
+                        value:
+                          anyOf:
+                          - type: integer
+                          - type: string
+                          type: object
+                          x-kubernetes-int-or-string: true
                       type: object
                     description: Vars describes the unique values ​​of the VirtualMachine
                       corresponding to the variables in the AnsiblePlaybookTemplate.
@@ -148,13 +148,7 @@ spec:
             vars:
               additionalProperties:
                 properties:
-                  direct:
-                    anyOf:
-                    - type: integer
-                    - type: string
-                    type: object
-                    x-kubernetes-int-or-string: true
-                  indirect:
+                  reference:
                     properties:
                       fieldPath:
                         type: string
@@ -174,6 +168,12 @@ spec:
                     - name
                     - namespace
                     type: object
+                  value:
+                    anyOf:
+                    - type: integer
+                    - type: string
+                    type: object
+                    x-kubernetes-int-or-string: true
                 type: object
               description: Vars describe the public value about Vars in AnsiblePlaybookTemplate.
               type: object

config/samples/jenkins-slave.yaml

@@ -10,15 +10,15 @@ spec:
         name: jenkins-slave1
       vars:
         jenkins_slave_name:
-          direct: slave1
+          value: slave1
     - virtualMachine:
         name: jenkins-slave2
       vars:
         jenkins_slave_name:
-          direct: slave2
+          value: slave2
   vars:
     jenkins_master_hostname:
-      indirect:
+      reference:
         kind: VirtualMachine
         namespace: onecloud
         name: jenkins-master

controllers/ansibleplaybook_controller.go

@@ -184,10 +184,10 @@ func (r *AnsiblePlaybookReconciler) Reconcile(req ctrl.Request) (ctrl.Result, er
 			vars := make(map[string]interface{}, len(host.Vars))
 			for _, temVar := range playbookTemplate.Spec.Vars {
 				if value, ok := host.Vars[temVar.Name]; ok {
-					v, err := value.Value(ctx)
+					v, err := value.GetValue(ctx)
 					if err != nil {
 						// invalid
-						log.Error(err, "StringStore.Value")
+						log.Error(err, "StringStore.GetValue")
 						ansiblePlaybook.SetResourcePhase(onecloudv1.ResourceInvalid,
 							fmt.Sprintf("The value of var '%s' is valid: %s", temVar.Name, err.Error()),
 						)
@@ -232,10 +232,10 @@ func (r *AnsiblePlaybookReconciler) Reconcile(req ctrl.Request) (ctrl.Result, er
 		// build common vars
 		commonVars := make(map[string]interface{}, len(ansiblePlaybook.Spec.Vars))
 		for varName, sv := range ansiblePlaybook.Spec.Vars {
-			vv, err := sv.Value(ctx)
+			vv, err := sv.GetValue(ctx)
 			if err != nil {
 				// invalid
-				log.Error(err, "StringStore.Value")
+				log.Error(err, "StringStore.GetValue")
 				ansiblePlaybook.SetResourcePhase(onecloudv1.ResourceInvalid,
 					fmt.Sprintf("The value of var '%s' is valid: %s", varName, err.Error()),
 				)