The table below lists all of the commands and options of the Tanzu CLI, and provides links to the section in which they are documented.

Command Options Documented In
tanzu *
--file Common Tanzu Kubernetes Grid Options
Deploy Management Clusters from a Configuration File
Deploy Management Clusters with the Installer Interface
--log-file
--timeout
--verbose
--help
Common Tanzu Kubernetes Grid Options
tanzu cluster create
--file Deploy Tanzu Kubernetes Clusters
--dry-run Create Tanzu Kubernetes Cluster Manifest Files
--tkr Deploy Tanzu Kubernetes Clusters with Different Kubernetes Versions
Use the Tanzu CLI with a vSphere with Tanzu Supervisor Cluster
tanzu cluster credentials update Tanzu Kubernetes Cluster Secrets
tanzu cluster delete Delete Tanzu Kubernetes Clusters
tanzu cluster get
tanzu cluster kubeconfig get Deploying Tanzu Kubernetes Clusters
Connect to and Examine Tanzu Kubernetes Clusters
Manage Your Management Clusters
--admin
--export-file
--namespace
Connect to and Examine Tanzu Kubernetes Clusters
tanzu cluster list
--include-management-cluster Connect to and Examine Tanzu Kubernetes Clusters
Upgrade Management Clusters
Upgrade Tanzu Kubernetes Clusters
--namespace
--output
Connect to and Examine Tanzu Kubernetes Clusters
tanzu cluster machinehealthcheck delete
tanzu cluster machinehealthcheck get
tanzu cluster machinehealthcheck set
Configure Machine Health Checks for Tanzu Kubernetes Clusters
tanzu cluster scale
--controlplane-machine-count
--namespace
--worker-machine-count
Manage Your Management Clusters
Scale Tanzu Kubernetes Clusters
tanzu cluster upgrade
--namespace
--timeout
--os-arch
--os-name
--os-version
--tkr
--yes
Upgrade Tanzu Kubernetes Clusters
tanzu init
tanzu kubernetes-release get
tanzu kubernetes-release available-upgrades get
tanzu kubernetes-release os get
Deploy Tanzu Kubernetes Clusters with Different Kubernetes Versions
Upgrade Tanzu Kubernetes Clusters
tanzu login Connect to and Examine Tanzu Kubernetes Clusters
Manage Your Management Clusters
Use the Tanzu CLI with a vSphere with Tanzu Supervisor Cluster
Manage Your Management Clusters
tanzu management-cluster ceip-participation get
tanzu management-cluster ceip-participation set
Opt in or Out of the VMware CEIP
tanzu management-cluster credentials update Tanzu Kubernetes Cluster Secrets
tanzu management-cluster create Deploy Management Clusters from a Configuration File Deploy Management Clusters with the Installer Interface
tanzu management-cluster delete Delete Management Clusters
tanzu management-cluster get Connect to and Examine Tanzu Kubernetes Clusters
Examine the Management Cluster Deployment
Manage Your Management Clusters
Upgrade Management Clusters

tanzu management-cluster import Upgrading Tanzu Kubernetes Grid
tanzu management-cluster kubeconfig get
--admin
--export-file
Examine the Management Cluster Deployment
Configure Identity Management After Management Cluster Deployment
tanzu management-cluster register Register the Management Cluster with Tanzu Mission Control
tanzu management-cluster permissions aws get
tanzu management-cluster permissions aws set
Create a Cluster Configuration File for Amazon EC2
tanzu management-cluster upgrade
--os-arch
--os-name
--os-version
--timeout
--yes
Upgrade Management Clusters
tanzu version Install the Tanzu CLI

Table of Equivalents

The tanzu command-line interface (CLI) works differently from the tkg CLI used in previous versions of Tanzu Kubernetes Grid. Because of these differences, many tkg commands do not have direct tanzu equivalents, and vice-versa. But other commands do have direct or close equivalencies across both CLIs:

TKG CLI command Tanzu CLI command Notes
tkg init tanzu management-cluster create Some tkg flags not replicated in tanzu
tkg init --ui tanzu management-cluster create --ui Some tkg flags not replicated in tanzu
tkg set management-cluster MANAGEMENT_CLUSTER_NAME tanzu login --server SERVER
tkg add management-cluster tanzu login --kubeconfig CONFIG --context OPTIONAL_CONTEXT --name SERVER-NAME
tkg get management-cluster tanzu login The tanzu login command displays the currently configured management clusters
tkg create cluster tanzu cluster create Some tkg flags not replicated in tanzu
tkg config cluster tanzu cluster create --dry-run Some tkg flags not replicated in tanzu
tkg delete cluster tanzu cluster delete
tkg get cluster tanzu cluster list
tkg scale cluster tanzu cluster scale
tkg upgrade cluster tanzu cluster upgrade
tkg get credentials tanzu management-cluster kubeconfig get --admin
tkg get credentials WORKLOAD_CLUSTER_NAME tanzu cluster kubeconfig get WORKLOAD_CLUSTER_NAME --admin
tkg delete machinehealthcheck tanzu cluster machinehealthcheck delete
tkg get machinehealthcheck tanzu cluster machinehealthcheck get
tkg set machinehealthcheck tanzu cluster machinehealthcheck set
tkg get ceip-participation tanzu management-cluster ceip-participation get
tkg set ceip-participation tanzu management-cluster ceip-participation set
tkg delete management-cluster tanzu management-cluster delete
tkg upgrade management-cluster tanzu management-cluster upgrade
tkg version tanzu version
tkg get kubernetesversions tanzu kubernetes-release get

Use an Existing Bootstrap Cluster

By default, when you deploy a management cluster by running tanzu management-cluster create, Tanzu Kubernetes Grid creates a temporary kind cluster on the bootstrap machine, that it uses to provision the final management cluster. This temporary cluster is removed after the deployment of the final management cluster to vSphere, Amazon EC2, or Azure completes successfully. The same process of creating a temporary kind cluster also applies when you run tanzu management-cluster delete to remove a management cluster.

In some circumstances, it might be desirable to keep the local bootstrap cluster after deploying or deleting a management cluster. For example, you might want to examine the objects in the cluster or review its logs. In this case, you can skip the creation of the kind cluster and use any Kubernetes cluster that already exists on your bootstrap machine as the local bootstrap cluster.

IMPORTANT:

  • Using an existing bootstrap cluster is an advanced use case that is for experienced Kubernetes users. It is strongly recommended to use the default kind cluster that Tanzu Kubernetes Grid provides to bootstrap your management clusters.
  • If you have used an existing cluster to bootstrap a management cluster, you cannot use that same cluster to bootstrap another management cluster. The same applies to deleting management clusters.

Procedure

  1. Set the context of kubectl to the local Kubernetes cluster that you want to use as a bootstrap cluster.

    kubectl config use-context my-bootstrap-cluster-admin@my-bootstrap-cluster
    
  2. To create a management cluster, run the tanzu management-cluster create command and specify the --use-existing-bootstrap-cluster option.

    tanzu management-cluster create --file vsphere-mc.yaml --use-existing-bootstrap-cluster my-bootstrap-cluster
    
  3. To delete a management cluster, run the tanzu management-cluster delete command and specify the --use-existing-cleanup-cluster option.

    tanzu management-cluster delete --use-existing-cleanup-cluster my-cleanup-cluster
    
check-circle-line exclamation-circle-line close-line
Scroll to top icon