Add a Gateway Instance

A gateway instance is a single proxy that handles traffic. Gateway instances belong to gateway groups. This document describes how to add a gateway instance to a gateway group using any of the following methods:

• Docker
• Kubernetes

Prerequisites

1. Obtain a user account with Super Admin or Runtime Admin role.
2. Add a gateway group. This tutorial assumes that you have created a gateway group named Production.
3. Install Docker if you add a gateway instance using Docker.
4. Install Helm and Kubernetes if you add a gateway instance using Kubernetes.

:::Warning

If you use a platform like OpenShift, you need to grant API7 Enterprise Security Context Constraints (SCC) in advance.

:::

Steps

Docker

1. Click the Production gateway group and then click Add Gateway Instance.
2. Follow the instructions on the page to perform the following operations.
• Set the HTTP port ID and HTTPS port ID to 9080 and 9443 respectively.
• (Optional) set the gateway instance name to test.
3. Click Generate to get the commands that are used to add the gateway instance to the Production gateway group.
4. Open a terminal and run the generated commands.

Kubernetes

1. Click the Production gateway group and then click Add Gateway Instance.
2. Follow the instructions on the page to perform the following operations.
• Set Helm Release Name to api7-ee-3-gateway.
• Set Namespace to api7-ee.
• Set Replicas to 1.
3. Click Generate to get the commands or YAML configurations that are used to add the gateway instance to the Production gateway group.
4. For CLI users, open a terminal and run the generated commands.
5. For YAML file users, update and apply your YAML configuration file.