Skip to main content
Version: 1.4.0

Install Ingress APISIX on KubeSphere

This document explains how to install Ingress APISIX on KubeSphere.

KubeSphere is a distributed operating system managing cloud native applications with Kubernetes as its kernel, and provides plug-and-play architecture for the seamless integration of third-party applications to boost its ecosystem.

Prerequisites#

Install APISIX and apisix-ingress-controller#

As the data plane of apisix-ingress-controller, Apache APISIX can be deployed at the same time using Helm chart.

helm repo add apisix https://charts.apiseven.com
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update
kubectl create ns ingress-apisix
helm install apisix apisix/apisix \
  --set gateway.type=NodePort \
  --set ingress-controller.enabled=true \
  --namespace ingress-apisix \
  --set ingress-controller.config.apisix.serviceNamespace=ingress-apisix
kubectl get service --namespace ingress-apisix

Five Service resources were created.

  • apisix-gateway, which processes the real traffic;
  • apisix-admin, which acts as the control plane to process all the configuration changes.
  • apisix-ingress-controller, which exposes apisix-ingress-controller's metrics.
  • apisix-etcd and apisix-etcd-headless for etcd service and internal communication.

The gateway service type is set to NodePort, so that clients can access Apache APISIX through the Node IPs and the assigned port. If you want to expose a LoadBalancer service, try to use Porter.

Now try to create some resources to verify the running status. As a minimalist example, see proxy-the-httpbin-service to learn how to apply resources to drive the apisix-ingress-controller.

Specify The Ingress Version#

apisix-ingress-controller will watch apiVersion of networking.k8s.io/v1 by default. If the target kubernetes version is under v1.19, add --set ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1 or --set ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1 if your kubernetes cluster is under v1.16

Enable SSL#

The ssl config is disabled by default, add --set gateway.tls.enabled=true to enable tls support.

Change default apikey#

It's Recommended to change the default key by add --set ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF, --set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF, --set admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF, notice that ingress-controller.config.apisix.adminKey and admin.credentials.admin must be the same, and should better not same as admin.credentials.viewer.