Skip to content

Commit

Permalink
chore: auto update cli doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
wangyelei committed Nov 14, 2024
1 parent 966a901 commit 7c14507
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/user_docs/cli/kbcli_kubeblocks_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ kbcli kubeblocks config [flags]

```
-h, --help help for config
-n, --namespace string KubeBlocks namespace
--set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-file stringArray Set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
--set-json stringArray Set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2)
Expand All @@ -42,7 +43,6 @@ kbcli kubeblocks config [flags]
--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
Expand Down
10 changes: 5 additions & 5 deletions docs/user_docs/cli/kbcli_kubeblocks_describe-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ kbcli kubeblocks describe-config [flags]
### Options

```
-A, --all show all kubeblocks configs value
--filter string filter the desired kubeblocks configs, multiple filtered strings are comma separated
-h, --help help for describe-config
-o, --output format prints the output in the specified format. Allowed values: table, json, yaml, wide (default table)
-A, --all show all kubeblocks configs value
--filter string filter the desired kubeblocks configs, multiple filtered strings are comma separated
-h, --help help for describe-config
-n, --namespace string KubeBlocks namespace
-o, --output format prints the output in the specified format. Allowed values: table, json, yaml, wide (default table)
```

### Options inherited from parent commands
Expand All @@ -44,7 +45,6 @@ kbcli kubeblocks describe-config [flags]
--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
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/cli/kbcli_kubeblocks_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ kbcli kubeblocks install [flags]
--create-namespace Create the namespace if not present
--force If present, just print fail item and continue with the following steps
-h, --help help for install
-n, --namespace string KubeBlocks namespace (default "kb-system")
--node-labels stringToString Node label selector (default [])
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required)
--set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
Expand Down Expand Up @@ -65,7 +66,6 @@ kbcli kubeblocks install [flags]
--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
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/cli/kbcli_kubeblocks_uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ kbcli kubeblocks uninstall [flags]
```
--auto-approve Skip interactive approval before uninstalling KubeBlocks
-h, --help help for uninstall
-n, --namespace string KubeBlocks namespace
--remove-namespace Remove default created "kb-system" namespace or not
--remove-pvcs Remove PersistentVolumeClaim or not
--remove-pvs Remove PersistentVolume or not
Expand All @@ -43,7 +44,6 @@ kbcli kubeblocks uninstall [flags]
--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
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/cli/kbcli_kubeblocks_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ kbcli kubeblocks upgrade [flags]
--auto-approve Skip interactive approval before upgrading KubeBlocks
--check Check kubernetes environment before upgrade (default true)
-h, --help help for upgrade
-n, --namespace string KubeBlocks namespace
--set stringArray Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-file stringArray Set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
--set-json stringArray Set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2)
Expand All @@ -50,7 +51,6 @@ kbcli kubeblocks upgrade [flags]
--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
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/cli/kbcli_report_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ kbcli report cluster NAME [-f file] [-with-logs] [-mask] [flags]
-f, --file string zip file for output
-h, --help help for cluster
--mask mask sensitive info for secrets and configmaps (default true)
-n, --namespace string KubeBlocks namespace
-o, --output string Output format. One of: json|yaml. (default "json")
--since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used.
--since-time string Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.
Expand All @@ -63,7 +64,6 @@ kbcli report cluster NAME [-f file] [-with-logs] [-mask] [flags]
--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
Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/cli/kbcli_report_kubeblocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ kbcli report kubeblocks [-f file] [--with-logs] [--mask] [flags]
-f, --file string zip file for output
-h, --help help for kubeblocks
--mask mask sensitive info for secrets and configmaps (default true)
-n, --namespace string KubeBlocks namespace
-o, --output string Output format. One of: json|yaml. (default "json")
--since duration Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used.
--since-time string Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used.
Expand All @@ -54,7 +55,6 @@ kbcli report kubeblocks [-f file] [--with-logs] [--mask] [flags]
--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
Expand Down

0 comments on commit 7c14507

Please sign in to comment.