Skip to content

Commit 2b69475

Browse files
shanshanyingshanshanying
committed
chore: clone docs for v1.0.1
1 parent 61d15b2 commit 2b69475

File tree

461 files changed

+137908
-30
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

461 files changed

+137908
-30
lines changed

‎docs/en/release-1_0_1/cli/_category_.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
position: 30
2+
label: Command Line
3+
collapsible: true
4+
collapsed: true
5+
className: hide-children

‎docs/en/release-1_0_1/cli/cli.mdx‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
---
2+
title: KubeBlocks CLI Overview
3+
description: KubeBlocks CLI overview
4+
sidebar_position: 1
5+
---
6+
7+
## [addon](kbcli_addon.md)
8+
9+
Addon command.
10+
11+
* [kbcli addon describe](kbcli_addon_describe.md) - Describe an addon specification.
12+
* [kbcli addon disable](kbcli_addon_disable.md) - Disable an addon.
13+
* [kbcli addon enable](kbcli_addon_enable.md) - Enable an addon.
14+
* [kbcli addon index](kbcli_addon_index.md) - Manage custom addon indexes
15+
* [kbcli addon install](kbcli_addon_install.md) - Install KubeBlocks addon
16+
* [kbcli addon list](kbcli_addon_list.md) - List addons.
17+
* [kbcli addon purge](kbcli_addon_purge.md) - Purge the sub-resources of specified addon and versions
18+
* [kbcli addon search](kbcli_addon_search.md) - Search the addon from index
19+
* [kbcli addon uninstall](kbcli_addon_uninstall.md) - Uninstall an existed addon
20+
* [kbcli addon upgrade](kbcli_addon_upgrade.md) - Upgrade an existed addon to latest version or a specified version
21+
22+
23+
## [backuprepo](kbcli_backuprepo.md)
24+
25+
BackupRepo command.
26+
27+
* [kbcli backuprepo create](kbcli_backuprepo_create.md) - Create a backup repository
28+
* [kbcli backuprepo delete](kbcli_backuprepo_delete.md) - Delete a backup repository.
29+
* [kbcli backuprepo describe](kbcli_backuprepo_describe.md) - Describe a backup repository.
30+
* [kbcli backuprepo list](kbcli_backuprepo_list.md) - List Backup Repositories.
31+
* [kbcli backuprepo list-storage-provider](kbcli_backuprepo_list-storage-provider.md) - List storage providers.
32+
* [kbcli backuprepo update](kbcli_backuprepo_update.md) - Update a backup repository.
33+
34+
35+
## [cluster](kbcli_cluster.md)
36+
37+
Cluster command.
38+
39+
* [kbcli cluster backup](kbcli_cluster_backup.md) - Create a backup for the cluster.
40+
* [kbcli cluster cancel-ops](kbcli_cluster_cancel-ops.md) - Cancel the pending/creating/running OpsRequest which type is vscale or hscale.
41+
* [kbcli cluster configure](kbcli_cluster_configure.md) - Configure parameters with the specified components in the cluster.
42+
* [kbcli cluster connect](kbcli_cluster_connect.md) - Connect to a cluster or instance.
43+
* [kbcli cluster create](kbcli_cluster_create.md) - Create a cluster.
44+
* [kbcli cluster custom-ops](kbcli_cluster_custom-ops.md) -
45+
* [kbcli cluster delete](kbcli_cluster_delete.md) - Delete clusters.
46+
* [kbcli cluster delete-backup](kbcli_cluster_delete-backup.md) - Delete a backup.
47+
* [kbcli cluster delete-ops](kbcli_cluster_delete-ops.md) - Delete an OpsRequest.
48+
* [kbcli cluster describe](kbcli_cluster_describe.md) - Show details of a specific cluster.
49+
* [kbcli cluster describe-backup](kbcli_cluster_describe-backup.md) - Describe a backup.
50+
* [kbcli cluster describe-backup-policy](kbcli_cluster_describe-backup-policy.md) - Describe backup policy
51+
* [kbcli cluster describe-config](kbcli_cluster_describe-config.md) - Show details of a specific reconfiguring.
52+
* [kbcli cluster describe-ops](kbcli_cluster_describe-ops.md) - Show details of a specific OpsRequest.
53+
* [kbcli cluster describe-restore](kbcli_cluster_describe-restore.md) - Describe a restore
54+
* [kbcli cluster edit-backup-policy](kbcli_cluster_edit-backup-policy.md) - Edit backup policy
55+
* [kbcli cluster edit-config](kbcli_cluster_edit-config.md) - Edit the config file of the component.
56+
* [kbcli cluster explain-config](kbcli_cluster_explain-config.md) - List the constraint for supported configuration params.
57+
* [kbcli cluster expose](kbcli_cluster_expose.md) - Expose a cluster with a new endpoint, the new endpoint can be found by executing 'kbcli cluster describe NAME'.
58+
* [kbcli cluster label](kbcli_cluster_label.md) - Update the labels on cluster
59+
* [kbcli cluster list](kbcli_cluster_list.md) - List clusters.
60+
* [kbcli cluster list-backup-policies](kbcli_cluster_list-backup-policies.md) - List backups policies.
61+
* [kbcli cluster list-backups](kbcli_cluster_list-backups.md) - List backups.
62+
* [kbcli cluster list-components](kbcli_cluster_list-components.md) - List cluster components.
63+
* [kbcli cluster list-events](kbcli_cluster_list-events.md) - List cluster events.
64+
* [kbcli cluster list-instances](kbcli_cluster_list-instances.md) - List cluster instances.
65+
* [kbcli cluster list-logs](kbcli_cluster_list-logs.md) - List supported log files in cluster.
66+
* [kbcli cluster list-ops](kbcli_cluster_list-ops.md) - List all opsRequests.
67+
* [kbcli cluster list-restores](kbcli_cluster_list-restores.md) - List restores.
68+
* [kbcli cluster logs](kbcli_cluster_logs.md) - Access cluster log file.
69+
* [kbcli cluster promote](kbcli_cluster_promote.md) - Promote a non-primary or non-leader instance as the new primary or leader of the cluster
70+
* [kbcli cluster rebuild-instance](kbcli_cluster_rebuild-instance.md) - Rebuild the specified instances in the cluster.
71+
* [kbcli cluster register](kbcli_cluster_register.md) - Pull the cluster chart to the local cache and register the type to 'create' sub-command
72+
* [kbcli cluster restart](kbcli_cluster_restart.md) - Restart the specified components in the cluster.
73+
* [kbcli cluster restore](kbcli_cluster_restore.md) - Restore a new cluster from backup.
74+
* [kbcli cluster scale-in](kbcli_cluster_scale-in.md) - scale in replicas of the specified components in the cluster.
75+
* [kbcli cluster scale-out](kbcli_cluster_scale-out.md) - scale out replicas of the specified components in the cluster.
76+
* [kbcli cluster start](kbcli_cluster_start.md) - Start the cluster if cluster is stopped.
77+
* [kbcli cluster stop](kbcli_cluster_stop.md) - Stop the cluster and release all the pods of the cluster.
78+
* [kbcli cluster update](kbcli_cluster_update.md) - Update the cluster settings, such as enable or disable monitor or log.
79+
* [kbcli cluster upgrade](kbcli_cluster_upgrade.md) - Upgrade the service version(only support to upgrade minor version).
80+
* [kbcli cluster upgrade-to-v1](kbcli_cluster_upgrade-to-v1.md) - upgrade cluster to v1 api version.
81+
* [kbcli cluster volume-expand](kbcli_cluster_volume-expand.md) - Expand volume with the specified components and volumeClaimTemplates in the cluster.
82+
* [kbcli cluster vscale](kbcli_cluster_vscale.md) - Vertically scale the specified components in the cluster.
83+
84+
85+
## [clusterdefinition](kbcli_clusterdefinition.md)
86+
87+
ClusterDefinition command.
88+
89+
* [kbcli clusterdefinition describe](kbcli_clusterdefinition_describe.md) - Describe ClusterDefinition.
90+
* [kbcli clusterdefinition list](kbcli_clusterdefinition_list.md) - List ClusterDefinitions.
91+
92+
93+
## [componentdefinition](kbcli_componentdefinition.md)
94+
95+
ComponentDefinition command.
96+
97+
* [kbcli componentdefinition describe](kbcli_componentdefinition_describe.md) - Describe ComponentDefinition.
98+
* [kbcli componentdefinition list](kbcli_componentdefinition_list.md) - List ComponentDefinition.
99+
100+
101+
## [componentversion](kbcli_componentversion.md)
102+
103+
ComponentVersions command.
104+
105+
* [kbcli componentversion describe](kbcli_componentversion_describe.md) - Describe ComponentVersion.
106+
* [kbcli componentversion list](kbcli_componentversion_list.md) - List ComponentVersion.
107+
108+
109+
## [dataprotection](kbcli_dataprotection.md)
110+
111+
Data protection command.
112+
113+
* [kbcli dataprotection backup](kbcli_dataprotection_backup.md) - Create a backup for the cluster.
114+
* [kbcli dataprotection delete-backup](kbcli_dataprotection_delete-backup.md) - Delete a backup.
115+
* [kbcli dataprotection describe-backup](kbcli_dataprotection_describe-backup.md) - Describe a backup
116+
* [kbcli dataprotection describe-backup-policy](kbcli_dataprotection_describe-backup-policy.md) - Describe a backup policy
117+
* [kbcli dataprotection describe-restore](kbcli_dataprotection_describe-restore.md) - Describe a restore
118+
* [kbcli dataprotection edit-backup-policy](kbcli_dataprotection_edit-backup-policy.md) - Edit backup policy
119+
* [kbcli dataprotection list-action-sets](kbcli_dataprotection_list-action-sets.md) - List actionsets
120+
* [kbcli dataprotection list-backup-policies](kbcli_dataprotection_list-backup-policies.md) - List backup policies
121+
* [kbcli dataprotection list-backup-policy-templates](kbcli_dataprotection_list-backup-policy-templates.md) - List backup policy templates
122+
* [kbcli dataprotection list-backups](kbcli_dataprotection_list-backups.md) - List backups.
123+
* [kbcli dataprotection list-restores](kbcli_dataprotection_list-restores.md) - List restores.
124+
* [kbcli dataprotection restore](kbcli_dataprotection_restore.md) - Restore a new cluster from backup
125+
126+
127+
## [kubeblocks](kbcli_kubeblocks.md)
128+
129+
KubeBlocks operation commands.
130+
131+
* [kbcli kubeblocks compare](kbcli_kubeblocks_compare.md) - List the changes between two different version KubeBlocks.
132+
* [kbcli kubeblocks config](kbcli_kubeblocks_config.md) - KubeBlocks config.
133+
* [kbcli kubeblocks describe-config](kbcli_kubeblocks_describe-config.md) - Describe KubeBlocks config.
134+
* [kbcli kubeblocks install](kbcli_kubeblocks_install.md) - Install KubeBlocks.
135+
* [kbcli kubeblocks list-versions](kbcli_kubeblocks_list-versions.md) - List KubeBlocks versions.
136+
* [kbcli kubeblocks preflight](kbcli_kubeblocks_preflight.md) - Run and retrieve preflight checks for KubeBlocks.
137+
* [kbcli kubeblocks status](kbcli_kubeblocks_status.md) - Show list of resource KubeBlocks uses or owns.
138+
* [kbcli kubeblocks uninstall](kbcli_kubeblocks_uninstall.md) - Uninstall KubeBlocks.
139+
* [kbcli kubeblocks upgrade](kbcli_kubeblocks_upgrade.md) - Upgrade KubeBlocks.
140+
141+
142+
## [ops-definition](kbcli_ops-definition.md)
143+
144+
ops-definitions command.
145+
146+
* [kbcli ops-definition describe](kbcli_ops-definition_describe.md) - Describe OpsDefinition.
147+
* [kbcli ops-definition list](kbcli_ops-definition_list.md) - List OpsDefinition.
148+
149+
150+
## [options](kbcli_options.md)
151+
152+
Print the list of flags inherited by all commands.
153+
154+
155+
156+
## [playground](kbcli_playground.md)
157+
158+
Bootstrap or destroy a playground KubeBlocks in local host or cloud.
159+
160+
* [kbcli playground destroy](kbcli_playground_destroy.md) - Destroy the playground KubeBlocks and kubernetes cluster.
161+
* [kbcli playground init](kbcli_playground_init.md) - Bootstrap a kubernetes cluster and install KubeBlocks for playground.
162+
163+
164+
## [plugin](kbcli_plugin.md)
165+
166+
Provides utilities for interacting with plugins.
167+
168+
Plugins provide extended functionality that is not part of the major command-line distribution.
169+
170+
* [kbcli plugin describe](kbcli_plugin_describe.md) - Describe a plugin
171+
* [kbcli plugin index](kbcli_plugin_index.md) - Manage custom plugin indexes
172+
* [kbcli plugin install](kbcli_plugin_install.md) - Install kbcli or kubectl plugins
173+
* [kbcli plugin list](kbcli_plugin_list.md) - List all visible plugin executables on a user's PATH
174+
* [kbcli plugin search](kbcli_plugin_search.md) - Search kbcli or kubectl plugins
175+
* [kbcli plugin uninstall](kbcli_plugin_uninstall.md) - Uninstall kbcli or kubectl plugins
176+
* [kbcli plugin upgrade](kbcli_plugin_upgrade.md) - Upgrade kbcli or kubectl plugins
177+
178+
179+
## [report](kbcli_report.md)
180+
181+
Report kubeblocks or cluster info.
182+
183+
* [kbcli report cluster](kbcli_report_cluster.md) - Report Cluster information
184+
* [kbcli report kubeblocks](kbcli_report_kubeblocks.md) - Report KubeBlocks information, including deployments, events, logs, etc.
185+
186+
187+
## [trace](kbcli_trace.md)
188+
189+
trace management command
190+
191+
* [kbcli trace create](kbcli_trace_create.md) - create a trace.
192+
* [kbcli trace delete](kbcli_trace_delete.md) - Delete a trace.
193+
* [kbcli trace list](kbcli_trace_list.md) - list all traces.
194+
* [kbcli trace update](kbcli_trace_update.md) - update a trace.
195+
* [kbcli trace watch](kbcli_trace_watch.md) - watch a trace.
196+
197+
198+
## [version](kbcli_version.md)
199+
200+
Print the version information, include kubernetes, KubeBlocks and kbcli version.
201+
202+
203+

‎docs/en/release-1_0_1/cli/kbcli.mdx‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: kbcli
3+
---
4+
5+
KubeBlocks CLI.
6+
7+
### Synopsis
8+
9+
```
10+
11+
=============================================
12+
__ __ _______ ______ __ ______
13+
| \ / \ \ / \| \ | \
14+
| ▓▓ / ▓▓ ▓▓▓▓▓▓▓\ ▓▓▓▓▓▓\ ▓▓ \▓▓▓▓▓▓
15+
| ▓▓/ ▓▓| ▓▓__/ ▓▓ ▓▓ \▓▓ ▓▓ | ▓▓
16+
| ▓▓ ▓▓ | ▓▓ ▓▓ ▓▓ | ▓▓ | ▓▓
17+
| ▓▓▓▓▓\ | ▓▓▓▓▓▓▓\ ▓▓ __| ▓▓ | ▓▓
18+
| ▓▓ \▓▓\| ▓▓__/ ▓▓ ▓▓__/ \ ▓▓_____ _| ▓▓_
19+
| ▓▓ \▓▓\ ▓▓ ▓▓\▓▓ ▓▓ ▓▓ \ ▓▓ \
20+
\▓▓ \▓▓\▓▓▓▓▓▓▓ \▓▓▓▓▓▓ \▓▓▓▓▓▓▓▓\▓▓▓▓▓▓
21+
22+
=============================================
23+
A Command Line Interface for KubeBlocks
24+
```
25+
26+
```
27+
kbcli [flags]
28+
```
29+
30+
### Options
31+
32+
```
33+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
34+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
35+
--as-uid string UID to impersonate for the operation.
36+
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
37+
--certificate-authority string Path to a cert file for the certificate authority
38+
--client-certificate string Path to a client certificate file for TLS
39+
--client-key string Path to a client key file for TLS
40+
--cluster string The name of the kubeconfig cluster to use
41+
--context string The name of the kubeconfig context to use
42+
--disable-compression If true, opt-out of response compression for all requests to the server
43+
-h, --help help for kbcli
44+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
45+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
46+
--match-server-version Require server version to match client version
47+
-n, --namespace string If present, the namespace scope for this CLI request
48+
--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")
49+
-s, --server string The address and port of the Kubernetes API server
50+
--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
51+
--token string Bearer token for authentication to the API server
52+
--user string The name of the kubeconfig user to use
53+
```
54+
55+
### SEE ALSO
56+
57+
* [kbcli addon](kbcli_addon.md) - Addon command.
58+
* [kbcli backuprepo](kbcli_backuprepo.md) - BackupRepo command.
59+
* [kbcli cluster](kbcli_cluster.md) - Cluster command.
60+
* [kbcli clusterdefinition](kbcli_clusterdefinition.md) - ClusterDefinition command.
61+
* [kbcli componentdefinition](kbcli_componentdefinition.md) - ComponentDefinition command.
62+
* [kbcli componentversion](kbcli_componentversion.md) - ComponentVersions command.
63+
* [kbcli dataprotection](kbcli_dataprotection.md) - Data protection command.
64+
* [kbcli kubeblocks](kbcli_kubeblocks.md) - KubeBlocks operation commands.
65+
* [kbcli ops-definition](kbcli_ops-definition.md) - ops-definitions command.
66+
* [kbcli options](kbcli_options.md) - Print the list of flags inherited by all commands.
67+
* [kbcli playground](kbcli_playground.md) - Bootstrap or destroy a playground KubeBlocks in local host or cloud.
68+
* [kbcli plugin](kbcli_plugin.md) - Provides utilities for interacting with plugins.
69+
* [kbcli report](kbcli_report.md) - Report kubeblocks or cluster info.
70+
* [kbcli trace](kbcli_trace.md) - trace management command
71+
* [kbcli version](kbcli_version.md) - Print the version information, include kubernetes, KubeBlocks and kbcli version.
72+
73+
#### Go Back to [CLI Overview](cli.md) Homepage.
74+

‎docs/en/release-1_0_1/cli/kbcli_addon.mdx‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: kbcli addon
3+
---
4+
5+
Addon command.
6+
7+
### Options
8+
9+
```
10+
-h, --help help for addon
11+
```
12+
13+
### Options inherited from parent commands
14+
15+
```
16+
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
17+
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
18+
--as-uid string UID to impersonate for the operation.
19+
--cache-dir string Default cache directory (default "$HOME/.kube/cache")
20+
--certificate-authority string Path to a cert file for the certificate authority
21+
--client-certificate string Path to a client certificate file for TLS
22+
--client-key string Path to a client key file for TLS
23+
--cluster string The name of the kubeconfig cluster to use
24+
--context string The name of the kubeconfig context to use
25+
--disable-compression If true, opt-out of response compression for all requests to the server
26+
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
27+
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
28+
--match-server-version Require server version to match client version
29+
-n, --namespace string If present, the namespace scope for this CLI request
30+
--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")
31+
-s, --server string The address and port of the Kubernetes API server
32+
--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
33+
--token string Bearer token for authentication to the API server
34+
--user string The name of the kubeconfig user to use
35+
```
36+
37+
### SEE ALSO
38+
39+
40+
* [kbcli addon describe](kbcli_addon_describe.md) - Describe an addon specification.
41+
* [kbcli addon disable](kbcli_addon_disable.md) - Disable an addon.
42+
* [kbcli addon enable](kbcli_addon_enable.md) - Enable an addon.
43+
* [kbcli addon index](kbcli_addon_index.md) - Manage custom addon indexes
44+
* [kbcli addon install](kbcli_addon_install.md) - Install KubeBlocks addon
45+
* [kbcli addon list](kbcli_addon_list.md) - List addons.
46+
* [kbcli addon purge](kbcli_addon_purge.md) - Purge the sub-resources of specified addon and versions
47+
* [kbcli addon search](kbcli_addon_search.md) - Search the addon from index
48+
* [kbcli addon uninstall](kbcli_addon_uninstall.md) - Uninstall an existed addon
49+
* [kbcli addon upgrade](kbcli_addon_upgrade.md) - Upgrade an existed addon to latest version or a specified version
50+
51+
#### Go Back to [CLI Overview](cli.md) Homepage.
52+

0 commit comments

Comments
 (0)