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

     1  ---
     2  title: kbcli cluster
     3  ---
     4  
     5  Cluster command.
     6  
     7  ### Options
     8  
     9  ```
    10    -h, --help   help for cluster
    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 cluster backup](kbcli_cluster_backup.md)	 - Create a backup for the cluster.
    41  * [kbcli cluster cancel-ops](kbcli_cluster_cancel-ops.md)	 - Cancel the pending/creating/running OpsRequest which type is vscale or hscale.
    42  * [kbcli cluster configure](kbcli_cluster_configure.md)	 - Configure parameters with the specified components in the cluster.
    43  * [kbcli cluster connect](kbcli_cluster_connect.md)	 - Connect to a cluster or instance.
    44  * [kbcli cluster create](kbcli_cluster_create.md)	 - Create a cluster.
    45  * [kbcli cluster create-account](kbcli_cluster_create-account.md)	 - Create account for a cluster
    46  * [kbcli cluster delete](kbcli_cluster_delete.md)	 - Delete clusters.
    47  * [kbcli cluster delete-account](kbcli_cluster_delete-account.md)	 - Delete account for a cluster
    48  * [kbcli cluster delete-backup](kbcli_cluster_delete-backup.md)	 - Delete a backup.
    49  * [kbcli cluster delete-ops](kbcli_cluster_delete-ops.md)	 - Delete an OpsRequest.
    50  * [kbcli cluster describe](kbcli_cluster_describe.md)	 - Show details of a specific cluster.
    51  * [kbcli cluster describe-account](kbcli_cluster_describe-account.md)	 - Describe account roles and related information
    52  * [kbcli cluster describe-backup](kbcli_cluster_describe-backup.md)	 - Describe a backup.
    53  * [kbcli cluster describe-backup-policy](kbcli_cluster_describe-backup-policy.md)	 - Describe backup policy
    54  * [kbcli cluster describe-config](kbcli_cluster_describe-config.md)	 - Show details of a specific reconfiguring.
    55  * [kbcli cluster describe-ops](kbcli_cluster_describe-ops.md)	 - Show details of a specific OpsRequest.
    56  * [kbcli cluster diff-config](kbcli_cluster_diff-config.md)	 - Show the difference in parameters between the two submitted OpsRequest.
    57  * [kbcli cluster edit-backup-policy](kbcli_cluster_edit-backup-policy.md)	 - Edit backup policy
    58  * [kbcli cluster edit-config](kbcli_cluster_edit-config.md)	 - Edit the config file of the component.
    59  * [kbcli cluster explain-config](kbcli_cluster_explain-config.md)	 - List the constraint for supported configuration params.
    60  * [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'.
    61  * [kbcli cluster grant-role](kbcli_cluster_grant-role.md)	 - Grant role to account
    62  * [kbcli cluster hscale](kbcli_cluster_hscale.md)	 - Horizontally scale the specified components in the cluster.
    63  * [kbcli cluster label](kbcli_cluster_label.md)	 - Update the labels on cluster
    64  * [kbcli cluster list](kbcli_cluster_list.md)	 - List clusters.
    65  * [kbcli cluster list-accounts](kbcli_cluster_list-accounts.md)	 - List accounts for a cluster
    66  * [kbcli cluster list-backup-policy](kbcli_cluster_list-backup-policy.md)	 - List backups policies.
    67  * [kbcli cluster list-backups](kbcli_cluster_list-backups.md)	 - List backups.
    68  * [kbcli cluster list-components](kbcli_cluster_list-components.md)	 - List cluster components.
    69  * [kbcli cluster list-events](kbcli_cluster_list-events.md)	 - List cluster events.
    70  * [kbcli cluster list-instances](kbcli_cluster_list-instances.md)	 - List cluster instances.
    71  * [kbcli cluster list-logs](kbcli_cluster_list-logs.md)	 - List supported log files in cluster.
    72  * [kbcli cluster list-ops](kbcli_cluster_list-ops.md)	 - List all opsRequests.
    73  * [kbcli cluster logs](kbcli_cluster_logs.md)	 - Access cluster log file.
    74  * [kbcli cluster promote](kbcli_cluster_promote.md)	 - Promote a non-primary or non-leader instance as the new primary or leader of the cluster
    75  * [kbcli cluster register](kbcli_cluster_register.md)	 - Pull the cluster chart to the local cache and register the type to 'create' sub-command
    76  * [kbcli cluster restart](kbcli_cluster_restart.md)	 - Restart the specified components in the cluster.
    77  * [kbcli cluster restore](kbcli_cluster_restore.md)	 - Restore a new cluster from backup.
    78  * [kbcli cluster revoke-role](kbcli_cluster_revoke-role.md)	 - Revoke role from account
    79  * [kbcli cluster start](kbcli_cluster_start.md)	 - Start the cluster if cluster is stopped.
    80  * [kbcli cluster stop](kbcli_cluster_stop.md)	 - Stop the cluster and release all the pods of the cluster.
    81  * [kbcli cluster update](kbcli_cluster_update.md)	 - Update the cluster settings, such as enable or disable monitor or log.
    82  * [kbcli cluster upgrade](kbcli_cluster_upgrade.md)	 - Upgrade the cluster version.
    83  * [kbcli cluster volume-expand](kbcli_cluster_volume-expand.md)	 - Expand volume with the specified components and volumeClaimTemplates in the cluster.
    84  * [kbcli cluster vscale](kbcli_cluster_vscale.md)	 - Vertically scale the specified components in the cluster.
    85  
    86  #### Go Back to [CLI Overview](cli.md) Homepage.
    87