commit | f2c021739b7f0c016dc98343fd0b6982981452ca | [log] [tgz] |
---|---|---|
author | YuanSheng Wang <membphis@gmail.com> | Fri Sep 06 15:20:26 2019 +0800 |
committer | GitHub <noreply@github.com> | Fri Sep 06 15:20:26 2019 +0800 |
tree | 2c60bcdbf707cc87e0a43003a2b12f83816987fd | |
parent | ccc768a7c75f3c468cf464c69fdb42b5f407ff43 [diff] |
travis: failed to run test case on osx now. (#474) * travis: enabled v2 protocal for etcd under osx.
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 OpenResty 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.
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.
APISIX provides dynamic load balancing, authentication, rate limiting, and other plugins through plugin mechanisms, and supports plugins you develop yourself.
For more detailed information, see the White Paper.
rewrite
, access
, header filer
, body filter
and log
, also allows to hook the balancer
stage.We provide an online dashboard demo version, make it easier for you to understand APISIX.
APISIX Installed and tested in the following systems:
OS | OpenResty | Status |
---|---|---|
CentOS 7 | 1.15.8.1 | √ |
Ubuntu 16.04 | 1.15.8.1 | √ |
Ubuntu 18.04 | 1.15.8.1 | √ |
Debian 9 | 1.15.8.1 | √ |
Mac OSX | 1.15.8.1 | √ |
You now have two ways to install APISIX: if you are using CentOS 7, it is recommended to use RPM, other systems please use Luarocks.
We will add support for Docker and more OS shortly.
NOTE: APISIX currently only supports the v2 protocol storage to etcd, but the latest version of etcd (starting with 3.4) has turned off the v2 protocol by default. You need to add --enable-v2=true
to the startup parameter to enable the v2 protocol. The development of the v3 protocol supporting etcd has begun and will soon be available.
sudo yum install yum-utils sudo yum-config-manager --add-repo https://openresty.org/package/centos/openresty.repo sudo yum install -y openresty etcd sudo service etcd start sudo yum install -y https://github.com/iresty/apisix/releases/download/v0.6/apisix-0.6-0.el7.noarch.rpm
You can try APISIX with the Quickstart now.
APISIX is based on OpenResty, the configures data storage and distribution via etcd.
We recommend that you use luarocks to install APISIX, and for different operating systems have different dependencies, see more: Install Dependencies
luarocks install --lua-dir=/usr/local/openresty/luajit apisix
If you got some error like unknow flag --lua-dir
, this is because luarocks
version is too low. We need to remove option lua-dir
and run again: luarocks install apisix
.
If all goes well, you will see the message like this:
apisix is now built and installed in /usr (license: Apache License 2.0)
Congratulations, you have already installed APISIX successfully.
If you are a developer, you can view the dev manual for more detailed information.
sudo apisix start
Limit count plugin is a good start to try APISIX, you can follow the documentation of limit count.
Then you can try more plugins.
APISIX has the built-in dashboard,open http://127.0.0.1:9080/apisix/dashboard
with a browser and try it.
Do not need to fill the user name and password, log in directly.
dashboard only allow 127.0.0.0/24
by default, and you can modify allow_admin
in conf/config.yaml
by yourself, to add more IPs.
Using Google Cloud‘s 4 core server, APISIX’s QPS reach to 60,000 with a latency of only 500 microseconds.
You can view the benchmark documentation for more detailed information.
English Development Documentation: TODO
APISIX enriches the CNCF API Gateway Landscape:
There are often some questions asked by developers in the community. We have arranged them in the FAQ.
If your concerns are not among them, please submit issue to communicate with us.
Contributions are welcomed and greatly appreciated.
inspired by Kong and Orange.