Tanzu Community Edition

Documentation

Install Tanzu CLI

Tanzu Community Edition consists of the Tanzu CLI and a select set of plugins. You will install Tanzu CLI on your local machine and then use the Tanzu CLI to deploy ( bootstrap) a cluster to your chosen target platform.

Installing the Tanzu CLI extracts the binaries and configures the plugin repositories. The first time you run the tanzu command the installed plugins and plugin repositories are initialized. This action might take a minute.

Note: The following information relates to a management/workload cluster deployment which provides a full-featured, scalable Kubernetes implementation suitable for a development or production environment. If you are interested in quickly spinning up a lightweight cluster for a development/experimental environment, see Create Unmanaged Clusters.

Procedure

Linux Local Bootstrap Machine Prerequisites

Arch: x86; ARM is currently unsupported
RAM: 6 GB
CPU: 2
Docker
In Docker, you must create the docker group and add your user before you attempt to create a management cluster. Complete steps 1 to 4 in the Manage Docker as a non-root user procedure in the Docker documentation.
Kubectl
Latest version of Chrome, Firefox, Safari, Internet Explorer, or Edge
System time is synchronized with a Network Time Protocol (NTP) server.

Installation Procedure

  1. You must download and install the latest version of kubectl. For more information, see Install and Set Up kubectl on Linux in the Kubernetes documentation.

  2. You must download and install the latest version of docker. For more information, see Install Docker Engine in the Docker documentation.

Option 1: Homebrew

  1. Make sure you have the Homebrew package manager installed

  2. Run the following in your terminal:

    brew install vmware-tanzu/tanzu/tanzu-community-edition
    
  3. Run the post install configuration script. Note the output of the brew install step for the correct location of the configure script:

    {HOMEBREW-INSTALL-LOCATION}/configure-tce.sh
    

    This puts all the Tanzu plugins in the correct location. The first time you run the tanzu command the installed plugins and plugin repositories are initialized. This action might take a minute.

Option 2: Curl GitHub release

  1. Download the release for Linux via web browser.

  2. [Alternative] Download the release using the CLI. You may download a release using the provided remote script piped into bash.

    curl -H "Accept: application/vnd.github.v3.raw" \
        -L https://api.github.com/repos/vmware-tanzu/community-edition/contents/hack/get-tce-release.sh | \
        bash -s <RELEASE-VERSION> <RELEASE-OS-DISTRIBUTION>
    
    • Where <RELEASE-VERSION> is the Tanzu Community Edition release version. This is a required argument.
    • Where <RELEASE-OS-DISTRIBUTION> is the Tanzu Community Edition release version and distribution. This is a required argument.
    • For example, to download v0.11.0 for Linux, provide:
      bash -s v0.11.0 linux
    • This script requires curl, grep, sed, tr, and jq in order to work
    • The release will be downloaded to the local directory as tce-linux-amd64-v0.11.0.tar.gz
    • Note: A GitHub personal access token may be provided to the script as the GITHUB_TOKEN environment variable. This bypasses GitHub API rate limiting but is not required. Follow the GitHub documentation to acquire and use a personal access token.
  3. Unpack the release.

    tar xzvf ~/<DOWNLOAD-DIR>/tce-linux-amd64-v0.11.0.tar.gz
    
  4. Run the install script (make sure to use the appropriate directory for your platform).

    cd tce-linux-amd64-v0.11.0
    ./install.sh
    

    This installs the Tanzu CLI and puts all the plugins in the correct location. The first time you run the tanzu command the installed plugins and plugin repositories are initialized. This action might take a minute.

  5. You must download and install the latest version of kubectl.

    curl -LO https://dl.k8s.io/release/v1.20.1/bin/linux/amd64/kubectl
    sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
    

    For more information, see Install and Set Up kubectl on Linux in the Kubernetes documentation.

Mac Local Bootstrap Machine Prerequisites

Arch: x86; ARM (M1) currently unsupported
RAM: 6 GB
CPU: 2
Docker Desktop for Mac; Version <= 4.2.0
Kubectl
Latest version of Chrome, Firefox, Safari, Internet Explorer, or Edge

Installation Procedure

You can install the Tanzu CLI using Homebrew or you can download the binary and install.

Option 1: Use the Homebrew install method

  1. Make sure you have the Homebrew package manager installed.

  2. Run the following in your terminal:

    brew install vmware-tanzu/tanzu/tanzu-community-edition
    
  3. Run the post install configuration script. Note the output of the brew install step for the correct location of the configure script:

    <HOMEBREW-INSTALL-LOCATION>/v0.11.0/libexec/configure-tce.sh
    

Option 2: Use the binary download/install method

  1. Download the release for macOS.

  2. Change to the download directory and unpack the release. Run the following in your terminal:

    cd <DOWNLOAD-DIR>
    tar xzvf tce-darwin-amd64-v0.11.0.tar.gz
    
  3. Change to the extracted directory and run the install script.

    cd tce-darwin-amd64-v0.11.0
    ./install.sh
    

Windows Local Bootstrap Machine Prerequisites

RAM: 8 GB
CPU: 2
Docker Desktop for Windows
Kubectl
Latest version of Chrome, Firefox, Safari, Internet Explorer, or Edge

Note: Bootstrapping a cluster to Docker from a Windows bootstrap machine is currently experimental, for more information, see Docker-based Clusters on Windows.

Installation Procedure

You can install the Tanzu CLI using Chocolatey or you can download the binary and install.

Option 1: Use the Chocolatey installation method

  1. Make sure you have the Chocolatey package manager installed.

  2. Open Windows PowerShell as an administrator and run the following:

    choco install tanzu-community-edition
    
  3. The tanzu command will be added to your $PATH variable automatically by Chocolatey.

Option 2: Use the Binary download/installation method

  1. Download the release for Windows.

  2. Open Windows PowerShell as an administrator, change to the download directory and unpack the release, for example,

    cd <DOWNLOAD-DIR>
    Expand-Archive -Path 'tce-windows-amd64-v0.11.0.zip'
    
  3. Change to the extracted directory and run .\install.bat.

    cd tce-windows-amd64-v0.11.0\tce-windows-amd64-v0.11.0
    .\install.bat
    
  4. Complete the following steps to add C:\Program Files\tanzu to your PATH.

    1. Search for env, and choose Edit the system environment variables.
    2. Select Environment Variables, under System Variable, select Path, and create a new path for C:\Program Files\tanzu.

Join us!

Our open community welcomes all users and contributors

Community