This topic explains how to install and initialize the Tanzu command line interface (CLI) on a bootstrap machine. The bootstrap machine is the laptop, host, or server that you deploy management and workload clusters from, and that keeps the Tanzu and Kubernetes configuration files for your deployments. The bootstrap machine is typically local, but it can also be a physical machine or VM that you access remotely.
Once the Tanzu CLI is installed, the second and last step to deploying Tanzu Kubernetes Grid is using the Tanzu CLI to create or designate a management cluster on each cloud provider that you use. The Tanzu CLI then communicates with the management cluster to create and manage workload clusters on the cloud provider.
VMware provides Tanzu CLI binaries for Linux, macOS, and Windows systems.
The bootstrap machine on which you run the Tanzu CLI must meet the following requirements:
kindcontainer. 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 machine, 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.
tanzu CLI ships with a compatible version of the
kubectl CLI. To download and unpack both:
Visit the Tanzu Kubernetes Grid downloads page and click Go to Downloads.
Under Product Downloads, scroll to the section labeled VMware Tanzu CLI 1.3.0.
Navigate to the Kubectl 1.20.4 for VMware Tanzu Kubernetes Grid 1.3.0 section of the download page.
(Optional) Verify that your downloaded files are unaltered from the original. VMware provides a SHA-1, a SHA-256, and an MD5 checksum for each download. To obtain these checksums, click Read More under the entry that you want to download. For more information, see Using Cryptographic Hashes.
On your system, create a new directory named
tanzu folder, unpack the Tanzu Kubernetes Grid CLI bundle file for your operating system. To unpack the bundle file, use the extraction tool of your choice. For example, the
tar -xvf command.
After you unpack the bundle file, in your
tanzu folder, you will see a
cli folder with multiple subfolders and files.
The files in
cli directory, such as
kbld, are required by the Tanzu Kubernetes Grid extensions and add-ons. You will need these files later when you install the extensions and register add-ons.
kubectl binary file for your operating system. The unpacked kubectl binary files are
After you have downloaded and unpacked the Tanzu CLI on your bootstrap machine, you must make it available to the system.
Navigate to the
tanzu/cli folder that you unpacked in the previous section.
Make the CLI available to the system:
sudo install core/v1.3.0/tanzu-core-darwin_amd64 /usr/local/bin/tanzu
sudo install core/v1.3.0/tanzu-core-linux_amd64 /usr/local/bin/tanzu
clifolder, locate and copy the
core\v1.3.0\tanzu-core-windows_amd64.exeinto the new
tanzufolder, 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
tanzu version to check that the correct version of the CLI is properly installed.
If you are running on macOS, you might encounter the following error:
"tanzu" cannot be opened because the developer cannot be verified.
If this happens, you need to create a security exception for the
tanzu executable. Locate the
tanzu app in Finder, control-click the app, and select Open.
After you have installed the
tanzu core executable, you must install the CLI plugins related to Tanzu Kubernetes cluster management and feature operations.
(Optional) Remove existing plugins from any previous CLI installations.
tanzu plugin clean
Navigate to the
tanzu folder that contains the
Run the following command from the
tanzu directory to install all the plugins for this release.
tanzu plugin install --local cli all
Check plugin installation status.
tanzu plugin list
If successful, you should see a list of all installed plugins. For example:
NAME LATEST VERSION DESCRIPTION REPOSITORY VERSION STATUS cluster v1.3.0 Kubernetes cluster operations core v1.3.0 installed login v1.3.0 Login to the platform core v1.3.0 installed pinniped-auth v1.3.0 Pinniped authentication operations (usually not directly invoked) core v1.3.0 installed kubernetes-release v1.3.0 Kubernetes release operations core v1.3.0 installed management-cluster v1.3.0 Kubernetes management cluster operations tkg v1.3.0 installed
To install the version of
kubectl compatible with the Tanzu CLI, use the same process as in Install the Tanzu CLI above, but with the following substitutions:
kubectl(Linux, macOS) or
kubectl versionto check the correct version, and create a security exception if needed.
tanzu --help to see the list of commands that the Tanzu CLI provides.
You can view help text for any command group with the
--help option to see information about that specific command or command group. For example,
tanzu login --help,
tanzu management-cluster --help, or
tanzu management-cluster create --help.
For more information about the Tanzu CLI, see the Tanzu CLI Command Reference.
With the Tanzu CLI installed, you can set up and use your bootstrap machine to deploy Kubernetes clusters to vSphere, Amazon EC2, and Microsoft Azure.