apisix.apache.org Open in urlscan Pro
2a04:4e42::644  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Skip to main content
🤔 Have queries regarding API Gateway? Join Slack channel to discuss join
#apisix channel! ⭐️
Apache APISIX®
Apache APISIX® Ingress Controller
 * Apache APISIX®️
 * Apache APISIX®️ Dashboard
 * Apache APISIX®️ Ingress Controller
 * Apache APISIX®️ Helm Charts
 * Apache APISIX®️ Docker
 * Apache APISIX®️ Java Plugin Runner
 * Apache APISIX®️ Go Plugin Runner
 * Apache APISIX®️ Python Plugin Runner
 * General

BlogCase StudiesDownloadsHelpTeam
Resources
 * Showcase
 * Code Samples
 * PluginHub
 * Community
 * Events
 * Roadmap

English
 * English
 * 简体中文

🌜
🌞

SearchK

Apache APISIX®
Version:
1.8.0
 * Next
 * 1.8.0
   Latest
 * 1.7.0
 * 1.6.1
 * 1.6.0
 * 1.5.0
 * 1.4.0
 * 1.3.0
 * 1.2.0
 * 1.1.0
 * 1.0.0
 * 0.6.0
 * 0.5.0
 * 0.4.0

 * Getting started
 * Installation
   * minikube
   * kind
   * EKS (Amazon)
   * ACK (Alibaba Cloud)
   * GKE (Google)
   * AKS (Azure)
   * TKE (Tencent)
   * KubeSphere
   * K3s and RKE (Rancher)
   * OpenShift
 * Tutorials
 * References
 * Concepts
 * Ingress Controller
 * Composite Architecture
 * Development
 * FAQ
 * Monitoring APISIX with Helm Chart
 * Upgrade Guide
 * CHANGELOG

Version: 1.8.0
On this page


KUBESPHERE

This guide explains how you can install APISIX ingress on KubeSphere distributed
operating system.


PREREQUISITES#

Setting up APISIX ingress on KubeSphere requires the following:

 * Install KubeSphere on Linux or minimally on Kubernetes.
 * Install Helm.


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 \
  --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


Copy

NOTE

By default, APISIX ingress controller will watch the apiVersion of
networking.k8s.io/v1.

If the target Kubernetes version is under v1.19, add the flag --set
ingress-controller.config.kubernetes.ingressVersion=networking/v1beta1.

Else, if your Kubernetes cluster version is under v1.16, set the flag --set
ingress-controller.config.kubernetes.ingressVersion=extensions/v1beta1.

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


Copy

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.

The gateway service type is set to NodePort. Clients can access APISIX through
the Node IPs and the assigned port. To use a service of type LoadBalancer with
KubeSphere use a bare-metal load balancer implementation like openelb.

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


NEXT STEPS#


ENABLE SSL#

SSL is disabled by default. You can enable it by adding the flag --set
apisix.ssl.enabled=true.


CHANGE DEFAULT KEYS#

It is recommended to change the default keys for security:

--set ingress-controller.config.apisix.adminKey=ADMIN_KEY_GENERATED_BY_YOURSELF


Copy

--set admin.credentials.admin=ADMIN_KEY_GENERATED_BY_YOURSELF


Copy

--set admin.credentials.viewer=VIEWER_KEY_GENERATED_BY_YOURSELF


Copy

NOTE

The ingress-controller.config.apisix.adminKey and admin.credentials.admin must
be the same. It is better if these are not same as admin.credentials.viewer.

Edit this page

Previous
« TKE (Tencent)
Next
K3s and RKE (Rancher) »
 * Prerequisites
 * Install APISIX and ingress controller
 * Next steps
   * Enable SSL
   * Change default keys

ASF
 * Foundation
 * License
 * Events
 * Security
 * Sponsorship
 * Thanks

Community
 * GitHub
 * Slack
 * Twitter
 * YouTube

More
 * Blog
 * Showcase
 * Plugin Hub
 * Roadmap

Copyright © 2019-2024 The Apache Software Foundation. Apache APISIX, APISIX®,
Apache, the Apache feather logo, and the Apache APISIX project logo are either
registered trademarks or trademarks of the Apache Software Foundation.
Ask AI