mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-16 01:41:17 +08:00
ebd158a858
Signed-off-by: spacewander <spacewanderlzx@gmail.com>
5.1 KiB
5.1 KiB
构建 Apache APISIX
1. 安装依赖
Apache APISIX 的运行环境需要 Nginx 和 etcd,
所以在安装前,请根据不同的操作系统来安装依赖。
2. 安装 Apache APISIX
你可以通过源码包、Docker、Luarocks 等多种方式来安装 Apache APISIX。
通过源码包安装
你需要先下载 Apache Release 源码包:
$ mkdir apisix-2.2
$ wget https://downloads.apache.org/apisix/2.2/apache-apisix-2.2-src.tgz
$ tar zxvf apache-apisix-2.2-src.tgz -C apisix-2.2
安装运行时依赖的 Lua 库:
cd apache-apisix-2.2
make deps
通过 RPM 包安装(CentOS 7)
sudo yum install -y https://github.com/apache/apisix/releases/download/2.2/apisix-2.2-0.el7.noarch.rpm
通过 Luarocks 安装 (不支持 macOS)
在终端中执行下面命令完成 APISIX 的安装(只推荐开发者使用):
通过脚本安装 master 分支的代码
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/apache/apisix/master/utils/install-apisix.sh)"
通过 Luarocks 安装指定的版本:
# 安装 apisix 的 2.2 版本
sudo luarocks install --lua-dir=/path/openresty/luajit apisix 2.2
# 老版本 luarocks 可能不支持 `lua-dir` 参数,可以删除该选项
sudo luarocks install apisix 2.2
3. 管理(启动、关闭等)APISIX 服务
我们可以在 apisix 的目录下用 make run
命令来启动服务,或者用 make stop
方式关闭服务。
# init nginx config file and etcd
$ make init
# start APISIX server
$ make run
# stop APISIX server
$ make stop
# more actions find by `help`
$ make help
Makefile rules:
help: Show Makefile rules
deps: Installation dependencies
utils: Installation tools
lint: Lint Lua source code
init: Initialize the runtime environment
run: Start the apisix server
stop: Stop the apisix server
verify: Verify the configuration of apisix server
clean: Remove generated files
reload: Reload the apisix server
install: Install the apisix (only for luarocks)
test: Run the test case
license-check: Check Lua source code for Apache License
4. 运行测试案例
- 先安装 perl 的包管理器 cpanminus
- 然后通过 cpanm 来安装 test-nginx 的依赖:
sudo cpanm --notest Test::Nginx IPC::Run > build.log 2>&1 || (cat build.log && exit 1)
- 然后 clone 最新的源码:
git clone https://github.com/iresty/test-nginx.git
。注意使用我们 fork 出来的版本。 - 通过 perl 的
prove
命令来加载 test-nginx 的库,并运行/t
目录下的测试案例集:- 追加当前目录到perl模块目录:
export PERL5LIB=.:$PERL5LIB
- 直接运行:
make test
- 指定 nginx 二进制路径:
TEST_NGINX_BINARY=/usr/local/bin/openresty prove -Itest-nginx/lib -r t
- 追加当前目录到perl模块目录:
疑难排解测试
配置 Nginx 路径
如果遇到问题 Error unknown directive "lua_package_path" in /API_ASPIX/apisix/t/servroot/conf/nginx.conf
确保将openresty设置为默认的nginx并按如下所示导出路径。
- export PATH=/usr/local/openresty/nginx/sbin:$PATH
- Linux 默认安装路径:
- export PATH=/usr/local/openresty/nginx/sbin:$PATH
- OSx 通过homebrew默认安装路径:
- export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH
- Linux 默认安装路径:
运行单个测试用例
- 使用以下命令运行指定的测试用例:
- prove -Itest-nginx/lib -r t/plugin/openid-connect.t
5. 更新 Admin API 的 token ,保护 Apache APISIX
修改 conf/config.yaml
中的 apisix.admin_key
并重启服务。例如下面例子:
apisix:
# ... ...
admin_key
-
name: "admin"
key: abcdefghabcdefgh
role: admin
当我们需要访问 Admin API 时,就可以使用上面记录的 key 作为 token 了。
$ curl http://127.0.0.1:9080/apisix/admin/routes?api_key=abcdefghabcdefgh -i
HTTP/1.1 200 OK
Date: Fri, 28 Feb 2020 07:48:04 GMT
Content-Type: text/plain
... ...
{"node":{...},"action":"get"}
$ curl http://127.0.0.1:9080/apisix/admin/routes?api_key=abcdefghabcdefgh-invalid -i
HTTP/1.1 401 Unauthorized
Date: Fri, 28 Feb 2020 08:17:58 GMT
Content-Type: text/html
... ...
{"node":{...},"action":"get"}