Get APISIX

Apache APISIX is a dynamic, real-time, and high-performance API Gateway. It is a top-level project of the Apache Software Foundation.

You can use APISIX API Gateway as a traffic entrance to process all business data. It offers features including dynamic routing, dynamic upstream, dynamic certificates, A/B testing, canary release, blue-green deployment, limit rate, defense against malicious attacks, metrics, monitoring alarms, service observability, service governance, and more.

In addition, the project also offers APISIX Ingress Controller, an open-source ingress controller that allows you to manage external client traffic to services running in a Kubernetes cluster. The APISIX Ingress Controller routes incoming traffic to specific services based on the requested URL path or hostname.

This tutorial covers two installation methods for you to quickly get started with APISIX:

• Start APISIX in Docker with a quickstart script.
• Start APISIX Ingress Controller on a kind Kubernetes cluster.

Prerequisite(s)

Docker

• Install Docker to be used in the quickstart script to create containerized etcd and APISIX.
• Install cURL to be used in the quickstart script and to send requests to APISIX for verification.

Kubernetes

• Install Docker as a dependency of kind.
• Install kind to start local Kubernetes clusters.
• Install Helm to install Helm charts.
• Install kubectl to run commands against Kubernetes clusters.

Get APISIX

Docker

caution

To provide a better experience in this tutorial, the requirement of Admin API key is switched off by default. Please turn on the API key requirement of Admin API in the production environment.

Start APISIX in Docker with the quickstart script:

curl -sL "https://run.api7.ai/apisix/quickstart" | sh

The script starts two Docker containers, apisix-quickstart and etcd-quickstart in the apisix-quickstart-net Docker network, where etcd is used to store APISIX configurations.

You should see the following message once APISIX is ready:

✔ APISIX is ready!

Kubernetes

In this section, you will be creating a kind cluster and starting APISIX Ingress Controller on the cluster.

Start a Kind Cluster

Ensure you have Docker running and start a kind cluster:

kind create cluster

You should see the following response:

Creating cluster "kind" ...
 ✓ Ensuring node image (kindest/node:v1.30.0) 🖼 
 ✓ Preparing nodes 📦  
 ✓ Writing configuration 📜 
 ✓ Starting control-plane 🕹️ 
 ✓ Installing CNI 🔌 
 ✓ Installing StorageClass 💾 
Set kubectl context to "kind-kind"

You can now use your cluster with:
kubectl cluster-info --context kind-kind

Create Namespace

Create a new namespace ingress-apisix:

kubectl create namespace ingress-apisix

You should see a response:

namespace/ingress-apisix created

Set Preferred Namespace

Set the namespace to ingress-apisix so that subsequent commands do not need to explicitly specify the namespace every time:

kubectl config set-context --current --namespace=ingress-apisix

To verify if the default namespace is modified:

kubectl config view --minify | grep namespace:

You should see the namespace has been set:

namespace: ingress-apisix

Install APISIX Ingress Controller

Add the APISIX and Bitnami chart repositories and update:

helm repo add apisix https://charts.apiseven.com \
  && helm repo add bitnami https://charts.bitnami.com/bitnami \
  && helm repo update 

Install APISIX Ingress controller:

helm install apisix apisix/apisix \
  --set service.type=NodePort \
  --set ingress-controller.enabled=true \
  --set ingress-controller.config.kubernetes.enableGatewayAPI=true \
  --set ingress-controller.config.apisix.adminAPIVersion=v3

❶ Configure the service type as NodePort, which can be changed to LoadBalancer type if you would like to use a load balancer to expose the service.

❷ Install APISIX Ingress Controller along with the APISIX chart.

❸ Enable the Gateway API.

❹ Use the v3 Admin API.

You should see a response showing APISIX Ingress Controller is deployed:

NAME: apisix
LAST DEPLOYED: Thu May 30 14:19:38 2024
NAMESPACE: ingress-apisix
STATUS: deployed
REVISION: 1
TEST SUITE: None

Verify Installation

Docker

Send a request to see if APISIX is running:

curl -sI "http://127.0.0.1:9080" | grep Server

If everything is ok, you should see the APISIX version:

Server: APISIX/3.12.0

APISIX is now installed and running.

Kubernetes

Check Pod Statuses

To verify that APISIX Ingress Controller is installed and running, check the status of the pods:

kubectl get pods

If everything is ok, you should see that all pods in the Running status:

NAME                                         READY   STATUS    RESTARTS   AGE
apisix-897965b56-47nrq                       1/1     Running   0          8m
apisix-etcd-1                                1/1     Running   0          8m
apisix-etcd-2                                1/1     Running   0          8m
apisix-etcd-0                                1/1     Running   0          8m
apisix-ingress-controller-77bbf59f54-7gcwb   1/1     Running   0          8m

Check Service Statuses

You can also check the status of the services:

kubectl get services

If everything is ok, you should see a response similar to the following:

NAME                                       TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)                      AGE
apisix-admin                               ClusterIP   10.96.155.100   <none>        9180/TCP                     8m
apisix-etcd                                ClusterIP   10.96.117.186   <none>        2379/TCP,2380/TCP            8m
apisix-etcd-headless                       ClusterIP   None            <none>        2379/TCP,2380/TCP            8m
apisix-gateway                             NodePort    10.96.9.154     <none>        80:30883/TCP                 8m
apisix-ingress-controller                  ClusterIP   10.96.109.21    <none>        80/TCP                       8m
apisix-ingress-controller-apisix-gateway   NodePort    10.96.212.53    <none>        80:30310/TCP,443:31174/TCP   8m

Verify Installed APISIX Version

To verify the installed APISIX version, first map port 80 of the apisix-gateway service to port 8080 on the local machine:

kubectl port-forward svc/apisix-gateway 9080:80 &

Then send a request to the gateway:

curl -sI "http://127.0.0.1:9080" | grep Server 

If everything is ok, you should see the APISIX version:

Server: APISIX/3.12.0

info

If you would like to use a load balancer to expose the service on the kind cluster as an alternative to port forwarding, see load balancer kind documentation.

APISIX Ingress Controller is now installed and running.

Next Steps

Follow the rest of the getting started tutorials to learn and compare different ways of configuring APISIX, including using:

• Admin API
• Kubernetes Manifest Files
• API Declarative CLI (ADC)
• APISIX Model Context Protocol (APISIX-MCP)

If you would like to declaratively configure APISIX with ADC, or use natural language through LLM models to configure APISIX with APISIX-MCP, please visit their docs for installation and setups before visiting the other tutorials.

Note that the APISIX instance started with the quickstart script and the APISIX Ingress Controller instance started with kind are not optimized for production. For production installation, please see the production installation options for more information.