Managing Control Planes

Introduction

Control Planes are situated in your Organization’s home region and provide links to an instance of the Tyk Dashboard and the Developer Portal. The Dashboard is where you perform all your API tasks. The developer portal allows your 3rd party developers access to your APIs. Cloud Data Planes are then connected to your Control Planes.

Prerequisites

All user roles can edit, deploy, undeploy, restart, redeploy all deployments within a team. Only the Organization Admin and the Team Admin can create or delete deployments.

Adding a new Control Plane

Watch our video on setting up a Control Plane and a Cloud Data Plane.

1. From the Deployments screen click Add Deployment (you can also add a Deployment from within an Environment overview)
2. Enter a name for the new Control Plane
3. Select Control Plane from the Type drop-down list
4. Select the Bundle Channel and Version
5. (Optional) Enter a custom domain if required
6. (Optional) Enable plugins if required

Edit Control Planes

You can edit the following Control Plane settings:

• Change the Control Plane name
• Add a custom domain
• Change the Bundle Channel and Bundle Version
• Enable plugins

To edit an existing Control Plane:

1. From the Deployments screen, click the Control Plane Name from the list
2. Select Edit from the Deployed drop-down list

Upgrade Control Planes

To upgrade an existing Control Plane:

1. Go to the Control Plane settings using the Edit Control Planes instructions and scroll down to the Version section.
2. Select a Bundle Channel.

3. Next, select a Bundle Version.

4. To apply your changes, click the “Save and Re-Deploy” button located at the top right. After a few seconds, you will be redirected to the overview page of the Control Plane and a “Deploying” indicator button will appear.

5. A “Deployed” button indicates a successful upgrade.