chore: mark switchover scriptSpec selector field deprecated (apecloud…

…#6733)
rustrover · Mar 4, 2024 · 2e52a56 · 2e52a56
1 parent 1763ff5
commit 2e52a56
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/apis/apps/v1alpha1/clusterdefinition_types.go b/apis/apps/v1alpha1/clusterdefinition_types.go
@@ -1012,6 +1012,7 @@ type SwitchoverAction struct {
 	// Used to select the script that need to be referenced.
 	// When defined, the scripts defined in scriptSpecs can be referenced within the SwitchoverAction.CmdExecutorConfig.
 	//
+	// +kubebuilder:deprecatedversion:warning="This field is deprecated from KB 0.9.0"
 	// +optional
 	ScriptSpecSelectors []ScriptSpecSelector `json:"scriptSpecSelectors,omitempty"`
 }

diff --git a/apis/apps/v1alpha1/componentdefinition_types.go b/apis/apps/v1alpha1/componentdefinition_types.go
@@ -809,6 +809,7 @@ type ComponentSwitchover struct {
 	// Used to define the selectors for the scriptSpecs that need to be referenced.
 	// When this field is defined, the scripts specified in the scripts field can be referenced in the Action.
 	//
+	// +kubebuilder:deprecatedversion:warning="This field is deprecated from KB 0.9.0"
 	// +optional
 	ScriptSpecSelectors []ScriptSpecSelector `json:"scriptSpecSelectors,omitempty"`
 }

diff --git a/docs/developer_docs/api-reference/cluster.md b/docs/developer_docs/api-reference/cluster.md
@@ -9971,7 +9971,8 @@ If set to Enable, the corresponding service will be exposed. Conversely, if set
 </em>
 </td>
 <td>
-<p>A list of services that are to be exposed or removed.</p>
+<p>A list of services that are to be exposed or removed.
+If componentNamem is not specified, each <code>OpsService</code> in the list must specify ports and selectors.</p>
 </td>
 </tr>
 </tbody>