2019-10-31 09:27:28 +08:00
|
|
|
|
<!--
|
|
|
|
|
#
|
|
|
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
# this work for additional information regarding copyright ownership.
|
|
|
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
# (the "License"); you may not use this file except in compliance with
|
|
|
|
|
# the License. You may obtain a copy of the License at
|
|
|
|
|
#
|
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
#
|
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
|
# limitations under the License.
|
|
|
|
|
#
|
|
|
|
|
-->
|
2019-11-25 13:09:32 +08:00
|
|
|
|
# 构建 Apache APISIX
|
2019-10-31 09:27:28 +08:00
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
## 1. 安装依赖
|
|
|
|
|
Apache APISIX 的运行环境需要 Nginx 和 etcd,
|
2019-07-18 16:09:30 +08:00
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
所以在安装前,请根据不同的操作系统来[安装依赖](install-dependencies.md)。
|
2019-07-18 16:09:30 +08:00
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
## 2. 安装 Apache APISIX
|
2019-09-16 21:40:39 +08:00
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
你可以通过源码包、Docker、Luarocks 等多种方式来安装 Apache APISIX。
|
2019-07-18 16:09:30 +08:00
|
|
|
|
|
2019-11-27 21:55:56 +08:00
|
|
|
|
### 通过源码包安装
|
2019-11-25 13:09:32 +08:00
|
|
|
|
|
2019-11-27 21:55:56 +08:00
|
|
|
|
你需要先下载 Apache Release 源码包:
|
2019-09-12 10:56:47 +08:00
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
```shell
|
2020-02-25 10:17:31 +08:00
|
|
|
|
wget http://www.apache.org/dist/incubator/apisix/1.1/apache-apisix-1.1-incubating-src.tar.gz
|
|
|
|
|
tar zxvf apache-apisix-1.1-incubating-src.tar.gz
|
2019-11-25 13:09:32 +08:00
|
|
|
|
```
|
2019-09-12 10:56:47 +08:00
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
安装运行时依赖的 Lua 库:
|
|
|
|
|
```
|
2020-02-25 10:17:31 +08:00
|
|
|
|
cd apache-apisix-1.1-incubating
|
2019-11-12 16:38:23 +08:00
|
|
|
|
make deps
|
2019-07-18 16:09:30 +08:00
|
|
|
|
```
|
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
### 通过 RPM 包安装(CentOS 7)
|
|
|
|
|
|
|
|
|
|
```shell
|
2020-02-25 10:17:31 +08:00
|
|
|
|
sudo yum install -y https://github.com/apache/incubator-apisix/releases/download/1.1/apisix-1.1-0.el7.noarch.rpm
|
2019-11-25 13:09:32 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### 通过 Luarocks 安装 (不支持 macOS)
|
2019-07-18 16:09:30 +08:00
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
在终端中执行下面命令完成 APISIX 的安装(只推荐开发者使用):
|
2019-07-18 16:09:30 +08:00
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
> 通过脚本安装 master 分支的代码
|
2019-07-18 16:09:30 +08:00
|
|
|
|
|
|
|
|
|
```shell
|
2019-11-25 13:09:32 +08:00
|
|
|
|
sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/apache/incubator-apisix/master/utils/install-apisix.sh)"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
> 通过 Luarocks 安装指定的版本:
|
|
|
|
|
|
|
|
|
|
```shell
|
2020-02-25 10:17:31 +08:00
|
|
|
|
# 安装 apisix 的 1.1 版本
|
|
|
|
|
sudo luarocks install --lua-dir=/path/openresty/luajit apisix 1.1
|
2019-11-25 13:09:32 +08:00
|
|
|
|
|
|
|
|
|
# 老版本 luarocks 可能不支持 `lua-dir` 参数,可以删除该选项
|
2020-02-25 10:17:31 +08:00
|
|
|
|
sudo luarocks install apisix 1.1
|
2019-07-18 16:09:30 +08:00
|
|
|
|
```
|
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
## 3. 管理(启动、关闭等)APISIX 服务
|
2019-09-16 21:40:39 +08:00
|
|
|
|
|
|
|
|
|
我们可以在 apisix 的目录下用 `make run` 命令来启动服务,或者用 `make stop` 方式关闭服务。
|
2019-07-18 16:09:30 +08:00
|
|
|
|
|
|
|
|
|
```shell
|
2019-09-16 21:40:39 +08:00
|
|
|
|
# init nginx config file and etcd
|
|
|
|
|
$ make init
|
|
|
|
|
|
|
|
|
|
# start APISIX server
|
|
|
|
|
$ make run
|
|
|
|
|
|
|
|
|
|
# stop APISIX server
|
|
|
|
|
$ make stop
|
|
|
|
|
|
|
|
|
|
# more actions find by `help`
|
2019-07-18 16:09:30 +08:00
|
|
|
|
$ make help
|
|
|
|
|
Makefile rules:
|
|
|
|
|
|
2019-11-21 09:23:16 +08:00
|
|
|
|
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
|
|
|
|
|
clean: Remove generated files
|
|
|
|
|
reload: Reload the apisix server
|
|
|
|
|
install: Install the apisix
|
|
|
|
|
test: Run the test case
|
|
|
|
|
license-check: Check lua souce code for Apache License
|
2019-07-18 16:09:30 +08:00
|
|
|
|
```
|
|
|
|
|
|
2019-11-25 13:09:32 +08:00
|
|
|
|
## 4. 运行测试案例
|
2019-07-18 16:09:30 +08:00
|
|
|
|
|
2019-10-22 10:21:37 +08:00
|
|
|
|
1. 先安装 perl 的包管理器 cpanminus
|
|
|
|
|
2. 然后通过 cpanm 来安装 test-gninx:`sudo cpanm --notest Test::Nginx IPC::Run > build.log 2>&1 || (cat build.log && exit 1)`
|
|
|
|
|
3. 然后 clone 最新的源码:`git clone https://github.com/openresty/test-nginx.git`
|
2019-10-30 10:43:37 +08:00
|
|
|
|
4. 通过 perl 的 `prove` 命令来加载 test-nginx 的库,并运行 `/t` 目录下的测试案例集:
|
|
|
|
|
* 直接运行:`prove -Itest-nginx/lib -r t`
|
|
|
|
|
* 指定 nginx 二进制路径:`TEST_NGINX_BINARY=/usr/local/bin/openresty prove -Itest-nginx/lib -r t`
|