docs: modify the format of (#605)

1 file changed
tree: 093d1edb04402b6386cb59d6ce770dd8640c7b71
  1. .asf.yaml
  2. .dockerignore
  3. .github/
  4. .gitignore
  5. .gitmodules
  6. .golangci.yml
  7. .licenserc.yaml
  8. .markdownlint.yml
  10. Dockerfile
  12. Makefile
  13. NOTICE
  15. cmd/
  16. conf/
  17. docs/
  18. go.mod
  19. go.sum
  21. main.go
  22. pkg/
  23. releases/
  24. samples/
  25. test/
  26. tools.go
  27. utils/

Apache APISIX for Kubernetes

Go Report Card

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:


This project is currently general availability.


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

More about comparison among multiple Ingress Controllers.

Internal Architecture


Apisix ingress controller requires Kubernetes version 1.15+.

Apache APISIX Ingress vs. Kubernetes Ingress Nginx

Contributor over time

Contributor over time

Get started


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



User stories


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




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


Apache License 2.0