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

title: KubeBlocks CLI Overview description: KubeBlocks CLI overview sidebar_position: 1 Addon command. - Describe an addon specification. - Disable an addon. - Enable an addon. - List addons. Manage alert receiver, include add, list and delete receiver. - Add alert receiver, such as email, slack, webhook and so on. - Set smtp server config - Delete alert receiver. - List all alert receivers. - List alert smtp servers config. BackupRepo command. - Create a backup repo - Describe a backup repository. - List Backup Repositories. - Update a backup repository. Run a benchmark. - Delete a benchmark. - Describe a benchmark. - List all benchmarks. - Run pgbench against a PostgreSQL cluster - run a SysBench benchmark - Run tpcc benchmark - Run tpch benchmark - Run YCSB benchmark on a cluster builder command. - migrate - a developer tool. - tpl - a developer tool integrated with KubeBlocks that can help developers quickly generate rendered configurations or scripts based on Helm templates, and discover errors in the template before creating the database cluster. Manage classes - Create a class - List classes - Generate class definition template Cluster command. - Create a backup for the cluster. - Cancel the pending/creating/running OpsRequest which type is vscale or hscale. - 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

- Expand volume with the specified components and volumeClaimTemplates in the cluster. - Vertically scale the specified components in the cluster. ClusterDefinition command. - Describe ClusterDefinition. - List ClusterDefinitions. - List cluster definition components. - List cluster references declared in a cluster definition. ClusterVersion command. - List ClusterVersions. - Set the clusterversion to the default clusterversion for its clusterdefinition. - Unset the clusterversion if it's default. kbcli context allows you to manage cloud context. This command is currently only applicable to cloud, and currently does not support switching the context of the local k8s cluster. - Get the currently used context. - Get the description information of a context. - List all created contexts. - Use another context that you have already created. List and open the KubeBlocks dashboards. - List all dashboards. - Open one dashboard. Data protection command. - Create a backup for the cluster. - Delete a backup. - Describe a backup - Describe a backup policy - List backup policies - List backups. - Restore a new cluster from backup Inject faults to pod. - Delete chaos resources. - IO chaos. - List chaos resources. - Network chaos. - Node chaos. - Pod chaos. - Add memory pressure or CPU load to the system. - Clock skew failure. infra command - create kubernetes cluster. - delete kubernetes cluster. KubeBlocks operation commands. - List the changes between two different version KubeBlocks. - KubeBlocks config. - Describe KubeBlocks config. - Install KubeBlocks. - List KubeBlocks versions. - Run and retrieve preflight checks for KubeBlocks. - Show list of resource KubeBlocks uses or owns. - Uninstall KubeBlocks. - Upgrade KubeBlocks. Authenticate with the KubeBlocks Cloud Log out of the KubeBlocks Cloud Data migration between two data sources. - Create a migration task. - Show details of a specific migration task. - List migration tasks. - Access migration task log file. - List migration templates. - Delete migration task. Print the list of flags inherited by all commands. kbcli org is used to manage cloud organizations and is only suitable for interacting with cloud. - Get current organization. - Get the description information of an organization. - List all organizations you have joined. - Switch to another organization you are already a member of. Bootstrap or destroy a playground KubeBlocks in local host or cloud. - Destroy the playground KubeBlocks and kubernetes cluster. - Bootstrap a kubernetes cluster and install KubeBlocks for playground. Provides utilities for interacting with plugins. Plugins provide extended functionality that is not part of the major command-line distribution. - Describe a plugin - Manage custom plugin indexes - Install kbcli or kubectl plugins - List all visible plugin executables on a user's PATH - Search kbcli or kubectl plugins - Uninstall kbcli or kubectl plugins - Upgrade kbcli or kubectl plugins report kubeblocks or cluster info. - Report Cluster information - Report KubeBlocks information, including deployments, events, logs, etc. Print the version information, include kubernetes, KubeBlocks and kbcli version.