To use Tanzu Kubernetes Grid, you download and run the Tanzu Kubernetes Grid CLI on a local system, known as the bootstrap environment. The bootstrap environment is the laptop, host, or server on which the initial bootstrapping of a management cluster is performed. This is where you run Tanzu Kubernetes Grid CLI commands. Tanzu Kubernetes Grid creates a temporary management cluster using a Kubernetes in Docker (
kind) cluster on the bootstrap environment. After creating the temporary management cluster locally, Tanzu Kubernetes Grid uses it to provision the final management cluster in the platform of your choice.
Tanzu Kubernetes Grid provides CLI binaries for Linux, Mac OS, and Windows systems.
The bootstrap environment on which you run the Tanzu Kubernetes Grid CLI must meet the following requirements:
If you are running Docker Desktop on Mac OS, the
kind container requires at least 6GB of RAM. For information about how to configure Docker Desktop so that it can run
kind, see Settings for Docker Desktop in the
NOTE: Tanzu Kubernetes Grid uses Cluster API. If you have previously used Cluster API on the machine that you are using as your bootstrap environment, you must delete the
~/.cluster-api folder from that machine. This folder contains Cluster API configuration files that might interfere with the correct operation of Tanzu Kubernetes Grid.
This procedure assumes that you are installing Tanzu Kubernetes Grid 1.1.3.
Scroll to the VMware Tanzu Kubernetes Grid 1.1.3 CLI entries and click the Download Now button for the type of machine that you use as the bootstrap environment.
Use either the
gunzip command or the extraction tool of your choice to unpack the binaries. Run one of the following commands:
The unpacked files are
After you have downloaded and unpacked the Tanzu Kubernetes Grid CLI binary on your bootstrap environment, you must make it available to the system.
Rename the CLI binary for your platform to
tkg, make sure that it is executable, and add it to your
Mac OS and Linux platforms:
/usr/local/binfolder and rename it to
mv ./tkg-linux-amd64-v1.1.3-vmware.1 /usr/local/bin/tkg
mv ./tkg-darwin-amd64-v1.1.3-vmware.1 /usr/local/bin/tkg
chmod +x /usr/local/bin/tkg
Program Files\tkgfolder and copy the
tkg-windows-amd64-v1.1.3-vmware.1binary into it.
tkgfolder, select Properties > Security, and make sure that your user account has the Full Control permission.
Pathrow under System variables, and click Edit.
At the command line in a new terminal, run
tkg version to check that the correct version of the binary is properly installed.
You should see information about the installed Tanzu Kubernetes Grid CLI version.
Client: Version: v1.1.3 Git commit: 0e8e58f3363a1d4b4063b9641f44a3172f6ff406
If you are running on Mac OS, you might encounter the following error:
"tkg" cannot be opened because the developer cannot be verified.
If this happens, you need to create a security exception for the
tkg executable. Locate the
tkg app in Finder, control-click the app, and select Open.
tkg --help to see the list of commands that the Tanzu Kubernetes Grid CLI provides.
You can run any command with the
--help option to see information about that specific command or sub-command. For example,
tkg init --help or
tkg create cluster --help.
tkg get management-cluster command.
tkg get management-cluster
tkg command for the first time creates the
~/.tkg folder in your home directory, that contains the Tanzu Kubernetes Grid configuration files.
~/.tkg/config.yaml, from which management clusters and Tanzu Kubernetes clusters are created.
bom-*.yamlfiles that provide references to the correct versions of all of the packages that Tanzu Kubernetes Grid requires when creating clusters for all of the versions of Kubernetes that it supports.
Most of the Tanzu Kubernetes Grid CLI commands and options have short names or aliases, so that you do not have to type the full command and option names each time you run
tkg. For example,
management-cluster. For increased clarity, this documentation always uses the full command and option names. To see the shortnames and aliases for commands and options, run CLI commands with the
The Tanzu Kubernetes Grid CLI provides common options that can be used with all of the CLI commands.
||The path to the cluster configuration file, if it is not stored in the default location with the default name,
||Show help for the current command. For example,
||The path to the shared
||Specify a file in which to save the logs for the current command. For example,
||Mute all output for the current command.|
||Set the logging verbosity level for the command.|
The Tanzu Kubernetes Grid CLI is ready to use. You can use the Tanzu Kubernetes Grid installer interface or CLI to deploy a management cluster to either vSphere or Amazon EC2.
If you have vSphere 7.0 and the vSphere with Kubernetes feature is enabled, you can directly use the Tanzu Kubernetes Grid CLI to deploy Tanzu Kubernetes clusters to vSphere with Kubernetes, without deploying a management cluster. For information about how to connect the Tanzu Kubernetes Grid CLI to a vSphere with Kubernetes Supervisor Cluster, see Use the Tanzu Kubernetes Grid CLI with a vSphere with Kubernetes Supervisor Cluster.