Skip to main content
Version: 1.3.2

Installation

Installation using Helm [Kubernetes]#

To install the Jalapeño API Gateway you can use the Helm chart template in our GitHub repository.

You will require a running Kubernetes cluster before getting started and Helm needs to be installed locally. If you use the Helm chart as is a Kubernetes load balancer is also required.

Install JAGW#

1. Clone the repository#

git clone https://github.com/jalapeno-api-gateway/jagw-helm

2. [optional] Checkout a specific version tag#

If you whish to use a specific version of JAGW, you can checkout a previous tag like this.

git checkout tags/<version>

3. Update values#

Update the values in jagw/values.yaml according to your needs.

  • inside the config section update the credentials and service addresses. Most likely only the namespaces inside the service names need to be adjusted.
  • inside the proxy section update the service section to your needs. You can use NodePorts or a LoadBalancer to connect to the gateway.

4. Create a namespace#

Create a new namespace for the JAGW (i.e. jagw).

kubectl create namespace <namespace>

5. Install the Helm chart#

helm install <release-name> jagw --namespace <namespace>

Upgrade JAGW#

To upgrade JAGW to the newest stable version, pull the updates from the main branch, reconfigure your parameters in the file jagw/values.yaml and then run:

helm upgrade <release-name> jagw --namespace <namespace>

Delete JAGW#

To delete JAGW run these commands:

helm uninstall <release-name> --namespace <namespace>helm delete namespace <namespace>