Skip to main content

Getting Started

What is apisix-ingress-controller#

apisix-ingress-controller is yet another Ingress controller for Kubernetes using Apache APISIX as the high performance reverse proxy.

It's configured by using the declarative configurations like ApisixRoute, ApisixUpstream, Ingress. All these resources are watched and converted to corresponding resources in Apache APISIX.

Service Discovery are also supported through Kubernetes Service, and will be reflected to nodes in APISIX Upstream.

scene

Features#

  • Declarative configuration
  • Full dynamic capabilities to delivery configurations.
  • Native Kubernetes Ingress (both v1 and v1beta1) support.
  • Service Discovery based on Kubernetes Service.
  • Out of box support for node health check.
  • Support load balancing based on Pod (upstream nodes).
  • Rich plugins support.
  • Easy to deploy and use.

How It Works#

See Design for more details.

Installation on Cloud#

apisix-ingress-controller supports to be installed on some clouds such as AWS, GCP.

Installation on Prem#

If you want to deploy apisix-ingress-controller on Prem, we recommend you to use Helm. Just a few steps

Get Involved to Contribute#

First, your supports and cooperations to make this project better are appreciated. But before you start, please read How to Contribute and How to Develop.

Compatibility with Apache APISIX#

The following table describes the compatibility between apisix-ingress-controller and Apache APISIX.

apisix-ingress-controllerApache APISIX
master>= 2.7, 2.10 is recommended.
1.3.0>= 2.7, 2.10 is recommended.
1.2.0>= 2.7, 2.8 is recommended.
1.1.0>= 2.7, 2.7 is recommended.
1.1.0>= 2.7, 2.7 is recommended.
1.0.0>= 2.7, 2.7 is recommended.
0.6>= 2.6, 2.6 is recommended.
0.5>= 2.4, 2.5 is recommended.
0.4>= 2.4