github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/user_docs/cli/cli.md (about)

     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 list](kbcli_addon_list.md)	 - List addons.
    15  
    16  
    17  ## [alert](kbcli_alert.md)
    18  
    19  Manage alert receiver, include add, list and delete receiver.
    20  
    21  * [kbcli alert add-receiver](kbcli_alert_add-receiver.md)	 - Add alert receiver, such as email, slack, webhook and so on.
    22  * [kbcli alert config-smtpserver](kbcli_alert_config-smtpserver.md)	 - Set smtp server config
    23  * [kbcli alert delete-receiver](kbcli_alert_delete-receiver.md)	 - Delete alert receiver.
    24  * [kbcli alert list-receivers](kbcli_alert_list-receivers.md)	 - List all alert receivers.
    25  * [kbcli alert list-smtpserver](kbcli_alert_list-smtpserver.md)	 - List alert smtp servers config.
    26  
    27  
    28  ## [backuprepo](kbcli_backuprepo.md)
    29  
    30  BackupRepo command.
    31  
    32  * [kbcli backuprepo create](kbcli_backuprepo_create.md)	 - Create a backup repo
    33  * [kbcli backuprepo describe](kbcli_backuprepo_describe.md)	 - Describe a backup repository.
    34  * [kbcli backuprepo list](kbcli_backuprepo_list.md)	 - List Backup Repositories.
    35  
    36  
    37  ## [bench](kbcli_bench.md)
    38  
    39  Run a benchmark.
    40  
    41  * [kbcli bench delete](kbcli_bench_delete.md)	 - Delete a benchmark.
    42  * [kbcli bench describe](kbcli_bench_describe.md)	 - Describe a benchmark.
    43  * [kbcli bench list](kbcli_bench_list.md)	 - List all benchmarks.
    44  * [kbcli bench pgbench](kbcli_bench_pgbench.md)	 - Run pgbench against a PostgreSQL cluster
    45  * [kbcli bench sysbench](kbcli_bench_sysbench.md)	 - run a SysBench benchmark
    46  * [kbcli bench tpcc](kbcli_bench_tpcc.md)	 - Run tpcc benchmark
    47  * [kbcli bench tpch](kbcli_bench_tpch.md)	 - Run tpch benchmark
    48  * [kbcli bench ycsb](kbcli_bench_ycsb.md)	 - Run YCSB benchmark on a cluster
    49  
    50  
    51  ## [builder](kbcli_builder.md)
    52  
    53  builder command.
    54  
    55  * [kbcli builder migrate-scripts](kbcli_builder_migrate-scripts.md)	 - migrate - a developer tool.
    56  * [kbcli builder template](kbcli_builder_template.md)	 - 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.
    57  
    58  
    59  ## [class](kbcli_class.md)
    60  
    61  Manage classes
    62  
    63  * [kbcli class create](kbcli_class_create.md)	 - Create a class
    64  * [kbcli class list](kbcli_class_list.md)	 - List classes
    65  * [kbcli class template](kbcli_class_template.md)	 - Generate class definition template
    66  
    67  
    68  ## [cluster](kbcli_cluster.md)
    69  
    70  Cluster command.
    71  
    72  * [kbcli cluster backup](kbcli_cluster_backup.md)	 - Create a backup for the cluster.
    73  * [kbcli cluster cancel-ops](kbcli_cluster_cancel-ops.md)	 - Cancel the pending/creating/running OpsRequest which type is vscale or hscale.
    74  * [kbcli cluster configure](kbcli_cluster_configure.md)	 - Configure parameters with the specified components in the cluster.
    75  * [kbcli cluster connect](kbcli_cluster_connect.md)	 - Connect to a cluster or instance.
    76  * [kbcli cluster create](kbcli_cluster_create.md)	 - Create a cluster.
    77  * [kbcli cluster create-account](kbcli_cluster_create-account.md)	 - Create account for a cluster
    78  * [kbcli cluster delete](kbcli_cluster_delete.md)	 - Delete clusters.
    79  * [kbcli cluster delete-account](kbcli_cluster_delete-account.md)	 - Delete account for a cluster
    80  * [kbcli cluster delete-backup](kbcli_cluster_delete-backup.md)	 - Delete a backup.
    81  * [kbcli cluster delete-ops](kbcli_cluster_delete-ops.md)	 - Delete an OpsRequest.
    82  * [kbcli cluster describe](kbcli_cluster_describe.md)	 - Show details of a specific cluster.
    83  * [kbcli cluster describe-account](kbcli_cluster_describe-account.md)	 - Describe account roles and related information
    84  * [kbcli cluster describe-backup](kbcli_cluster_describe-backup.md)	 - Describe a backup.
    85  * [kbcli cluster describe-backup-policy](kbcli_cluster_describe-backup-policy.md)	 - Describe backup policy
    86  * [kbcli cluster describe-config](kbcli_cluster_describe-config.md)	 - Show details of a specific reconfiguring.
    87  * [kbcli cluster describe-ops](kbcli_cluster_describe-ops.md)	 - Show details of a specific OpsRequest.
    88  * [kbcli cluster diff-config](kbcli_cluster_diff-config.md)	 - Show the difference in parameters between the two submitted OpsRequest.
    89  * [kbcli cluster edit-backup-policy](kbcli_cluster_edit-backup-policy.md)	 - Edit backup policy
    90  * [kbcli cluster edit-config](kbcli_cluster_edit-config.md)	 - Edit the config file of the component.
    91  * [kbcli cluster explain-config](kbcli_cluster_explain-config.md)	 - List the constraint for supported configuration params.
    92  * [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'.
    93  * [kbcli cluster grant-role](kbcli_cluster_grant-role.md)	 - Grant role to account
    94  * [kbcli cluster hscale](kbcli_cluster_hscale.md)	 - Horizontally scale the specified components in the cluster.
    95  * [kbcli cluster label](kbcli_cluster_label.md)	 - Update the labels on cluster
    96  * [kbcli cluster list](kbcli_cluster_list.md)	 - List clusters.
    97  * [kbcli cluster list-accounts](kbcli_cluster_list-accounts.md)	 - List accounts for a cluster
    98  * [kbcli cluster list-backup-policy](kbcli_cluster_list-backup-policy.md)	 - List backups policies.
    99  * [kbcli cluster list-backups](kbcli_cluster_list-backups.md)	 - List backups.
   100  * [kbcli cluster list-components](kbcli_cluster_list-components.md)	 - List cluster components.
   101  * [kbcli cluster list-events](kbcli_cluster_list-events.md)	 - List cluster events.
   102  * [kbcli cluster list-instances](kbcli_cluster_list-instances.md)	 - List cluster instances.
   103  * [kbcli cluster list-logs](kbcli_cluster_list-logs.md)	 - List supported log files in cluster.
   104  * [kbcli cluster list-ops](kbcli_cluster_list-ops.md)	 - List all opsRequests.
   105  * [kbcli cluster logs](kbcli_cluster_logs.md)	 - Access cluster log file.
   106  * [kbcli cluster promote](kbcli_cluster_promote.md)	 - Promote a non-primary or non-leader instance as the new primary or leader of the cluster
   107  * [kbcli cluster register](kbcli_cluster_register.md)	 - Pull the cluster chart to the local cache and register the type to 'create' sub-command
   108  * [kbcli cluster restart](kbcli_cluster_restart.md)	 - Restart the specified components in the cluster.
   109  * [kbcli cluster restore](kbcli_cluster_restore.md)	 - Restore a new cluster from backup.
   110  * [kbcli cluster revoke-role](kbcli_cluster_revoke-role.md)	 - Revoke role from account
   111  * [kbcli cluster start](kbcli_cluster_start.md)	 - Start the cluster if cluster is stopped.
   112  * [kbcli cluster stop](kbcli_cluster_stop.md)	 - Stop the cluster and release all the pods of the cluster.
   113  * [kbcli cluster update](kbcli_cluster_update.md)	 - Update the cluster settings, such as enable or disable monitor or log.
   114  * [kbcli cluster upgrade](kbcli_cluster_upgrade.md)	 - Upgrade the cluster version.
   115  * [kbcli cluster volume-expand](kbcli_cluster_volume-expand.md)	 - Expand volume with the specified components and volumeClaimTemplates in the cluster.
   116  * [kbcli cluster vscale](kbcli_cluster_vscale.md)	 - Vertically scale the specified components in the cluster.
   117  
   118  
   119  ## [clusterdefinition](kbcli_clusterdefinition.md)
   120  
   121  ClusterDefinition command.
   122  
   123  * [kbcli clusterdefinition describe](kbcli_clusterdefinition_describe.md)	 - Describe ClusterDefinition.
   124  * [kbcli clusterdefinition list](kbcli_clusterdefinition_list.md)	 - List ClusterDefinitions.
   125  * [kbcli clusterdefinition list-components](kbcli_clusterdefinition_list-components.md)	 - List cluster definition components.
   126  * [kbcli clusterdefinition list-service-reference](kbcli_clusterdefinition_list-service-reference.md)	 - List cluster references declared in a cluster definition.
   127  
   128  
   129  ## [clusterversion](kbcli_clusterversion.md)
   130  
   131  ClusterVersion command.
   132  
   133  * [kbcli clusterversion list](kbcli_clusterversion_list.md)	 - List ClusterVersions.
   134  * [kbcli clusterversion set-default](kbcli_clusterversion_set-default.md)	 - Set the clusterversion to the default clusterversion for its clusterdefinition.
   135  * [kbcli clusterversion unset-default](kbcli_clusterversion_unset-default.md)	 - Unset the clusterversion if it's default.
   136  
   137  
   138  ## [dashboard](kbcli_dashboard.md)
   139  
   140  List and open the KubeBlocks dashboards.
   141  
   142  * [kbcli dashboard list](kbcli_dashboard_list.md)	 - List all dashboards.
   143  * [kbcli dashboard open](kbcli_dashboard_open.md)	 - Open one dashboard.
   144  
   145  
   146  ## [dataprotection](kbcli_dataprotection.md)
   147  
   148  Data protection command.
   149  
   150  * [kbcli dataprotection backup](kbcli_dataprotection_backup.md)	 - Create a backup for the cluster.
   151  * [kbcli dataprotection delete-backup](kbcli_dataprotection_delete-backup.md)	 - Delete a backup.
   152  * [kbcli dataprotection describe-backup](kbcli_dataprotection_describe-backup.md)	 - Describe a backup
   153  * [kbcli dataprotection describe-backup-policy](kbcli_dataprotection_describe-backup-policy.md)	 - Describe a backup policy
   154  * [kbcli dataprotection list-backup-policy](kbcli_dataprotection_list-backup-policy.md)	 - List backup policies
   155  * [kbcli dataprotection list-backups](kbcli_dataprotection_list-backups.md)	 - List backups.
   156  * [kbcli dataprotection restore](kbcli_dataprotection_restore.md)	 - Restore a new cluster from backup
   157  
   158  
   159  ## [fault](kbcli_fault.md)
   160  
   161  Inject faults to pod.
   162  
   163  * [kbcli fault delete](kbcli_fault_delete.md)	 - Delete chaos resources.
   164  * [kbcli fault io](kbcli_fault_io.md)	 - IO chaos.
   165  * [kbcli fault list](kbcli_fault_list.md)	 - List chaos resources.
   166  * [kbcli fault network](kbcli_fault_network.md)	 - Network chaos.
   167  * [kbcli fault node](kbcli_fault_node.md)	 - Node chaos.
   168  * [kbcli fault pod](kbcli_fault_pod.md)	 - Pod chaos.
   169  * [kbcli fault stress](kbcli_fault_stress.md)	 - Add memory pressure or CPU load to the system.
   170  * [kbcli fault time](kbcli_fault_time.md)	 - Clock skew failure.
   171  
   172  
   173  ## [infra](kbcli_infra.md)
   174  
   175  infra command
   176  
   177  * [kbcli infra create](kbcli_infra_create.md)	 - create kubernetes cluster.
   178  * [kbcli infra delete](kbcli_infra_delete.md)	 - delete kubernetes cluster.
   179  
   180  
   181  ## [kubeblocks](kbcli_kubeblocks.md)
   182  
   183  KubeBlocks operation commands.
   184  
   185  * [kbcli kubeblocks compare](kbcli_kubeblocks_compare.md)	 - List the changes between two different version KubeBlocks.
   186  * [kbcli kubeblocks config](kbcli_kubeblocks_config.md)	 - KubeBlocks config.
   187  * [kbcli kubeblocks describe-config](kbcli_kubeblocks_describe-config.md)	 - Describe KubeBlocks config.
   188  * [kbcli kubeblocks install](kbcli_kubeblocks_install.md)	 - Install KubeBlocks.
   189  * [kbcli kubeblocks list-versions](kbcli_kubeblocks_list-versions.md)	 - List KubeBlocks versions.
   190  * [kbcli kubeblocks preflight](kbcli_kubeblocks_preflight.md)	 - Run and retrieve preflight checks for KubeBlocks.
   191  * [kbcli kubeblocks status](kbcli_kubeblocks_status.md)	 - Show list of resource KubeBlocks uses or owns.
   192  * [kbcli kubeblocks uninstall](kbcli_kubeblocks_uninstall.md)	 - Uninstall KubeBlocks.
   193  * [kbcli kubeblocks upgrade](kbcli_kubeblocks_upgrade.md)	 - Upgrade KubeBlocks.
   194  
   195  
   196  ## [login](kbcli_login.md)
   197  
   198  Authenticate with the KubeBlocks Cloud
   199  
   200  
   201  
   202  ## [logout](kbcli_logout.md)
   203  
   204  Log out of the KubeBlocks Cloud
   205  
   206  
   207  
   208  ## [migration](kbcli_migration.md)
   209  
   210  Data migration between two data sources.
   211  
   212  * [kbcli migration create](kbcli_migration_create.md)	 - Create a migration task.
   213  * [kbcli migration describe](kbcli_migration_describe.md)	 - Show details of a specific migration task.
   214  * [kbcli migration list](kbcli_migration_list.md)	 - List migration tasks.
   215  * [kbcli migration logs](kbcli_migration_logs.md)	 - Access migration task log file.
   216  * [kbcli migration templates](kbcli_migration_templates.md)	 - List migration templates.
   217  * [kbcli migration terminate](kbcli_migration_terminate.md)	 - Delete migration task.
   218  
   219  
   220  ## [options](kbcli_options.md)
   221  
   222  Print the list of flags inherited by all commands.
   223  
   224  
   225  
   226  ## [playground](kbcli_playground.md)
   227  
   228  Bootstrap or destroy a playground KubeBlocks in local host or cloud.
   229  
   230  * [kbcli playground destroy](kbcli_playground_destroy.md)	 - Destroy the playground KubeBlocks and kubernetes cluster.
   231  * [kbcli playground init](kbcli_playground_init.md)	 - Bootstrap a kubernetes cluster and install KubeBlocks for playground.
   232  
   233  
   234  ## [plugin](kbcli_plugin.md)
   235  
   236  Provides utilities for interacting with plugins.
   237  
   238   Plugins provide extended functionality that is not part of the major command-line distribution.
   239  
   240  * [kbcli plugin describe](kbcli_plugin_describe.md)	 - Describe a plugin
   241  * [kbcli plugin index](kbcli_plugin_index.md)	 - Manage custom plugin indexes
   242  * [kbcli plugin install](kbcli_plugin_install.md)	 - Install kbcli or kubectl plugins
   243  * [kbcli plugin list](kbcli_plugin_list.md)	 - List all visible plugin executables on a user's PATH
   244  * [kbcli plugin search](kbcli_plugin_search.md)	 - Search kbcli or kubectl plugins
   245  * [kbcli plugin uninstall](kbcli_plugin_uninstall.md)	 - Uninstall kbcli or kubectl plugins
   246  * [kbcli plugin upgrade](kbcli_plugin_upgrade.md)	 - Upgrade kbcli or kubectl plugins
   247  
   248  
   249  ## [report](kbcli_report.md)
   250  
   251  report kubeblocks or cluster info.
   252  
   253  * [kbcli report cluster](kbcli_report_cluster.md)	 - Report Cluster information
   254  * [kbcli report kubeblocks](kbcli_report_kubeblocks.md)	 - Report KubeBlocks information, including deployments, events, logs, etc.
   255  
   256  
   257  ## [version](kbcli_version.md)
   258  
   259  Print the version information, include kubernetes, KubeBlocks and kbcli version.
   260  
   261  
   262