apisix高性能网关-中文开发文档

2020年6月12日13:48:33

github：https://github.com/apache/incubator-apisix

目前此项目已有成为apache孵化项目

官方中文文档 ：https://github.com/apache/incubator-apisix/blob/master/README_CN.md

支持的功能很多，我个人比较推荐服务发现，这个很省资源，不然得吧java的一套全部上上去，这样其他语言的也可以轻松做微服务了

APISIX

• QQ 交流群: 552030619
• 邮件列表: 发邮件到 dev-subscribe@apisix.apache.org, 然后跟着回复邮件操作即可。
• 

APISIX 是一个云原生、高性能、可扩展的微服务 API 网关。

它是基于 Nginx 和 etcd 来实现，和传统 API 网关相比，APISIX 具备动态路由和插件热加载，特别适合微服务体系下的 API 管理。

为什么选择 APISIX？

如果你正在构建网站、移动设备或 IoT（物联网）的应用，那么你可能需要使用 API 网关来处理接口流量。

APISIX 是基于云原生的微服务 API 网关，它是所有业务流量的入口，可以处理传统的南北向流量，也可以处理服务间的东西向流量，也可以当做 k8s ingress controller 来使用。

APISIX 通过插件机制，提供动态负载平衡、身份验证、限流限速等功能，并且支持你自己开发的插件。

功能

你可以把 Apache APISIX 当做流量入口，来处理所有的业务数据，包括动态路由、动态上游、动态证书、
A/B 测试、金丝雀发布(灰度发布)、蓝绿部署、限流限速、抵御恶意攻击、监控报警、服务可观测性、服务治理等。

• 全平台

  • 云原生: 平台无关，没有供应商锁定，无论裸机还是 Kubernetes，APISIX 都可以运行。
  • 运行环境: OpenResty 和 Tengine 都支持。
  • 支持 ARM64: 不用担心底层技术的锁定。

• 多协议

  • TCP/UDP 代理: 动态 TCP/UDP 代理。
  • 动态 MQTT 代理: 支持用 client_id 对 MQTT 进行负载均衡，同时支持 MQTT 3.1.* 和 5.0 两个协议标准。
  • gRPC 代理：通过 APISIX 代理 gRPC 连接，并使用 APISIX 的大部分特性管理你的 gRPC 服务。
  • gRPC 协议转换：支持协议的转换，这样客户端可以通过 HTTP/JSON 来访问你的 gRPC API。
  • Websocket 代理
  • Proxy Protocol
  • Dubbo 代理：基于 Tengine，可以实现 Dubbo 请求的代理。
  • HTTP(S) 反向代理
  • SSL：动态加载 SSL 证书。

• 全动态能力

  • 热更新和热插件: 无需重启服务，就可以持续更新配置和插件。
  • 代理请求重写: 支持重写请求上游的host、uri、schema、enable_websocket、headers信息。
  • 输出内容重写: 支持自定义修改返回内容的 status code、body、headers。
  • Serverless: 在 APISIX 的每一个阶段，你都可以添加并调用自己编写的函数。
  • 动态负载均衡：动态支持有权重的 round-robin 负载平衡。
  • 支持一致性 hash 的负载均衡：动态支持一致性 hash 的负载均衡。
  • 健康检查：启用上游节点的健康检查，将在负载均衡期间自动过滤不健康的节点，以确保系统稳定性。
  • 熔断器: 智能跟踪不健康上游服务。
  • 动态服务发现：支持基于注册中心的服务发现功能，降低反向代理维护成本。

• 精细化路由

  • 支持全路径匹配和前缀匹配
  • 支持使用 Nginx 所有内置变量做为路由的条件，所以你可以使用 cookie, args 等做为路由的条件，来实现灰度发布、A/B 测试等功能
  • 支持各类操作符做为路由的判断条件，比如 {"arg_age", ">", 24}
  • 支持自定义路由匹配函数
  • IPv6：支持使用 IPv6 格式匹配路由
  • 支持路由的自动过期(TTL)
  • 支持路由的优先级
  • 支持批量 Http 请求

• 安全防护

  • 多种身份认证方式: key-auth, JWT, basic-auth, wolf-rbac。
  • IP 黑白名单
  • IdP 支持: 支持外部的身份认证服务，比如 Auth0，Okta，Authing 等，用户可以借此来对接 Oauth2.0 等认证方式。
  • 限制速率
  • 限制请求数
  • 限制并发
  • 防御 ReDoS(正则表达式拒绝服务)：内置策略，无需配置即可抵御 ReDoS。
  • CORS

• 运维友好

  • OpenTracing 可观测性: 支持 Apache Skywalking 和 Zipkin。
  • 监控和指标: Prometheus
  • 集群：APISIX 节点是无状态的，创建配置中心集群请参考 etcd Clustering Guide。
  • 高可用：支持配置同一个集群内的多个 etcd 地址。
  • 控制台: 内置控制台来操作 APISIX 集群。
  • 版本控制：支持操作的多次回滚。
  • CLI: 使用命令行来启动、关闭和重启 APISIX。
  • 单机模式: 支持从本地配置文件中加载路由规则，在 kubernetes(k8s) 等环境下更友好。
  • 全局规则：允许对所有请求执行插件，比如黑白名单、限流限速等。
  • 高性能：在单核上 QPS 可以达到 18k，同时延迟只有 0.2 毫秒。
  • 故障注入
  • REST Admin API: 使用 REST Admin API 来控制 Apache APISIX，默认只允许 127.0.0.1 访问，你可以修改 conf/config.yaml 中的 allow_admin 字段，指定允许调用 Admin API 的 IP 列表。同时需要注意的是，Admin API 使用 key auth 来校验调用者身份，在部署前需要修改 conf/config.yaml 中的 admin_key 字段，来保证安全。
  • 外部日志记录器：将访问日志导出到外部日志管理工具。(HTTP Logger, TCP Logger, Kafka Logger, UDP Logger)

• 高度可扩展

  • 自定义插件: 允许挂载常见阶段，例如init, rewrite，access，balancer,header filer，body filter 和 log 阶段。
  • 自定义负载均衡算法：可以在 balancer 阶段使用自定义负载均衡算法。
  • 自定义路由: 支持用户自己实现路由算法。

安装

APISIX 在以下操作系统中可顺利安装并做过运行测试，需要注意的是：OpenResty 的版本必须 >= 1.15.8.1：

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

安装 APISIX 的步骤：

1. 安装运行时依赖：OpenResty 和 etcd，参考依赖安装文档
2. 有以下几种方式来安装 Apache APISIX:
   • 通过源码包安装;
   • 如果你在使用 CentOS 7，可以使用 RPM 包安装；
   • 其它 Linux 操作系统，可以使用 Luarocks 安装方式；
   • 你也可以使用 Docker 镜像 来安装。

快速上手

1. 启动 APISIX

sudo apisix start

2. 入门指南

入门指南是学习 APISIX 基础知识的好方法。按照 入门指南的步骤即可。

更进一步，你可以跟着文档来尝试更多的插件。

控制台

APISIX 内置了对 Dashboard 的支持，使用步骤如下：

1. 确保你的运行环境中使用了最新的 Node.js 版本（>= 10）。

2. 下载 dashboard 子模块的源码：

git submodule update --init --recursive

3. 安装 yarn

4. 安装依赖并构建

cd dashboard
yarn && yarn build:prod

5. 与 APISIX 集成
   把编译后的在 /dist 目录下的所有文件，拷贝到 apisix/dashboard 目录下。

cp -r dist/* .

使用浏览器打开 http://127.0.0.1:9080/apisix/dashboard/ 即可使用，
不用填写用户名和密码，直接登录。

Dashboard 默认只允许 127.0.0.1 访问。你可以自行修改 conf/config.yaml 中的 allow_admin 字段，指定允许访问 dashboard 的 IP 列表。

性能测试

使用 AWS 的 8 核心服务器来压测 APISIX，QPS 可以达到 140000，同时延时只有 0.2 毫秒。

文档

Apache APISIX 文档索引

Apache APISIX 和 Kong 的比较

API 网关核心功能点，两者均已覆盖

Apache APISIX 的优势

视频和文章

• 2020.1.17 API 网关 Apache APISIX 和 Kong 的选型对比
• 2019.12.14 从 0 到 1：Apache APISIX 的 Apache 之路
• 2019.12.14 基于 Apache APISIX 的下一代微服务架构
• 2019.10.30 Apache APISIX 微服务架构极致性能架构解析
• 2019.9.27 想把 APISIX 运行在 ARM64 平台上？只要三步
• 2019.8.31 APISIX 技术选型、测试和持续集成
• 2019.8.31 APISIX 高性能实战2
• 2019.7.6 APISIX 高性能实战

用户实际使用案例

• 贝壳找房：如何基于 Apache APISIX 搭建网关
• 360：Apache APISIX 在基础运维平台项目中的实践
• HelloTalk：基于 OpenResty 和 Apache APISIX 的全球化探索之路
• 腾讯云：为什么选择 Apache APISIX 来实现 k8s ingress controller?
• 思必驰：为什么我们重新写了一个 k8s ingress controller?

APISIX 的用户有哪些？

有很多公司和组织把 APISIX 用户学习、研究、生产环境和商业产品中，包括：

欢迎用户把自己加入到 Powered By 页面。

全景图

  

APISIX 被纳入 云原生软件基金会 API 网关全景图

参与社区

如果你对 APISIX 的开发和使用感兴趣，欢迎加入我们的 QQ 群来交流:

致谢

灵感来自 Kong 和 Orange。