Google Git
Sign in
apache / apisix / refs/tags/1.2
commit3465713d3cd58b600f975d52013f347ea4e6ca4a[log] [tgz]
authoragile6v <agile6v@agile6v.com>Sun Apr 12 09:15:57 2020 +0800
committeragile6v <agile6v@agile6v.com>Sun Apr 12 09:15:57 2020 +0800
tree7ba1bb86ef7cb0ae0d66b0fed03fa47fc56ce88f
parent31e97b502ac1e3de2d0edc762b5bc66010fc1857 [diff]
chore: change directory lua to apisix.
1 file changed
tree: 7ba1bb86ef7cb0ae0d66b0fed03fa47fc56ce88f
  1. .github/
  2. .travis/
  3. apisix/
  4. benchmark/
  5. bin/
  6. conf/
  7. doc/
  8. kubernetes/
  9. logs/
  10. rockspec/
  11. t/
  12. utils/
  13. dashboard
  14. .gitattributes
  15. .gitignore
  16. .gitmodules
  17. .luacheckrc
  18. .travis.yml
  19. CHANGELOG.md
  20. CHANGELOG_CN.md
  21. CODE_STYLE.md
  22. Contributing.md
  23. DISCLAIMER
  24. FAQ.md
  25. FAQ_CN.md
  26. LICENSE
  27. Makefile
  28. NOTICE
  29. README.md
  30. README_CN.md
README.md

Chinese

APISIX

Build Status License

APISIX is a cloud-native microservices API gateway, delivering the ultimate performance, security, open source and scalable platform for all your APIs and microservices.

APISIX is based on Nginx and etcd. Compared with traditional API gateways, APISIX has dynamic routing and plug-in hot loading, which is especially suitable for API management under micro-service system.

Why APISIX?

If you are building a website, mobile device or IoT (Internet of Things) application, you may need to use an API gateway to handle interface traffic.

APISIX is a cloud-based microservices API gateway that handles traditional north-south traffic and handles east-west traffic between services, and can also be used as a k8s ingress controller.

APISIX provides dynamic load balancing, authentication, rate limiting, other plugins through plugin mechanisms, and supports plugins you develop yourself.

For more detailed information, see the White Paper.

Features

You can use Apache APISIX as a traffic entrance to process all business data, 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, etc.

  • All platforms

    • Cloud-Native: Platform agnostic, No vendor lock-in, APISIX can run from bare-metal to Kubernetes.
    • Run Environment: Both OpenResty and Tengine are supported.
    • Supports ARM64: Don't worry about the lock-in of the infra technology.

  • Multi protocols

    • TCP/UDP Proxy: Dynamic TCP/UDP proxy.
    • Dynamic MQTT Proxy: Supports to load balance MQTT by client_id, both support MQTT 3.1.*, 5.0.
    • gRPC proxy: Proxying gRPC traffic.
    • gRPC transcoding: Supports protocol transcoding so that clients can access your gRPC API by using HTTP/JSON.
    • Proxy Websocket
    • Proxy Protocol
    • Proxy Dubbo: Dubbo Proxy based on Tengine.
    • HTTP(S) Forward Proxy
    • SSL: Dynamically load an SSL certificate.

  • Full dynamic

    • Hot Updates And Hot Plugins: Continuously updates its configurations and plugins without restarts!
    • Proxy Rewrite: Support rewrite the host, uri, schema, enable_websocket, headers of the request before send to upstream.
    • Response Rewrite: Set customized response status code, body and header to the client.
    • Serverless: Invoke functions in each phase in APISIX.
    • Dynamic Load Balancing: Round-robin load balancing with weight.
    • Hash-based Load Balancing: Load balance with consistent hashing sessions.
    • Health Checks: Enable health check on the upstream node, and will automatically filter unhealthy nodes during load balancing to ensure system stability.
    • Circuit-Breaker: Intelligent tracking of unhealthy upstream services.

  • Fine-grained routing

  • Security

  • OPS friendly

    • OpenTracing: support Apache Skywalking and Zipkin
    • Monitoring And Metrics: Prometheus
    • Clustering: APISIX nodes are stateless, creates clustering of the configuration center, please refer to etcd Clustering Guide.
    • High availability: support to configure multiple etcd addresses in the same cluster.
    • Dashboard: Built-in dashboard to control APISIX.
    • Version Control: Supports rollbacks of operations.
    • CLI: start\stop\reload APISIX through the command line.
    • Stand-alone mode: Supports to load route rules from local yaml file, it is more friendly such as under the kubernetes(k8s).
    • Global Rule: Allows to run any plugin for all request, eg: limit rate, IP filter etc.
    • High performance: The single-core QPS reaches 18k with an average delay of less than 0.2 milliseconds.
    • Fault Injection
    • REST Admin API
    • Python SDK

  • Highly scalable

    • Custom plugins: Allows hooking of common phases, such as rewrite, access, header filer, body filter and log, also allows to hook the balancer stage.
    • Custom load balancing algorithms: You can use custom load balancing algorithms during the balancer phase.
    • Custom routing: Support users to implement routing algorithms themselves.

Installation

APISIX Installed and tested in the following systems(OpenResty MUST >= 1.15.8.1, or Tengine >= 2.3.2):

CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, ARM64 Ubuntu 18.04

Steps to install APISIX:

  1. Installation runtime dependencies: OpenResty and etcd, refer to documentation
  2. There are several ways to install Apache APISIX:

Quickstart

  1. start server:
sudo apisix start
  1. Try the getting started guide

The getting-started guide is a good way to learn the basics of APISIX. Follow the getting started guide.

Then you can try more plugins.

Dashboard

APISIX has built-in support for Dashboard, as follows:

  1. Please make sure your machine has Node 8.12.0 or higher, or there will occur build issues.

  2. Download the source codes of Dashboard:

git clone https://github.com/apache/incubator-apisix-dashboard.git

  1. Install yarn

  2. Install dependencies then run build command:

git checkout <v1.0> #The tag version same to apisix.
yarn && yarn build:prod
  1. Integration with APISIX Copy the compiled files under /dist directory to the apisix/dashboard directory, open http://127.0.0.1:9080/apisix/dashboard/ in the browser. Do not need to fill the user name and password, log in directly.

The dashboard allows any remote IP by default, and you can modify allow_admin in conf/config.yaml by yourself, to list the list of IPs allowed to access.

We provide an online dashboard demo version, make it easier for you to understand APISIX.

Benchmark

Using AWS‘s 8 core server, APISIX’s QPS reach to 140,000 with a latency of only 0.2 ms.

Document

Document Indexing for Apache APISIX

Apache APISIX vs Kong

Both of them have been covered core features of API gateway

FeaturesApache APISIXKONG
Dynamic upstreamYesYes
Dynamic routerYesYes
Health checkYesYes
Dynamic SSLYesYes
L4 and L7 proxyYesYes
OpentracingYesYes
Custom pluginYesYes
REST APIYesYes
CLIYesYes

The advantages of Apache APISIX

FeaturesApache APISIXKong
Belongs toApache Software FoundationKong Inc.
Tech ArchitectureNginx + etcdNginx + postgres
Communication channelsMail list, Wechat group, QQ group, Github, meetupGithub, freenode, forum
Single-core CPU, QPS(enable limit-count and prometheus plugins)180001700
Latency0.2 ms2 ms
DubboYesNo
Configuration rollbackYesNo
Route with TTLYesNo
Plug-in hot loadingYesNo
Custom LB and routeYesNo
REST API <--> gRPC transcodingYesNo
TengineYesNo
MQTTYesNo
Configuration effective timeEvent driven, < 1mspolling, 5 seconds
DashboardYesNo
IdPYesNo
Configuration Center HAYesNo
Speed limit for a specified time windowYesNo
Support any Nginx variable as routing conditionYesNo

Videos And Articles

User Stories

Who Uses APISIX?

A wide variety of companies and organizations use APISIX for research, production and commercial product, including:

Users are encouraged to add themselves to the Powered By page.

Landscape

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Acknowledgments

Inspired by Kong and Orange.