docs: update apisix-base link. (#7047)

This commit is contained in:
feihan 2022-05-16 12:46:44 +08:00 committed by GitHub
parent 477d32820f
commit 933f8ebddc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 25 additions and 17 deletions

View File

@ -285,7 +285,7 @@ etcd:
#password: 5tHkHhYkjr6cQY # root password for etcd
tls:
# To enable etcd client certificate you need to build APISIX-Base, see
# https://apisix.apache.org/docs/apisix/how-to-build/#step-6-build-openresty-for-apache-apisix
# https://apisix.apache.org/docs/apisix/FAQ#how-do-i-build-the-apisix-base-environment?
#cert: /path/to/cert # path of certificate used by the etcd client
#key: /path/to/key # path of key used by the etcd client

View File

@ -102,6 +102,10 @@ make deps ENV_LUAROCKS_SERVER=https://luarocks.cn
If this does not solve your problem, you can try getting a detailed log by using the `--verbose` flag to diagnose the problem.
## How do I build the APISIX-Base environment?
Some functions need to introduce additional NGINX modules, which requires APISIX to run on APISIX-Base. If you need these functions, you can refer to the code in [api7/apisix-build-tools](https://github.com/api7/apisix-build-tools) to build your own APISIX-Base environment.
## How can I make a gray release with Apache APISIX?
Let's take an example query `foo.com/product/index.html?id=204&page=2` and consider that you need to make a gray release based on the `id` in the query string with this condition:

View File

@ -564,7 +564,7 @@ The following should be considered when setting the `hash_on` value:
- When set to `vars_combinations`, the `key` is required. The value of the key can be a combination of any of the [Nginx variables](http://nginx.org/en/docs/varindex.html) like `$request_uri$remote_addr`.
- When no value is set for either `hash_on` or `key`, the key defaults to `remote_addr`.
The features described below requires APISIX to be run on [APISIX-Base](./how-to-build.md#step-6-build-openresty-for-apache-apisix):
The features described below requires APISIX to be run on [APISIX-Base](./FAQ.md#how-do-i-build-the-apisix-base-environment?):
You can set the `scheme` to `tls`, which means "TLS over TCP".

View File

@ -66,7 +66,7 @@ curl --cacert /data/certs/mtls_ca.crt --key /data/certs/mtls_client.key --cert /
### How to configure
You need to [build APISIX-Base](./how-to-build.md#step-6-build-openresty-for-apache-apisix) and configure `etcd.tls` section if you want APISIX to work on an etcd cluster with mTLS enabled.
You need to build [APISIX-Base](./FAQ.md#how-do-i-build-the-apisix-base-environment?) and configure `etcd.tls` section if you want APISIX to work on an etcd cluster with mTLS enabled.
```yaml
etcd:

View File

@ -26,7 +26,7 @@ title: client-control
The `client-control` plugin dynamically controls the behavior of Nginx to
handle the client request.
**This plugin requires APISIX to run on [APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).**
**This plugin requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment?).**
## Attributes

View File

@ -32,7 +32,7 @@ The `gzip` Plugin dynamically sets the behavior of [gzip in Nginx](https://docs.
:::info IMPORTANT
This Plugin requires APISIX to run on [APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).
This Plugin requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment?).
:::

View File

@ -25,7 +25,7 @@ title: proxy-control
The `proxy-control` plugin dynamically controls the behavior of Nginx to proxy.
**This plugin requires APISIX to run on [APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).**
**This plugin requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment?).**
## Attributes

View File

@ -35,7 +35,7 @@ This is more flexible but functions similarly to Nginx's [ngx_http_realip_module
:::info IMPORTANT
This Plugin requires APISIX to run on [APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).
This Plugin requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment?).
:::

View File

@ -23,7 +23,7 @@ title: Wasm
APISIX supports Wasm plugins written with [Proxy Wasm SDK](https://github.com/proxy-wasm/spec#sdks).
This plugin requires APISIX to run on [APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix), and is under construction.
This plugin requires APISIX to run on [APISIX-Base](./FAQ.md#how-do-i-build-the-apisix-base-environment?), and is under construction.
Currently, only a few APIs are implemented. Please follow [wasm-nginx-module](https://github.com/api7/wasm-nginx-module) to know the progress.
## Programming model

View File

@ -35,7 +35,7 @@ The Redis protocol support allows APISIX to proxy Redis commands, and provide va
:::note
This feature requires APISIX to be run on [APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix).
This feature requires APISIX to be run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment?).
It also requires the data sent from clients are well-formed and sane. Therefore, it should only be used in deployments where both the downstream and upstream are trusted.

View File

@ -105,6 +105,10 @@ make deps ENV_LUAROCKS_SERVER=https://luarocks.cn
如果通过上述操作仍然无法解决问题,可以尝试使用 `--verbose` 参数获取详细的日志来诊断问题。
## 如何构建 APISIX-Base 环境?
有些功能需要引入额外的 NGINX 模块,这就要求 APISIX 需要运行在 APISIX-Base 上。如果你需要这些功能,你可以参考 [api7/apisix-build-tools](https://github.com/api7/apisix-build-tools) 中的代码,构建自己的 APISIX-Base 环境。
## 我该如何使用 Apache APISIX 进行灰度发布?
举个例子,比如:`foo.com/product/index.html?id=204&page=2`,并考虑您需要根据查询字符串中的 `id` 在此条件下进行灰度发布:

View File

@ -571,7 +571,7 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
4. 设为 `consumer` 时,`key` 不需要设置。此时哈希算法采用的 `key` 为认证通过的 `consumer_name`
5. 如果指定的 `hash_on``key` 获取不到值时,就是用默认值:`remote_addr`。
以下特性需要 APISIX 运行于 [APISIX-Base](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)
以下特性需要 APISIX 运行于 [APISIX-Base](./FAQ.md#如何构建-APISIX-Base-环境?)
`scheme` 可以设置成 `tls`,表示 "TLS over TCP"。
@ -580,7 +580,7 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外,还支持对上
`keepalive_pool` 允许 upstream 对象有自己单独的连接池。
它下属的字段,比如 `requests`,可以用了配置上游连接保持的参数。
这个特性需要 APISIX 运行于 [APISIX-Base](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty)。
这个特性需要 APISIX 运行于 [APISIX-Base](./FAQ.md#如何构建-APISIX-Base-环境?)。
**upstream 对象 json 配置内容:**

View File

@ -66,7 +66,7 @@ curl --cacert /data/certs/mtls_ca.crt --key /data/certs/mtls_client.key --cert /
### 如何配置
你需要构建 [APISIX-Base](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty),并且需要在配置文件中设定 `etcd.tls` 来使 ETCD 的双向认证功能正常工作。
你需要构建 [APISIX-Base](./FAQ.md#如何构建-APISIX-Base-环境?),并且需要在配置文件中设定 `etcd.tls` 来使 ETCD 的双向认证功能正常工作。
```yaml
etcd:
@ -154,7 +154,7 @@ curl --resolve 'mtls.test.com:<APISIX_HTTPS_PORT>:<APISIX_URL>' "https://<APISIX
在配置 upstream 资源时,可以使用参数 `tls.client_cert``tls.client_key` 来配置 APISIX 用于与上游进行通讯时使用的证书。可参考 [Upstream API 文档](./admin-api.md#upstream)。
该功能需要 APISIX 运行在 [APISIX-Base](./how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
该功能需要 APISIX 运行在 [APISIX-Base](./FAQ.md#如何构建-APISIX-Base-环境?) 上。
下面是一个与配置 SSL 时相似的 Python 脚本,可为一个已存在的 upstream 资源配置双向认证。如果需要,可修改 API 地址和 API Key。

View File

@ -25,7 +25,7 @@ title: client-control
`client-control` 插件能够动态地控制 Nginx 处理客户端的请求的行为。
**这个插件需要 APISIX 在 [APISIX-Base](../how-to-build.md#step-6-build-openresty-for-apache-apisix) 上运行。**
**这个插件需要 APISIX 在 [APISIX-Base](../FAQ.md#如何构建-APISIX-Base-环境?) 上运行。**
## 属性

View File

@ -32,7 +32,7 @@ description: 本文介绍了关于 Apache APISIX `gzip` 插件的基本信息及
:::info IMPORTANT
该插件要求 Apache APISIX 运行在 [APISIX-Base](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
该插件要求 Apache APISIX 运行在 [APISIX-Base](../FAQ.md#如何构建-APISIX-Base-环境?) 上。
:::

View File

@ -25,7 +25,7 @@ title: proxy-control
`proxy-control` 能够动态地控制 Nginx 代理的行为。
**这个插件需要 APISIX 在 [APISIX-Base](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上运行。**
**这个插件需要 APISIX 在 [APISIX-Base](../FAQ.md#如何构建-APISIX-Base-环境?) 上运行。**
## 属性

View File

@ -35,7 +35,7 @@ description: 本文介绍了关于 Apache APISIX `real-ip` 插件的基本信息
:::info IMPORTANT
该插件要求 APISIX 运行在 [APISIX-Base](../how-to-build.md#步骤-6-为-apache-apisix-构建-openresty) 上。
该插件要求 APISIX 运行在 [APISIX-Base](../FAQ.md#如何构建-APISIX-Base-环境?) 上。
:::