Skip to main content
logoTetrate Service BridgeVersion: next

Acquire the tctl tool

The tctl tool provides API access to manage the TSB configuration. It's the easiest way to get started with configuring TSB.

tip

The get-tctl.sh script is a helper for users of the Hosted TSB management plane. You can also download and configure tctl manually, using the following instructions:

Acquire and Configure the tctl tool​

  1. Download the tool (Linux, macOS, Windows/WSL)​

    curl -sLO https://charts.dl.tetrate.io/public/raw/files/get-tctl.sh

    bash ./get-tctl.sh --help

    Check the version of your Tetrate Management Plane in the UI, and download the matching version of the tctl tool:

    bash ./get-tctl.sh --version 1.NEXT.0-dev

  2. Configure tctl Connection​

    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:

    tctl config clusters set default --bridge-address <myinstance.mp.cloud.tetrate.com:443>
    tctl config users set default --username <admin> --password <mypassword> --org <tetrate>
    tctl config profiles set default --username default --cluster default
    tctl config profiles set-current default

  3. Verify connection​

    tctl version

    You can expect to see output resembling:

    TCTL version: v1.NEXT.0-dev
TSB version: v1.NEXT.0-dev

Next steps​

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