Version: Next

OpenShift

This document explains how you can install APISIX ingress locally on OpenShift.

Prerequisites#

Setting up APISIX ingress on OpenShift requires the following:

Before Start#

You should create a Project to deploy APISIX Ingress controller. e.g. ingress-apisix

Due to the existence of security context constraints (SCC) in OpenShift, you need to create an authorized account for deployment.

You can complete the relevant operations through oc CLI.

Install APISIX and ingress controller#

The script below installs APISIX and the ingress controller:

helm repo add apisix https://charts.apiseven.com
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update
#  We use Apisix 3.0 in this example. If you're using Apisix v2.x, please set to v2
ADMIN_API_VERSION=v3
helm install apisix apisix/apisix \
  --set service.type=NodePort \
  --set ingress-controller.enabled=true \
  --set etcd.podSecurityContext.enabled=false \
  --set etcd.containerSecurityContext.enabled=false \
  --create-namespace \
  --namespace ingress-apisix \
  --set ingress-controller.config.apisix.serviceNamespace=ingress-apisix \
  --set ingress-controller.config.apisix.adminAPIVersion=$ADMIN_API_VERSION
kubectl get service --namespace ingress-apisix

tip

APISIX Ingress also supports (beta) the new Kubernetes Gateway API.

If the Gateway API CRDs are not installed in your cluster by default, you can install it by running:

kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.5.0/standard-install.yaml

You should also enable APISIX Ingress controller to work with the Gateway API. You can do this by adding the flag --set ingress-controller.config.kubernetes.enableGatewayAPI=true while installing through Helm.

See this tutorial for more info.

This will create the five resources mentioned below:

apisix-gateway: dataplane the process the traffic.
apisix-admin: control plane that processes all configuration changes.
apisix-ingress-controller: ingress controller which exposes APISIX.
apisix-etcd and apisix-etcd-headless: stores configuration and handles internal communication.

You should now be able to use APISIX ingress controller. You can try running this minimal example to see if everything is working perfectly.