Acquire the Tools and Images

Before you onboard or upgrade a workload cluster, you will need three resources:

• tctl: The tctl tool provides API access to manage the TSB configuration, and is used to acquire the software images. It's the easiest way to get started with configuring TSB.
• helm charts: Workload clusters are onboarded and upgraded using helm
• TSB Software Images: You'll need to acquire the appropriate software images before applying a helm chart

Get the resources

Before you begin, check the version of your TSB Management Plane:

• Log in to the Management Plane UI
• Click the dropdown by your username (top right-hand corner)
• Make a note of the version, such as 1.14.3005

1. Acquire the tctl tool (Linux, macOS, Windows/WSL)

   Download

   Use the helper script rather than downloading manually

   The get-tctl.sh script is a helper for users of the Hosted TSB management plane:

   curl -sLO https://dl.cloudsmith.io/public/tetrate/tetrate-platform-scripts/raw/files/get-tctl.sh
   
   bash ./get-tctl.sh --help

   Download the required version of the tctl tool and place it in your $PATH:

   bash ./get-tctl.sh --version {vars.versionNumber}

   You can download the tctl tool manually, following the installation instructions.

   Authenticate

   Authenticate the tctl tool to your Management Plane installation. The required information will have been provided in your welcome email. The org can also be viewed in the upper right hand part of the TSB UI:

   ADDRESS=myinstance.mp.cloud.tetrate.com
   ADMIN_USER=admin
   ADMIN_PASS=mypassword
   DEFAULT_ORG=tetrate
   
   tctl config clusters set default --bridge-address ${ADDRESS}:443
   tctl config users set default --username ${ADMIN_USER} --password ${ADMIN_PASS} --org ${DEFAULT_ORG}
   tctl config profiles set default --username default --cluster default
   tctl config profiles set-current default

   Check that the tctl tool is correctly authenticated:

   tctl version

   You can expect to see output resembling:

   TCTL version: v1.14.3005
   TSB version: v1.14.3005

2. Acquire the Helm charts

   What version do I need?

   The TSB Management Plane supports Control Plane installs up to 2 minor versions behind (support statement), and CVE patch releases versions with the same point release number.

   For example, if your TSB Management Plane is version 1.14.3:

   • You should install the latest CVE patch release of 1.14.3, such as 1.14.30005
   • Existing control planes can run version 1.12.x or later, but should be upgraded when convenient

   Acquire the Charts

   helm repo add tetrate-tsb-helm 'https://charts.dl.tetrate.io/public/helm/charts/'
   helm repo update

   Check available versions:

   helm search repo tetrate-tsb-helm/controlplane --versions

3. Acquire the TSB images

   The TSB images are located in an authenticated repository. Before installing, you need to copy the correct image versions to a local repository.

   The tctl version is important

   You copy the images using the tctl install image-sync command. You must use the same tctl version as the images you wish to copy.

   If you want to install a Control Plane version that is different to your Management Plane version, you will need to download the matching tctl version.

   Download the images by following the "acquire images" instructions, then proceed with these instructions.

Next steps

Once you have downloaded and configured tctl, and acquired the helm charts and images, the next step is to onboard a new workload cluster to your TSB installation.