Skip to content

Latest commit

 

History

History
227 lines (146 loc) · 9.03 KB

install-tanzu-cli.md

File metadata and controls

227 lines (146 loc) · 9.03 KB
Raw

Accepting Tanzu Application Platform EULAs, installing Cluster Essentials and the Tanzu CLI

This topic describes how to:

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:

  1. Sign in to VMware Tanzu Network.

  2. Accept or confirm that you have accepted the EULAs for each of the following:

Example of accepting the Tanzu Application Platform EULA

To accept the Tanzu Application Platform EULA:

  1. Go to Tanzu Application Platform.

  2. Select the Click here to sign the EULA link in the yellow warning box under the release drop-down menu as seen in the screenshot below. If the yellow warning box is not visible, the EULA has already been accepted.

    Screenshot of a VMware Tanzu Network download page. The EULA Warning has appeared.

  3. Select Agree in the bottom-right of the dialog box as seen in the following screenshot.

    Screenshot of a dialog box inviting the reader to accept the EULA. The AGREE button is framed.

Set the Kubernetes cluster context

To set the Kubernetes cluster context:

  1. 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

  2. Set the context to the cluster that you want to use for the Tanzu Application Platform packages installation. For example, set the context to the aks-tap-cluster context by running:

    kubectl config use-context aks-tap-cluster

    For example:

    $ kubectl config use-context aks-tap-cluster
Switched to context "aks-tap-cluster".

Install Cluster Essentials for Tanzu

Cluster Essentials for VMware Tanzu simplifies the process of installing the open-source Carvel tools on your cluster. It includes a script to download and install supported versions of kapp-controller and secretgen-controller on the target cluster. It also installs the kapp, imgpkg, ytt, and kbld CLIs on your local machine. Currently, Cluster Essentials only supports macOS and Linux.

If you are using a VMware Tanzu Kubernetes Grid cluster, you don't need to install Cluster Essentials because the contents of Cluster Essentials are already installed on your cluster.

To install Cluster Essentials, see Deploying Cluster Essentials.

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:

  1. Sign in to VMware Tanzu Network.
  2. Go to the TAP Release v1.1.0 > tanzu-cli-v0.11.2 download tile page.
  3. Download the Tanzu framework bundle for your operating system.
  4. (Optional) To uninstall a previous version of the Tanzu CLI and associated plug-ins and files, see Remove Tanzu CLI, plug-ins, and associated files.

Install Tanzu CLI: Linux or macOS

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

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

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

  3. 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

  4. Install or update the CLI core by running:

    • For Linux:

      cd $HOME/tanzu
VERSION=v0.11.2 sudo install cli/core/$VERSION/tanzu-core-linux_amd64 /usr/local/bin/tanzu

    • For macOS:

      cd $HOME/tanzu
VERSION=v0.11.2 install cli/core/$VERSION/tanzu-core-darwin_amd64 /usr/local/bin/tanzu

  5. Confirm the installation by running:

    tanzu version

    Expected outcome:

    version: v0.11.2
...

Install Tanzu CLI: Windows

  1. Create a Program Files\tanzu directory on your machine.

  2. Unpack the downloaded TAR file into the Program Files\tanzu directory.

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

    Program Files\tanzu\core\v0.11.2\tanzu-core-windows_amd64.exe

    to

    Program Files\tanzu\tanzu.exe

  4. From the Program Files directory, right-click the tanzu directory and select Properties > Security.

  5. Ensure that your user account has the Full Control permission.

  6. Use Windows Search to search for env.

  7. Select Edit the system environment variables and click Environment Variables.

  8. Select the Path row under System variables and click Edit.

  9. Click New to add a new row and enter the path to tanzu.exe.

  10. Set the environmental variable TANZU_CLI_NO_INIT to true.

  11. From the terminal in the Program Files\tanzu directory, verify the installation by running:

    tanzu version

    Expected outcome:

    version: v0.11.2
...

Install Tanzu CLI plug-ins only

To perform a clean installation of the Tanzu CLI plug-ins:

  1. 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

  2. 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.11.1      not installed
management-cluster  Kubernetes management-cluster operations                                      Standalone  default               v0.11.1      not installed
package             Tanzu package management                                                      Standalone  default               v0.11.1      installed
pinniped-auth       Pinniped authentication operations (usually not directly invoked)             Standalone  default               v0.11.1      not installed
secret              Tanzu secret management                                                       Standalone  default               v0.11.1      installed
services            Discover Service Types, Service Instances and manage Resource Claims (ALPHA)  Standalone                        v0.2.0-rc.1  installed
accelerator         Manage accelerators in a Kubernetes cluster                                   Standalone                        v1.1.0       installed
apps                Applications on Kubernetes                                                    Standalone                        v0.5.0       installed
insight             post & query image, package, source, and vulnerability data                   Standalone                        v1.1.0       installed

Note: Currently, insight plug-in only supports macOS and Linux.

You can now proceed with installing the Tanzu Application Platform Package and Profiles.