Skip to main content

Install

Attaching a Gateway registers it with a specific environment, so it can start serving the API Products deployed there.

Attach a Gateway

  1. From Gateways, select Install Gateways.
  2. Enter a Group Name and an optional Description for the new Gateway Group. The Bootstrap Token is pre-filled from the current environment; copy it, or select the ? for how to regenerate it if it's lost.
  3. Under Choose a Distribution, select Approve on the Kubernetes distribution you're deploying to (Amazon EKS, Azure AKS, Google GKE, or self-managed Kubernetes) to authorize the install, or use All install options for other targets.
Install Gateways dialog with group name, bootstrap token, and Kubernetes distribution picker
Install Gateways dialog with group name, bootstrap token, and Kubernetes distribution picker

The Gateway phones home with the bootstrap token and joins the environment, typically within about 30 seconds. Once attached, it appears as a new Gateway Group.

Next Steps

  • Environments covers regenerating or revoking the bootstrap token used above.
  • Configuration covers reviewing the Gateway Group's resolved configuration once it's running.