Accepting Tanzu Application Platform EULAs and installing Tanzu CLI

This topic describes how to:

Accept Tanzu Application Platform EULAs
Set the Kubernetes cluster context
Install or update the Tanzu CLI and plug-ins

Accept the End User License Agreements

Before downloading and installing Tanzu Application Platform packages, you must accept the End User License Agreements (EULAs) as follows:

Sign in to VMware Tanzu Network.
Accept or confirm that you have accepted the EULAs for each of the following:
- Tanzu Application Platform
- Cluster Essentials for VMware Tanzu

Example of accepting the Tanzu Application Platform EULA

To accept the Tanzu Application Platform EULA:

Go to Tanzu Application Platform.
Select the Click here to sign the EULA link in the yellow warning box under the release drop-down menu. If the yellow warning box is not visible, the EULA has already been accepted.
Select Agree in the bottom-right of the dialog box as seen in the following screenshot.

Set the Kubernetes cluster context

To set the Kubernetes cluster context:

List the existing contexts by running:

kubectl config get-contexts

For example:

$ kubectl config get-contexts
CURRENT   NAME                                CLUSTER           AUTHINFO                                NAMESPACE
        aks-repo-trial                      aks-repo-trial    clusterUser_aks-rg-01_aks-repo-trial
*       aks-tap-cluster                     aks-tap-cluster   clusterUser_aks-rg-01_aks-tap-cluster

Set the context to the cluster that you want to use for the Tanzu Application Platform packages installation by running:
```
kubectl config use-context CONTEXT
```
Where CONTEXT is the cluster that you want to use. For example, aks-tap-cluster.

For example:
```
$ kubectl config use-context aks-tap-cluster
Switched to context "aks-tap-cluster".
```

Install or update the Tanzu CLI and plug-ins

You use the Tanzu CLI and plug-ins to install and use the Tanzu Application Platform functions and features.

To install the Tanzu CLI and plug-ins:

Sign in to VMware Tanzu Network.
Go to the Tanzu Application Platform product page.
Select Release {{ vars.tap_version }} from the release drop-down menu.
Click tanzu-cli-tap-{{ vars.tap_version }} to list the Tanzu framework bundles.
Click and download the Tanzu framework bundle for your operating system.
(Optional) If an earlier upgrade attempt failed, you can uninstall the previous version of the Tanzu CLI and associated plug-ins and files. See Remove Tanzu CLI, plug-ins, and associated files for more information.

For Windows installation instructions, see Install Tanzu CLI: Windows.

Install Tanzu CLI: Linux or macOS

Create a $HOME/tanzu directory on your local machine.

Unpack the downloaded TAR file into the $HOME/tanzu directory by running:

For Linux:

tar -xvf tanzu-framework-linux-amd64.tar -C $HOME/tanzu

For macOS:

tar -xvf tanzu-framework-darwin-amd64.tar -C $HOME/tanzu

Set the environment variable TANZU_CLI_NO_INIT to true to ensure the local downloaded versions of the CLI core and plug-ins are installed by running:
```
export TANZU_CLI_NO_INIT=true
```
Install or update the CLI core by running:

Note Replace v0.25.0 with the version you've downloaded which can be found by inspecting the directory name under $HOME/tanzu/cli/core/. For example, if the directory name under $HOME/tanzu/cli/core/ is v0.25.1, then set VERSION below to v0.25.1
- For Linux:
```
cd $HOME/tanzu
export VERSION=v0.25.0
sudo install cli/core/$VERSION/tanzu-core-linux_amd64 /usr/local/bin/tanzu
```
- For macOS:
```
cd $HOME/tanzu
export VERSION=v0.25.0
install cli/core/$VERSION/tanzu-core-darwin_amd64 /usr/local/bin/tanzu
```
Confirm the installation by running:
```
tanzu version
```
Expected outcome:
```
version: v0.25.0
...
```
Proceed to Install/Update Tanzu CLI plug-ins

Install Tanzu CLI: Windows

Open the Windows file browser.
Create a Program Files\tanzu directory on your local machine.
From the Downloads directory, right-click the tanzu-framework-windows.amd64.zip file, select the Extract All... menu option, enter C:\Program files\tanzu in the Files are extracted to this directory: text box, and click the Extract.

From the Program Files\tanzu directory, move and rename; the executable file from

Program Files\tanzu\cli\core\v0.25.0\tanzu-core-windows_amd64.exe

Program Files\tanzu\tanzu.exe

From the Program Files directory, right-click the tanzu directory and select Properties > Security.
Ensure that your user account has the Full Control permission.
Use Windows Search to search for env, select Edit the system environment variables, click Environment Variables on the bottom right of the dialogue box.
Find and select the Path row under System variables, click Edit.
Click New, enter the path value, click OK.

Note: The path value must not include tanzu.exe. For example, C:\Program Files\tanzu.
Click New following the System Variables section, add a new environmental variable named TANZU_CLI_NO_INIT with a variable value true, click OK.
Use Windows Search to search for cmd, select Command Prompt to open the command line terminal.
Verify the Tanzu CLI installation by running:
```
tanzu version
```
Expected outcome:
```
version: v0.25.0
...
```
Proceed to Install/Update Tanzu CLI plug-ins

Install/Update Tanzu CLI plug-ins

To install or update Tanzu CLI plug-ins from your terminal, follow these steps:

Install plug-ins from the $HOME/tanzu directory (if on Linux or macOS) or Program Files\tanzu directory (if on Windows) by running:
```
tanzu plugin install --local cli all
```

Verify that you installed the plug-ins by running:

tanzu plugin list

Expected outcome:

NAME                DESCRIPTION                                                                       SCOPE       DISCOVERY  VERSION  STATUS
login               Login to the platform                                                             Standalone  default    v0.25.0  not installed
management-cluster  Kubernetes management-cluster operations                                          Standalone  default    v0.25.0  not installed
package             Tanzu package management                                                          Standalone  default    v0.25.0  installed
pinniped-auth       Pinniped authentication operations (usually not directly invoked)                 Standalone  default    v0.25.0  not installed
secret              Tanzu secret management                                                           Standalone  default    v0.25.0  installed
telemetry           Configure cluster-wide telemetry settings                                         Standalone  default    v0.25.0  not installed
services            Explore Service Instance Classes, discover claimable Service Instances and        Standalone             v0.4.0   installed
                   manage Resource Claims
accelerator         Manage accelerators in a Kubernetes cluster                                       Standalone             v1.3.0   installed
apps                Applications on Kubernetes                                                        Standalone             v0.9.0   installed
insight             post & query image, package, source, and vulnerability data                       Standalone             v1.3.3   installed

Next steps

For online installation:

For air-gapped installation:

* When you use a VMware Tanzu Kubernetes Grid cluster, there is no need to install Cluster Essentials because the contents of Cluster Essentials are already installed on your cluster.

FilesExpand file tree

install-tanzu-cli.hbs.md

Latest commit

History