chore: opsdefinition env support optional setting (#9435)

Author: xuriwuyun

apis/apps/v1alpha1/opsdefinition_types.go

@@ -158,6 +158,11 @@ type OpsEnvVar struct {
 	//
 	// +kubebuilder:validation:Required
 	ValueFrom *OpsVarSource `json:"valueFrom"`
+
+	// Specify whether the ENV must be defined.
+	//
+	// +optional
+	Optional *bool `json:"optional,omitempty"`
 }
 
 // +kubebuilder:validation:XValidation:rule="has(self.envRef) || has(self.fieldPath)", message="either fieldPath and envRef."

apis/apps/v1alpha1/zz_generated.deepcopy.go

@@ -7688,6 +7688,9 @@ spec:
                               Specifies the name of the environment variable to be injected into Pods executing OpsActions.
                               It must conform to the C_IDENTIFIER format, which includes only alphanumeric characters and underscores, and cannot begin with a digit.
                             type: string
+                          optional:
+                            description: Specify whether the ENV must be defined.
+                            type: boolean
                           valueFrom:
                             description: Specifies the source of the environment variable's
                               value.

config/crd/bases/apps.kubeblocks.io_opsdefinitions.yaml

@@ -162,6 +162,9 @@ func buildEnvVars(reqCtx intctrlutil.RequestCtx,
 			envVar, err = buildVarWithFieldPath(targetPod, vars[i].ValueFrom.FieldRef.FieldPath)
 		}
 		if envVar == nil {
+			if vars[i].Optional != nil && *vars[i].Optional {
+				continue
+			}
 			return nil, intctrlutil.NewFatalError(fmt.Sprintf(`can not find the env "%s" in the container "%s"`, envVarRef.EnvName, envVarRef.TargetContainerName))
 		}
 		envVar.Name = vars[i].Name

controllers/apps/operations/custom/utils.go

@@ -7688,6 +7688,9 @@ spec:
                               Specifies the name of the environment variable to be injected into Pods executing OpsActions.
                               It must conform to the C_IDENTIFIER format, which includes only alphanumeric characters and underscores, and cannot begin with a digit.
                             type: string
+                          optional:
+                            description: Specify whether the ENV must be defined.
+                            type: boolean
                           valueFrom:
                             description: Specifies the source of the environment variable's
                               value.

deploy/helm/crds/apps.kubeblocks.io_opsdefinitions.yaml

@@ -16,6 +16,7 @@ spec:
             envRef:
               envName: KB_POD_IP
         - name: SYNCER_SERVICE_PORT
+          optional: true
           valueFrom:
             envRef:
               envName: SYNCER_SERVICE_PORT

deploy/helm/templates/opsdefinition.yaml

@@ -15194,6 +15194,18 @@ OpsVarSource
 <p>Specifies the source of the environment variable&rsquo;s value.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>optional</code><br/>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Specify whether the ENV must be defined.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="apps.kubeblocks.io/v1alpha1.OpsExecAction">OpsExecAction