Version: Next

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 Jalapeno#

First, a Jalapeno instance must be installed. You can use the Helm chart template from our GitHub repository.

1. Clone repository#

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

2. Update values#

Update the values in jalapeno-helm/values.yaml according to your needs.

At least change the load balancer IPs for the gobmp and the ingress telegraf collector:

collectors.service.gobmp.loadBalancerIP
collectors.telegrafIngress.service.loadBalancerIP

3. Create a namespace#

Create a new namespace e.g. jalapeno

kubectl create namespace jalapeno

4. Install the Helm chart#

helm install jalapeno ./jalapeno-helm -n jalapeno

Install JAGW#

1. Clone the repository#

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

2. 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.

3. Create a namespace#

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

kubectl create namespace jagw

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 jagwhelm delete namespace jagw