From ba876d40bccc7d65d97b2e0b852fbbae99f27947 Mon Sep 17 00:00:00 2001 From: sophon Date: Fri, 9 Jun 2023 16:31:03 +0800 Subject: [PATCH] update kbcli-doc --- docs/user_docs/cli/cli.md | 1 + docs/user_docs/cli/kbcli_infra.md | 1 + docs/user_docs/cli/kbcli_infra_create.md | 2 + docs/user_docs/cli/kbcli_infra_delete.md | 65 ++++++++++++++++++++++ internal/cli/cmd/infrastructure/cluster.go | 2 +- 5 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 docs/user_docs/cli/kbcli_infra_delete.md diff --git a/docs/user_docs/cli/cli.md b/docs/user_docs/cli/cli.md index 4dc8728bd62..50d1add86e3 100644 --- a/docs/user_docs/cli/cli.md +++ b/docs/user_docs/cli/cli.md @@ -135,6 +135,7 @@ Inject faults to pod. infra command * [kbcli infra create](kbcli_infra_create.md) - create kubernetes cluster. +* [kbcli infra delete](kbcli_infra_delete.md) - delete kubernetes cluster. ## [kubeblocks](kbcli_kubeblocks.md) diff --git a/docs/user_docs/cli/kbcli_infra.md b/docs/user_docs/cli/kbcli_infra.md index 03f64d298de..a7934026e4d 100644 --- a/docs/user_docs/cli/kbcli_infra.md +++ b/docs/user_docs/cli/kbcli_infra.md @@ -38,6 +38,7 @@ infra command * [kbcli infra create](kbcli_infra_create.md) - create kubernetes cluster. +* [kbcli infra delete](kbcli_infra_delete.md) - delete kubernetes cluster. #### Go Back to [CLI Overview](cli.md) Homepage. diff --git a/docs/user_docs/cli/kbcli_infra_create.md b/docs/user_docs/cli/kbcli_infra_create.md index e912528c81d..df1c301542a 100644 --- a/docs/user_docs/cli/kbcli_infra_create.md +++ b/docs/user_docs/cli/kbcli_infra_create.md @@ -18,6 +18,7 @@ kbcli infra create [flags] ### Options ``` + -c, --config string Specify infra cluster config file. [option] --container-runtime string Specify kubernetes container runtime. default is containerd (default "containerd") --debug set debug mode --etcd strings Specify etcd nodes @@ -28,6 +29,7 @@ kbcli infra create [flags] -p, --password string Specify the password for the account to execute sudo. [option] --private-key string The PrimaryKey for ssh to the remote machine. [option] --private-key-path string Specify the file PrimaryKeyPath of ssh to the remote machine. default ~/.ssh/id_rsa. + --sandbox-image string Specified sandbox-image will not be used by the cri. [option] (default "k8s.gcr.io/pause:3.8") -t, --timeout int Specify the ssh timeout.[option] (default 30) -u, --user string Specify the account to access the remote server. [require] --version string Specify install kubernetes version. default version is v1.26.5 (default "v1.26.5") diff --git a/docs/user_docs/cli/kbcli_infra_delete.md b/docs/user_docs/cli/kbcli_infra_delete.md new file mode 100644 index 00000000000..87b402cb6b1 --- /dev/null +++ b/docs/user_docs/cli/kbcli_infra_delete.md @@ -0,0 +1,65 @@ +--- +title: kbcli infra delete +--- + +delete kubernetes cluster. + +``` +kbcli infra delete [flags] +``` + +### Examples + +``` + + +``` + +### Options + +``` + -c, --config string Specify infra cluster config file. [option] + --debug set debug mode + --delete-cri delete cri + --etcd strings Specify etcd nodes + -h, --help help for delete + --master strings Specify master nodes + --name string Specify kubernetes cluster name + --nodes strings List of machines on which kubernetes is installed. [require] + -p, --password string Specify the password for the account to execute sudo. [option] + --private-key string The PrimaryKey for ssh to the remote machine. [option] + --private-key-path string Specify the file PrimaryKeyPath of ssh to the remote machine. default ~/.ssh/id_rsa. + -t, --timeout int Specify the ssh timeout.[option] (default 30) + -u, --user string Specify the account to access the remote server. [require] + --worker strings Specify worker nodes +``` + +### Options inherited from parent commands + +``` + --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --as-uid string UID to impersonate for the operation. + --cache-dir string Default cache directory (default "$HOME/.kube/cache") + --certificate-authority string Path to a cert file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --disable-compression If true, opt-out of response compression for all requests to the server + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") + -s, --server string The address and port of the Kubernetes API server + --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used + --token string Bearer token for authentication to the API server +``` + +### SEE ALSO + +* [kbcli infra](kbcli_infra.md) - infra command + +#### Go Back to [CLI Overview](cli.md) Homepage. + diff --git a/internal/cli/cmd/infrastructure/cluster.go b/internal/cli/cmd/infrastructure/cluster.go index b22e4310ac7..b5eb674180a 100644 --- a/internal/cli/cmd/infrastructure/cluster.go +++ b/internal/cli/cmd/infrastructure/cluster.go @@ -47,8 +47,8 @@ type clusterOptions struct { clusterConfig string clusterName string - nodes []string timeout int64 + nodes []string } func buildCommonFlags(cmd *cobra.Command, o *clusterOptions) {