Project: KubeBlocks by ApeCloud (App Definition and Development / Database)
File: kbcli_cluster.md

title: kbcli cluster Cluster command. ``` -h, --help help for cluster ``` ``` --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 ``` - Create a backup for the cluster. - Cancel the pending/creating/running OpsRequest which type is vscale or

- Configure parameters with the specified components in the cluster. - Connect to a cluster or instance. - Create a cluster. - Create account for a cluster - Delete clusters. - Delete account for a cluster - Delete a backup. - Delete an OpsRequest. - Show details of a specific cluster. - Describe account roles and related information - Describe a backup. - Describe backup policy - Show details of a specific reconfiguring. - Show details of a specific OpsRequest. - Show the difference in parameters between the two submitted OpsRequest. - Edit backup policy - Edit the config file of the component. - List the constraint for supported configuration params. - Expose a cluster with a new endpoint, the new endpoint can be found by executing 'kbcli cluster describe NAME'. - Grant role to account - Horizontally scale the specified components in the cluster. - Update the labels on cluster - List clusters. - List accounts for a cluster - List backups policies. - List backups. - List cluster components. - List cluster events. - List cluster instances. - List supported log files in cluster. - List all opsRequests. - Access cluster log file. - Promote a non-primary or non-leader instance as the new primary or leader of the cluster - Pull the cluster chart to the local cache and register the type to 'create' sub-command - Restart the specified components in the cluster. - Restore a new cluster from backup. - Revoke role from account - Start the cluster if cluster is stopped. - Stop the cluster and release all the pods of the cluster. - Update the cluster settings, such as enable or disable monitor or log. - Upgrade the cluster version. - Expand volume with the specified components and volumeClaimTemplates in the cluster. - Vertically scale the specified components in the cluster.