apisix-ingress-controller

Apache APISIX for Kubernetes

Use Apache APISIX for Kubernetes Ingress.

All configurations in apisix-ingress-controller are defined with Kubernetes CRDs (Custom Resource Definitions). Such as configure plugins, Support service registration discovery mechanism for upstreams, load balancing and more in Apache APISIX.

apisix-ingress-controller is an Apache APISIX control plane component. Currently it serves for Kubernetes clusters. In the future, we plan to separate the submodule to adapt to more deployment modes, such as virtual machine clusters.

The technical architecture of apisix-ingress-controller:

Status

This project is currently considered experimental.

Features

• Declarative configuration for Apache APISIX with Custom Resource Definitions(CRDs), using k8s yaml struct with minimum learning curve.
• Hot-reload during yaml apply.
• Auto register k8s endpoint to upstream(Apache APISIX) node.
• Out of box support for node health check.
• Support load balancing based on pod (upstream nodes).
• Plug-in extension supports hot configuration and immediate effect.
• Ingress controller itself as a pluggable hot-reload component.
• Multi-cluster configuration distribution.

Modules

1. Ingress types Submodule

• Define the CRD(CustomResourceDefinition) needed by Apache APISIX

• Currently supports ApisixRoute/ApisixService/ApisixUpstream，and other service and route level plugins.

• Can be packaged as a stand-alone binary, keep in sync with the ingress definition.

• CRD design

2. APISIX types Submodule

• Define interface objects to match concepts from Apache APISIX like route, service, upstream, and plugin.

• Can be a packaged as a stand-alone binary, need to match with compatible Apache APISIX version.

• Add new types to this module to support new features.

3. Seven submodule

• Contain main application logic.

• Sync the k8s cluster states to Apache APISIX, based on Apisix-types object.

4.Ingress-controller Submodule

• Driver process for ingress controller, watches k8s apiserver.

• Match and covert Apisix-ingress-types to Apisix-types before handing the control over to the above module seven.

Get more implementation details.

Get started

• How to install

Todos

• Support UDP definition. #116
• Support TCP definition. #115
• Support GRPC definition. #114
• Add a complete demo. #9
• More todos will display in issues

Documents

• Usage
• SDK doc
• Design introduction

FAQ

• FAQ

User stories

• aispeech: Why we create a new k8s ingress controller?(Chinese)
• Tencent Cloud: Why choose Apache APISIX to implement the k8s ingress controller?(Chinese)

Contributing

We welcome all kinds of contributions from the open-source community, individuals and partners.

• Contributing Guide

Community

• Mailing List: Mail to dev-subscribe@apisix.apache.org, follow the reply to subscribe the mailing list.
• QQ Group - 578997126
• - follow and interact with us using hashtag #ApacheAPISIX
• Bilibili video

Milestone

• Milestone

Terminology

• Ingress APISIX: the whole service that contains the proxy (Apache APISIX) and ingress controller (apisix ingress controller).
• apisix-ingress-controller: the ingress controller component.

License

Apache License 2.0