-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support etcd Add-on and tidy up docs
- Loading branch information
Showing
31 changed files
with
1,257 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
docs/user_docs/cli/kbcli_backuprepo_list-storage-provider.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
title: kbcli backuprepo list-storage-provider | ||
--- | ||
|
||
List storage providers. | ||
|
||
``` | ||
kbcli backuprepo list-storage-provider [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# List all storage provider | ||
kbcli backuprepo list-sp | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for list-storage-provider | ||
-o, --output format prints the output in the specified format. Allowed values: table, json, yaml, wide (default table) | ||
-l, --selector string Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints. | ||
--show-labels When printing, show all labels as the last column (default hide labels column) | ||
``` | ||
|
||
### 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 | ||
--user string The name of the kubeconfig user to use | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [kbcli backuprepo](kbcli_backuprepo.md) - BackupRepo command. | ||
|
||
#### Go Back to [CLI Overview](cli.md) Homepage. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
title: kbcli cluster create minio | ||
--- | ||
|
||
Create a minio cluster. | ||
|
||
``` | ||
kbcli cluster create minio NAME [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Create a cluster with the default values | ||
kbcli cluster create minio | ||
# Create a cluster with the specified cpu, memory and storage | ||
kbcli cluster create minio --cpu 1 --memory 2 --storage 10 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--availability-policy string The availability policy of cluster. Legal values [none, node, zone]. (default "node") | ||
--cpu float CPU cores. Value range [0.5, 64]. (default 0.5) | ||
--disable-exporter Enable or disable monitor. (default true) | ||
--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 | ||
-h, --help help for minio | ||
--host-network-accessible Specify whether the cluster can be accessed from within the VPC. | ||
--memory float Memory, the unit is Gi. Value range [0.5, 1000]. (default 0.5) | ||
--node-labels stringToString Node label selector (default []) | ||
-o, --output format Prints the output in the specified format. Allowed values: JSON and YAML (default yaml) | ||
--pod-anti-affinity string Pod anti-affinity type, one of: (Preferred, Required) (default "Preferred") | ||
--publicly-accessible Specify whether the cluster can be accessed from the public internet. | ||
--rbac-enabled Specify whether rbac resources will be created by client, otherwise KubeBlocks server will try to create rbac resources. | ||
--replicas int The number of replicas Value range [1, 5]. (default 1) | ||
--storage float Storage size, the unit is Gi. Value range [1, 10000]. (default 20) | ||
--storage-class-name string Storage class name of the data volume | ||
--tenancy string The tenancy of cluster. Legal values [SharedNode, DedicatedNode]. (default "SharedNode") | ||
--termination-policy string The termination policy of cluster. Legal values [DoNotTerminate, Halt, Delete, WipeOut]. (default "Delete") | ||
--tolerations strings Tolerations for cluster, such as "key=value:effect,key:effect", for example '"engineType=mongo:NoSchedule", "diskType:NoSchedule"' | ||
--topology-keys stringArray Topology keys for affinity | ||
``` | ||
|
||
### 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 | ||
--user string The name of the kubeconfig user to use | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [kbcli cluster create](kbcli_cluster_create.md) - Create a cluster. | ||
|
||
#### Go Back to [CLI Overview](cli.md) Homepage. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
title: kbcli cluster describe-restore | ||
--- | ||
|
||
Describe a restore | ||
|
||
``` | ||
kbcli cluster describe-restore NAME [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# describe a restore | ||
kbcli cluster describe-restore <restoreName> | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for describe-restore | ||
``` | ||
|
||
### 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 | ||
--user string The name of the kubeconfig user to use | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [kbcli cluster](kbcli_cluster.md) - Cluster command. | ||
|
||
#### Go Back to [CLI Overview](cli.md) Homepage. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: kbcli cluster list-backup | ||
--- | ||
|
||
List backups. | ||
|
||
``` | ||
kbcli cluster list-backup [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# list all backups | ||
kbcli cluster list-backup | ||
# list all backups of the cluster | ||
kbcli cluster list-backup <clusterName> | ||
# list the specified backups | ||
kbcli cluster list-backup --names b1,b2 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. | ||
-h, --help help for list-backup | ||
--names strings The backup name to get the details. | ||
-n, --namespace string specified the namespace | ||
-o, --output format prints the output in the specified format. Allowed values: table, json, yaml, wide (default table) | ||
-l, --selector string Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints. | ||
--show-labels When printing, show all labels as the last column (default hide labels column) | ||
``` | ||
|
||
### 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 | ||
--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 | ||
--user string The name of the kubeconfig user to use | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [kbcli cluster](kbcli_cluster.md) - Cluster command. | ||
|
||
#### Go Back to [CLI Overview](cli.md) Homepage. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: kbcli cluster list-restore | ||
--- | ||
|
||
List restores. | ||
|
||
``` | ||
kbcli cluster list-restore [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# list all restores | ||
kbcli cluster list-restore | ||
# list all restores of the cluster | ||
kbcli cluster list-restore <clusterName> | ||
# list the specified restores | ||
kbcli cluster list-restore --names r1,r2 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. | ||
-h, --help help for list-restore | ||
--names strings List restores in the specified cluster | ||
-n, --namespace string specified the namespace | ||
-o, --output format prints the output in the specified format. Allowed values: table, json, yaml, wide (default table) | ||
-l, --selector string Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints. | ||
--show-labels When printing, show all labels as the last column (default hide labels column) | ||
``` | ||
|
||
### 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 | ||
--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 | ||
--user string The name of the kubeconfig user to use | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [kbcli cluster](kbcli_cluster.md) - Cluster command. | ||
|
||
#### Go Back to [CLI Overview](cli.md) Homepage. | ||
|
Oops, something went wrong.