chore: auto update cli doc changes

apecloud · Nov 22, 2024 · bc55b45 · bc55b45
1 parent 5cd0151
commit bc55b45
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/docs/user_docs/cli/kbcli_cluster_custom-ops.md b/docs/user_docs/cli/kbcli_cluster_custom-ops.md
@@ -57,11 +57,6 @@ kbcli cluster custom-ops OpsDef --cluster <clusterName> <your custom params> [fl
 ### SEE ALSO
 
 * [kbcli cluster](kbcli_cluster.md)	 - Cluster command.
-* [kbcli cluster custom-ops etcd-defragmentation](kbcli_cluster_custom-ops_etcd-defragmentation.md)	 - Create a custom ops with opsDef etcd-defragmentation
-* [kbcli cluster custom-ops kafka-quota](kbcli_cluster_custom-ops_kafka-quota.md)	 - Create a custom ops with opsDef kafka-quota
-* [kbcli cluster custom-ops kafka-topic](kbcli_cluster_custom-ops_kafka-topic.md)	 - Create a custom ops with opsDef kafka-topic
-* [kbcli cluster custom-ops kafka-user-acl](kbcli_cluster_custom-ops_kafka-user-acl.md)	 - Create a custom ops with opsDef kafka-user-acl
-* [kbcli cluster custom-ops mysql-orc-switchover](kbcli_cluster_custom-ops_mysql-orc-switchover.md)	 - Create a custom ops with opsDef mysql-orc-switchover
 
 #### Go Back to [CLI Overview](cli.md) Homepage.
 
diff --git a/docs/user_docs/cli/kbcli_cluster_start.md b/docs/user_docs/cli/kbcli_cluster_start.md
@@ -13,11 +13,15 @@ kbcli cluster start NAME [flags]
 ```
   # start the cluster when cluster is stopped
   kbcli cluster start mycluster
+  
+  # start the component of the cluster when cluster is stopped
+  kbcli cluster start mycluster --components=mysql
 ```
 
 ### Options
 
 ```
+      --components strings             Component names to this operations
       --dry-run string[="unchanged"]   Must be "client", or "server". If with client strategy, only print the object that would be sent, and no data is actually sent. If with server strategy, submit the server-side request, but no data is persistent. (default "none")
       --edit                           Edit the API resource before creating
       --force                           skip the pre-checks of the opsRequest to run the opsRequest forcibly

diff --git a/docs/user_docs/cli/kbcli_cluster_stop.md b/docs/user_docs/cli/kbcli_cluster_stop.md
@@ -13,12 +13,16 @@ kbcli cluster stop NAME [flags]
 ```
   # stop the cluster and release all the pods of the cluster
   kbcli cluster stop mycluster
+  
+  # stop the component of the cluster and release all the pods of the component
+  kbcli cluster stop mycluster --components=mysql
 ```
 
 ### Options
 
 ```
       --auto-approve                   Skip interactive approval before stopping the cluster
+      --components strings             Component names to this operations
       --dry-run string[="unchanged"]   Must be "client", or "server". If with client strategy, only print the object that would be sent, and no data is actually sent. If with server strategy, submit the server-side request, but no data is persistent. (default "none")
       --edit                           Edit the API resource before creating
       --force                           skip the pre-checks of the opsRequest to run the opsRequest forcibly