Tanzu Community Edition

Documentation

Install Tanzu Community Edition

Tanzu Community Edition consists of the Tanzu CLI and a select set of plugins. You will install Tanzu Community Edition on your local machine and then use the Tanzu CLI on your local machine to deploy a cluster to your chosen target platform. Your local machine is often referred to as your bootstrap machine, and the process of deploying a cluster is referred to as bootstrapping. For more information, see the Glossary.

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 standalone or 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.
Ensure your Linux bootstrap machine is using cgroup v1, for more information, see Check and set the cgroup below.

Check and set the cgroup

  1. Check the cgroup by running the following command:

    docker info | grep -i cgroup 
    

    You should see the following output:

    Cgroup Driver: cgroupfs
    Cgroup Version: 1
    
  2. If your Linux distribution is configured to use cgroups v2, you will need to set the systemd.unified_cgroup_hierarchy=0 kernel parameter to restore cgroups v1. See the instructions for setting kernel parameters for your Linux distribution, including:

    Fedora 32+

    Arch Linux

    OpenSUSE

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.9.1 for Linux, provide:
      bash -s v0.9.1 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.9.1.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 aquire and use a personal access token.
  3. Unpack the release.

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

    cd tce-linux-amd64-v0.9.1
    ./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

Check the cgroup version

  1. Check the cgroup by running the following command:

    docker info | grep -i cgroup 
    

    You should see the following output:

    Cgroup Driver: cgroupfs
    Cgroup Version: 1
    
  2. If you see cgroup version 2, you are running an incompatible version of Docker Desktop. To resolve this, we recommend running Docker Desktop 4.2.0.

    In a future release, we’ll support cgroupsv2 which will resolve this issue. Please follow issue 2798 for progress.

Installation Procedure

  1. Make sure you have the Homebrew package manager installed

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

  3. You must download and install the latest version of docker. For more information, see Install Docker Desktop on MacOS in the Docker documentation.

  4. Run the following in your terminal:

    brew install vmware-tanzu/tanzu/tanzu-community-edition
    
  5. 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.9.1/libexec/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.

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.

Check the cgroup version

  1. Check the cgroup by running the following command:

    docker info | grep -i cgroup 
    

    You should see the following output:

    Cgroup Driver: cgroupfs
    Cgroup Version: 1
    
  2. If you see cgroup version 2, you are running an incompatible version of Docker Desktop. To resolve this, we recommend running Docker Desktop 4.2.0.

    In a future release, we’ll support cgroupsv2 which will resolve this issue. Please follow issue 2798 for progress.

Installation Procedure

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

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

  3. You must download and install the latest version of docker. For more information, see Install Docker Desktop on Windows in the Docker documentation.

  4. Open PowerShell as an administrator and run the following:

    choco install tanzu-community-edition
    

    Both docker and kubectl are required to be present on the system, but are not explicit Chocolatey dependencies. Installing the Tanzu Community Edition package will extract the binaries and configure the plugin repositories. This might take a minute.

  5. The tanzu command will be added to your $PATH variable automatically by Chocolatey.

Join us!

Our open community welcomes all users and contributors

Community