From 44d7459e6407d653d56c612cf8e3026fc6843dd6 Mon Sep 17 00:00:00 2001 From: wangyelei Date: Sat, 12 Oct 2024 07:30:37 +0000 Subject: [PATCH] chore: auto update cli doc changes --- docs/user_docs/cli/cli.md | 2 +- docs/user_docs/cli/kbcli_cluster.md | 2 +- docs/user_docs/cli/kbcli_cluster_rebuild-instance.md | 5 +++-- docs/user_docs/cli/kbcli_cluster_upgrade.md | 5 ++--- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/user_docs/cli/cli.md b/docs/user_docs/cli/cli.md index 79450a788..2e764c12a 100644 --- a/docs/user_docs/cli/cli.md +++ b/docs/user_docs/cli/cli.md @@ -72,7 +72,7 @@ Cluster command. * [kbcli cluster start](kbcli_cluster_start.md) - Start the cluster if cluster is stopped. * [kbcli cluster stop](kbcli_cluster_stop.md) - Stop the cluster and release all the pods of the cluster. * [kbcli cluster update](kbcli_cluster_update.md) - Update the cluster settings, such as enable or disable monitor or log. -* [kbcli cluster upgrade](kbcli_cluster_upgrade.md) - Upgrade the cluster version. +* [kbcli cluster upgrade](kbcli_cluster_upgrade.md) - Upgrade the service version(only support to upgrade minor version). * [kbcli cluster volume-expand](kbcli_cluster_volume-expand.md) - Expand volume with the specified components and volumeClaimTemplates in the cluster. * [kbcli cluster vscale](kbcli_cluster_vscale.md) - Vertically scale the specified components in the cluster. diff --git a/docs/user_docs/cli/kbcli_cluster.md b/docs/user_docs/cli/kbcli_cluster.md index 41dfc04f6..6e32975e0 100644 --- a/docs/user_docs/cli/kbcli_cluster.md +++ b/docs/user_docs/cli/kbcli_cluster.md @@ -75,7 +75,7 @@ Cluster command. * [kbcli cluster start](kbcli_cluster_start.md) - Start the cluster if cluster is stopped. * [kbcli cluster stop](kbcli_cluster_stop.md) - Stop the cluster and release all the pods of the cluster. * [kbcli cluster update](kbcli_cluster_update.md) - Update the cluster settings, such as enable or disable monitor or log. -* [kbcli cluster upgrade](kbcli_cluster_upgrade.md) - Upgrade the cluster version. +* [kbcli cluster upgrade](kbcli_cluster_upgrade.md) - Upgrade the service version(only support to upgrade minor version). * [kbcli cluster volume-expand](kbcli_cluster_volume-expand.md) - Expand volume with the specified components and volumeClaimTemplates in the cluster. * [kbcli cluster vscale](kbcli_cluster_vscale.md) - Vertically scale the specified components in the cluster. diff --git a/docs/user_docs/cli/kbcli_cluster_rebuild-instance.md b/docs/user_docs/cli/kbcli_cluster_rebuild-instance.md index a44853139..db3b1dfff 100644 --- a/docs/user_docs/cli/kbcli_cluster_rebuild-instance.md +++ b/docs/user_docs/cli/kbcli_cluster_rebuild-instance.md @@ -24,13 +24,14 @@ kbcli cluster rebuild-instance NAME [flags] --auto-approve Skip interactive approval before rebuilding the instances.gi --backup string instances will be rebuild by the specified backup. --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") - --env stringArray provide the necessary env for the 'Restore' operation from the backup. format: key1=value, key2=value --force skip the pre-checks of the opsRequest to run the opsRequest forcibly -h, --help help for rebuild-instance + --in-place rebuild the instance with the same pod name --instances strings instances which need to rebuild. --name string OpsRequest name. if not specified, it will be randomly generated - --node strings specified the target node which rebuilds the instance on the node otherwise will rebuild on a randon node. format: insName1=nodeName,insName2=nodeName + --node strings specified the target node which rebuilds the instance on the node otherwise will rebuild on a random node. format: insName1=nodeName,insName2=nodeName -o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) + --restore-env stringArray provide the necessary env for the 'Restore' operation from the backup. format: key1=value, key2=value --ttlSecondsAfterSucceed int Time to live after the OpsRequest succeed ``` diff --git a/docs/user_docs/cli/kbcli_cluster_upgrade.md b/docs/user_docs/cli/kbcli_cluster_upgrade.md index 5ffdcf3d5..3a32e9050 100644 --- a/docs/user_docs/cli/kbcli_cluster_upgrade.md +++ b/docs/user_docs/cli/kbcli_cluster_upgrade.md @@ -2,7 +2,7 @@ title: kbcli cluster upgrade --- -Upgrade the cluster version. +Upgrade the service version(only support to upgrade minor version). ``` kbcli cluster upgrade NAME [flags] @@ -19,8 +19,7 @@ kbcli cluster upgrade NAME [flags] ``` --auto-approve Skip interactive approval before upgrading the cluster - --cluster-version string Referring to the ClusterVersion CR(deprecated) - --component-definition string Referring to the ComponentDefinition (default "nil") + --component-def string Referring to the ComponentDefinition (default "nil") --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") --force skip the pre-checks of the opsRequest to run the opsRequest forcibly