From d5f10927991fb8def596c2a8d6de4197bbfa0934 Mon Sep 17 00:00:00 2001 From: Sn0rt Date: Mon, 20 Nov 2023 14:13:17 +0800 Subject: [PATCH] docs: replace apisix-base with apisix-runtime Signed-off-by: Sn0rt --- apisix/cli/ngx_tpl.lua | 2 +- apisix/init.lua | 2 +- apisix/plugins/client-control.lua | 2 +- apisix/plugins/gm.lua | 2 +- apisix/plugins/gzip.lua | 2 +- apisix/plugins/prometheus/exporter.lua | 2 +- apisix/plugins/proxy-control.lua | 2 +- apisix/plugins/real-ip.lua | 2 +- apisix/upstream.lua | 4 ++-- apisix/wasm.lua | 2 +- docs/en/latest/FAQ.md | 4 ++-- docs/en/latest/admin-api.md | 2 +- docs/en/latest/building-apisix.md | 2 +- docs/en/latest/mtls.md | 2 +- docs/en/latest/plugins/client-control.md | 2 +- docs/en/latest/plugins/dubbo-proxy.md | 2 +- docs/en/latest/plugins/gzip.md | 2 +- docs/en/latest/plugins/prometheus.md | 4 ++-- docs/en/latest/plugins/proxy-control.md | 2 +- docs/en/latest/plugins/real-ip.md | 2 +- docs/en/latest/support-fips-in-apisix.md | 14 +++++++------- docs/en/latest/wasm.md | 1 - docs/en/latest/xrpc/redis.md | 2 +- docs/zh/latest/FAQ.md | 4 ++-- docs/zh/latest/admin-api.md | 2 +- docs/zh/latest/building-apisix.md | 4 ++-- docs/zh/latest/mtls.md | 4 ++-- docs/zh/latest/plugins/client-control.md | 2 +- docs/zh/latest/plugins/dubbo-proxy.md | 2 +- docs/zh/latest/plugins/gm.md | 6 +++--- docs/zh/latest/plugins/gzip.md | 2 +- docs/zh/latest/plugins/prometheus.md | 4 ++-- docs/zh/latest/plugins/proxy-control.md | 2 +- docs/zh/latest/plugins/real-ip.md | 2 +- docs/zh/latest/support-fips-in-apisix.md | 14 +++++++------- .../latest/upgrade-guide-from-2.15.x-to-3.0.0.md | 2 +- t/cli/test_apisix_mirror.sh | 6 +++--- t/error_page/error_page.t | 2 +- 38 files changed, 60 insertions(+), 61 deletions(-) diff --git a/apisix/cli/ngx_tpl.lua b/apisix/cli/ngx_tpl.lua index 3e1aadd9b543..d2437d377860 100644 --- a/apisix/cli/ngx_tpl.lua +++ b/apisix/cli/ngx_tpl.lua @@ -776,7 +776,7 @@ http { {% if use_apisix_base then %} # For servers which obey the standard, when `:authority` is missing, - # `host` will be used instead. When used with apisix-base, we can do + # `host` will be used instead. When used with apisix-runtime, we can do # better by setting `:authority` directly grpc_set_header ":authority" $upstream_host; {% else %} diff --git a/apisix/init.lua b/apisix/init.lua index 48421e8f26c0..c234f3bdff6e 100644 --- a/apisix/init.lua +++ b/apisix/init.lua @@ -309,7 +309,7 @@ end local function verify_tls_client(ctx) if apisix_base_flags.client_cert_verified_in_handshake then - -- For apisix-base, there is no need to rematch SSL rules as the invalid + -- For apisix-runtime, there is no need to rematch SSL rules as the invalid -- connections are already rejected in the handshake return true end diff --git a/apisix/plugins/client-control.lua b/apisix/plugins/client-control.lua index c72ee41906be..63c0cacb9d5b 100644 --- a/apisix/plugins/client-control.lua +++ b/apisix/plugins/client-control.lua @@ -49,7 +49,7 @@ end function _M.rewrite(conf, ctx) if not ok then - core.log.error("need to build APISIX-Base to support client control") + core.log.error("need to build APISIX-Runtime to support client control") return 501 end diff --git a/apisix/plugins/gm.lua b/apisix/plugins/gm.lua index 929dac6f0895..ee147ce29d92 100644 --- a/apisix/plugins/gm.lua +++ b/apisix/plugins/gm.lua @@ -136,7 +136,7 @@ local _M = { function _M.init() if not pcall(function () return C.Tongsuo_version_num end) then error("need to build Tongsuo (https://github.com/Tongsuo-Project/Tongsuo) " .. - "into the APISIX-Base") + "into the APISIX-Runtime") end ssl.enable_ntls() diff --git a/apisix/plugins/gzip.lua b/apisix/plugins/gzip.lua index 8720cfe9fb4f..dfd0f10c071b 100644 --- a/apisix/plugins/gzip.lua +++ b/apisix/plugins/gzip.lua @@ -102,7 +102,7 @@ end function _M.header_filter(conf, ctx) if not is_apisix_or then - core.log.error("need to build APISIX-Base to support setting gzip") + core.log.error("need to build APISIX-Runtime to support setting gzip") return 501 end diff --git a/apisix/plugins/prometheus/exporter.lua b/apisix/plugins/prometheus/exporter.lua index 623a9eddf113..f795a27a0d2c 100644 --- a/apisix/plugins/prometheus/exporter.lua +++ b/apisix/plugins/prometheus/exporter.lua @@ -201,7 +201,7 @@ function _M.stream_init() end if not pcall(function() return C.ngx_meta_lua_ffi_shdict_udata_to_zone end) then - core.log.error("need to build APISIX-Base to support L4 metrics") + core.log.error("need to build APISIX-Runtime to support L4 metrics") return end diff --git a/apisix/plugins/proxy-control.lua b/apisix/plugins/proxy-control.lua index 9b9246b2f301..fc87e4529811 100644 --- a/apisix/plugins/proxy-control.lua +++ b/apisix/plugins/proxy-control.lua @@ -47,7 +47,7 @@ end -- we want to control proxy behavior before auth, so put the code under rewrite method function _M.rewrite(conf, ctx) if not ok then - core.log.error("need to build APISIX-Base to support proxy control") + core.log.error("need to build APISIX-Runtime to support proxy control") return 501 end diff --git a/apisix/plugins/real-ip.lua b/apisix/plugins/real-ip.lua index 242af9608cd8..71c33095b801 100644 --- a/apisix/plugins/real-ip.lua +++ b/apisix/plugins/real-ip.lua @@ -131,7 +131,7 @@ end function _M.rewrite(conf, ctx) if not is_apisix_or then - core.log.error("need to build APISIX-Base to support setting real ip") + core.log.error("need to build APISIX-Runtime to support setting real ip") return 501 end diff --git a/apisix/upstream.lua b/apisix/upstream.lua index d8e3f3a98750..52b5382b374f 100644 --- a/apisix/upstream.lua +++ b/apisix/upstream.lua @@ -36,7 +36,7 @@ if ok then set_upstream_tls_client_param = apisix_ngx_upstream.set_cert_and_key else set_upstream_tls_client_param = function () - return nil, "need to build APISIX-Base to support upstream mTLS" + return nil, "need to build APISIX-Runtime to support upstream mTLS" end end @@ -47,7 +47,7 @@ if not is_http then set_stream_upstream_tls = apisix_ngx_stream_upstream.set_tls else set_stream_upstream_tls = function () - return nil, "need to build APISIX-Base to support TLS over TCP upstream" + return nil, "need to build APISIX-Runtime to support TLS over TCP upstream" end end end diff --git a/apisix/wasm.lua b/apisix/wasm.lua index c8b863aeac9d..6a937287fc19 100644 --- a/apisix/wasm.lua +++ b/apisix/wasm.lua @@ -157,7 +157,7 @@ end function _M.require(attrs) if not support_wasm then - return nil, "need to build APISIX-Base to support wasm" + return nil, "need to build APISIX-Runtime to support wasm" end local name = attrs.name diff --git a/docs/en/latest/FAQ.md b/docs/en/latest/FAQ.md index 79e3f3d48a51..449abd882bf0 100644 --- a/docs/en/latest/FAQ.md +++ b/docs/en/latest/FAQ.md @@ -107,9 +107,9 @@ 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` or `-v` flag to diagnose the problem. -## How do I build the APISIX-Base environment? +## How do I build the APISIX-Runtime 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. +Some functions need to introduce additional NGINX modules, which requires APISIX to run on APISIX-Runtime. 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-Runtime environment. ## How can I make a gray release with Apache APISIX? diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md index c900fb5a9047..722cdd57047d 100644 --- a/docs/en/latest/admin-api.md +++ b/docs/en/latest/admin-api.md @@ -928,7 +928,7 @@ The following should be considered when setting the `hash_on` value: - When set to `consumer`, the `key` is optional and the key is set to the `consumer_name` captured from the authentication Plugin. - 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`. -The features described below requires APISIX to be run on [APISIX-Base](./FAQ.md#how-do-i-build-the-apisix-base-environment): +The features described below requires APISIX to be run on [APISIX-Runtime](./FAQ.md#how-do-i-build-the-apisix-runtime-environment): You can set the `scheme` to `tls`, which means "TLS over TCP". diff --git a/docs/en/latest/building-apisix.md b/docs/en/latest/building-apisix.md index cf4177a164ca..ba9c9c6d2e16 100644 --- a/docs/en/latest/building-apisix.md +++ b/docs/en/latest/building-apisix.md @@ -203,7 +203,7 @@ apisix stop Some features of APISIX requires additional Nginx modules to be introduced into OpenResty. -To use these features, you need to build a custom distribution of OpenResty (apisix-base). See [apisix-build-tools](https://github.com/api7/apisix-build-tools) for setting up your build environment and building it. +To use these features, you need to build a custom distribution of OpenResty (apisix-runtime). See [apisix-build-tools](https://github.com/api7/apisix-build-tools) for setting up your build environment and building it. ## Running tests diff --git a/docs/en/latest/mtls.md b/docs/en/latest/mtls.md index fe0f43ef7ef9..25a1747308e5 100644 --- a/docs/en/latest/mtls.md +++ b/docs/en/latest/mtls.md @@ -168,7 +168,7 @@ Sometimes the upstream requires mTLS. In this situation, the APISIX acts as the When configuring `upstreams`, we could use parameter `tls.client_cert` and `tls.client_key` to configure the client certificate APISIX used to communicate with upstreams. Please refer to [Admin API](./admin-api.md#upstream) for details. -This feature requires APISIX to run on [APISIX-Base](./FAQ.md#how-do-i-build-the-apisix-base-environment). +This feature requires APISIX to run on [APISIX-Runtime](./FAQ.md#how-do-i-build-the-apisix-runtime-environment). Here is a similar Python script to patch a existed upstream with mTLS (changes admin API url if needed): diff --git a/docs/en/latest/plugins/client-control.md b/docs/en/latest/plugins/client-control.md index fd226f7b2ba1..61d15ca60d3e 100644 --- a/docs/en/latest/plugins/client-control.md +++ b/docs/en/latest/plugins/client-control.md @@ -32,7 +32,7 @@ The `client-control` Plugin can be used to dynamically control the behavior of N :::info IMPORTANT -This Plugin requires APISIX to run on APISIX-Base. See [apisix-build-tools](https://github.com/api7/apisix-build-tools) for more info. +This Plugin requires APISIX to run on APISIX-Runtime. See [apisix-build-tools](https://github.com/api7/apisix-build-tools) for more info. ::: diff --git a/docs/en/latest/plugins/dubbo-proxy.md b/docs/en/latest/plugins/dubbo-proxy.md index 90459040c465..9dc8e1930465 100644 --- a/docs/en/latest/plugins/dubbo-proxy.md +++ b/docs/en/latest/plugins/dubbo-proxy.md @@ -34,7 +34,7 @@ The `dubbo-proxy` Plugin allows you to proxy HTTP requests to [Apache Dubbo](htt :::info IMPORTANT -If you are using OpenResty, you need to build it with Dubbo support. See [How do I build the APISIX base environment](./../FAQ.md#how-do-i-build-the-apisix-base-environment) for details. +If you are using OpenResty, you need to build it with Dubbo support. See [How do I build the APISIX runtime environment](./../FAQ.md#how-do-i-build-the-apisix-runtime-environment) for details. ::: diff --git a/docs/en/latest/plugins/gzip.md b/docs/en/latest/plugins/gzip.md index b812de4daf82..9b86e2e4f453 100644 --- a/docs/en/latest/plugins/gzip.md +++ b/docs/en/latest/plugins/gzip.md @@ -33,7 +33,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](../FAQ.md#how-do-i-build-the-apisix-base-environment). +This Plugin requires APISIX to run on [APISIX-Runtime](../FAQ.md#how-do-i-build-the-apisix-runtime-environment). ::: diff --git a/docs/en/latest/plugins/prometheus.md b/docs/en/latest/plugins/prometheus.md index 71927fc3ba91..f1eb20d87f4d 100644 --- a/docs/en/latest/plugins/prometheus.md +++ b/docs/en/latest/plugins/prometheus.md @@ -127,7 +127,7 @@ You can then expose it by using the [public-api](public-api.md) Plugin. If the Prometheus plugin collects too many metrics, it will take CPU resources to calculate the metric data when getting the metrics via URI, which may affect APISIX to process normal requests. To solve this problem, APISIX exposes the URI and calculates the metrics in the [privileged agent](https://github.com/openresty/lua-resty-core/blob/master/lib/ngx/process.md#enable_privileged_agent). If the URI is exposed using the public-api plugin, then APISIX will calculate the metric data in a normal worker process, which may still affect APISIX processing of normal requests. -This feature requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment). +This feature requires APISIX to run on [APISIX-Runtime](../FAQ.md#how-do-i-build-the-apisix-runtime-environment). ::: @@ -381,7 +381,7 @@ curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1 :::info IMPORTANT -This feature requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment?). +This feature requires APISIX to run on [APISIX-Runtime](../FAQ.md#how-do-i-build-the-apisix-runtime-environment?). ::: diff --git a/docs/en/latest/plugins/proxy-control.md b/docs/en/latest/plugins/proxy-control.md index e97d0dc5c084..48c8ce4a73cf 100644 --- a/docs/en/latest/plugins/proxy-control.md +++ b/docs/en/latest/plugins/proxy-control.md @@ -32,7 +32,7 @@ The proxy-control Plugin dynamically controls the behavior of the NGINX proxy. :::info IMPORTANT -This Plugin requires APISIX to run on [APISIX-Base](../FAQ.md#how-do-i-build-the-apisix-base-environment). See [apisix-build-tools](https://github.com/api7/apisix-build-tools) for more info. +This Plugin requires APISIX to run on [APISIX-Runtime](../FAQ.md#how-do-i-build-the-apisix-runtime-environment). See [apisix-build-tools](https://github.com/api7/apisix-build-tools) for more info. ::: diff --git a/docs/en/latest/plugins/real-ip.md b/docs/en/latest/plugins/real-ip.md index 115fc29b2a9e..519d502fdce1 100644 --- a/docs/en/latest/plugins/real-ip.md +++ b/docs/en/latest/plugins/real-ip.md @@ -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](../FAQ.md#how-do-i-build-the-apisix-base-environment). +This Plugin requires APISIX to run on [APISIX-Runtime](../FAQ.md#how-do-i-build-the-apisix-runtime-environment). ::: diff --git a/docs/en/latest/support-fips-in-apisix.md b/docs/en/latest/support-fips-in-apisix.md index 4e797e1c944b..996a44881753 100644 --- a/docs/en/latest/support-fips-in-apisix.md +++ b/docs/en/latest/support-fips-in-apisix.md @@ -7,7 +7,7 @@ keywords: - Code Contribution - Building APISIX - OpenSSL 3.0 FIPS -description: Compile apisix-base with OpenSSL 3.0 (FIPS enabled) +description: Compile apisix-runtime with OpenSSL 3.0 (FIPS enabled) --- -OpenSSL 3.0 [supports](https://www.openssl.org/blog/blog/2022/08/24/FIPS-validation-certificate-issued/) [FIPS](https://en.wikipedia.org/wiki/FIPS_140-2) mode. To support FIPS in APISIX, you can compile apisix-base with OpenSSL 3.0. +OpenSSL 3.0 [supports](https://www.openssl.org/blog/blog/2022/08/24/FIPS-validation-certificate-issued/) [FIPS](https://en.wikipedia.org/wiki/FIPS_140-2) mode. To support FIPS in APISIX, you can compile apisix-runtime with OpenSSL 3.0. ## Compilation -To compile apisix-base with OpenSSL 3.0, run the commands below as root user: +To compile apisix-runtime with OpenSSL 3.0, run the commands below as root user: ```bash cd $(mktemp -d) @@ -52,9 +52,9 @@ cd .. export cc_opt="-I$OPENSSL3_PREFIX/openssl-3.0/include" export ld_opt="-L$OPENSSL3_PREFIX/openssl-3.0/lib64 -Wl,-rpath,$OPENSSL3_PREFIX/openssl-3.0/lib64" -wget https://raw.githubusercontent.com/api7/apisix-build-tools/master/build-apisix-base.sh -chmod +x build-apisix-base.sh -./build-apisix-base.sh latest +wget --no-check-certificate https://raw.githubusercontent.com/api7/apisix-build-tools/master/build-apisix-runtime.sh +chmod +x build-apisix-runtime.sh +./build-apisix-runtime.sh ``` -This will install apisix-base to `/usr/local/openresty-debug`. +This will install apisix-runtime to `/usr/local/openresty`. diff --git a/docs/en/latest/wasm.md b/docs/en/latest/wasm.md index e261bc3a3858..c1702cced1d0 100644 --- a/docs/en/latest/wasm.md +++ b/docs/en/latest/wasm.md @@ -23,7 +23,6 @@ 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](./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 diff --git a/docs/en/latest/xrpc/redis.md b/docs/en/latest/xrpc/redis.md index b918c0f6fcee..76ed9f1394c9 100644 --- a/docs/en/latest/xrpc/redis.md +++ b/docs/en/latest/xrpc/redis.md @@ -36,7 +36,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](../FAQ.md#how-do-i-build-the-apisix-base-environment). +This feature requires APISIX to be run on [APISIX-Runtime](../FAQ.md#how-do-i-build-the-apisix-runtime-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. diff --git a/docs/zh/latest/FAQ.md b/docs/zh/latest/FAQ.md index 944f96195420..823bd73eb7dc 100644 --- a/docs/zh/latest/FAQ.md +++ b/docs/zh/latest/FAQ.md @@ -111,9 +111,9 @@ make deps ENV_LUAROCKS_SERVER=https://luarocks.cn 如果通过上述操作仍然无法解决问题，可以尝试使用 `--verbose` 或 `-v` 参数获取详细的日志来诊断问题。 -## 如何构建 APISIX-Base 环境？ +## 如何构建 APISIX-Runtime 环境？ -有些功能需要引入额外的 NGINX 模块，这就要求 APISIX 需要运行在 APISIX-Base 上。如果你需要这些功能，你可以参考 [api7/apisix-build-tools](https://github.com/api7/apisix-build-tools) 中的代码，构建自己的 APISIX-Base 环境。 +有些功能需要引入额外的 NGINX 模块，这就要求 APISIX 需要运行在 APISIX-Runtime 上。如果你需要这些功能，你可以参考 [api7/apisix-build-tools](https://github.com/api7/apisix-build-tools) 中的代码，构建自己的 APISIX-Runtime 环境。 ## 我该如何使用 Apache APISIX 进行灰度发布？ diff --git a/docs/zh/latest/admin-api.md b/docs/zh/latest/admin-api.md index 899fb4c44deb..60be95ec8ffc 100644 --- a/docs/zh/latest/admin-api.md +++ b/docs/zh/latest/admin-api.md @@ -935,7 +935,7 @@ APISIX 的 Upstream 除了基本的负载均衡算法选择外，还支持对上 - 设为 `cookie` 时，`key` 为必传参数，其值为自定义的 cookie name，即 "cookie\_`key`"。请注意 cookie name 是**区分大小写字母**的。例如：`cookie_x_foo` 与 `cookie_X_Foo` 表示不同的 `cookie`。 - 设为 `consumer` 时，`key` 不需要设置。此时哈希算法采用的 `key` 为认证通过的 `consumer_name`。 -以下特性需要 APISIX 运行于 [APISIX-Base](./FAQ.md#如何构建-APISIX-Base-环境？)： +以下特性需要 APISIX 运行于 [APISIX-Runtime](./FAQ.md#如何构建-APISIX-Runtime-环境？)： - `scheme` 可以设置成 `tls`，表示 `TLS over TCP`。 - `tls.client_cert/key` 可以用来跟上游进行 mTLS 通信。他们的格式和 SSL 对象的 `cert` 和 `key` 一样。 diff --git a/docs/zh/latest/building-apisix.md b/docs/zh/latest/building-apisix.md index 0796b73dd8ee..40e48113eda1 100644 --- a/docs/zh/latest/building-apisix.md +++ b/docs/zh/latest/building-apisix.md @@ -200,11 +200,11 @@ apisix quit apisix stop ``` -## 为 APISIX 构建 APISIX-Base +## 为 APISIX 构建 APISIX-Runtime APISIX 的一些特性需要在 OpenResty 中引入额外的 NGINX 模块。 -如果要使用这些功能，你需要构建一个自定义的 OpenResty 发行版（APISIX-Base）。请参考 [apisix-build-tools](https://github.com/api7/apisix-build-tools) 配置你的构建环境并进行构建。 +如果要使用这些功能，你需要构建一个自定义的 OpenResty 发行版（APISIX-Runtime）。请参考 [apisix-build-tools](https://github.com/api7/apisix-build-tools) 配置你的构建环境并进行构建。 ## 运行测试用例 diff --git a/docs/zh/latest/mtls.md b/docs/zh/latest/mtls.md index b9168065fd1a..c96f48f2ad62 100644 --- a/docs/zh/latest/mtls.md +++ b/docs/zh/latest/mtls.md @@ -68,7 +68,7 @@ curl --cacert /data/certs/mtls_ca.crt --key /data/certs/mtls_client.key --cert / ### 如何配置 -你需要构建 [APISIX-Base](./FAQ.md#如何构建-APISIX-Base-环境？)，并且需要在配置文件中设定 `etcd.tls` 来使 ETCD 的双向认证功能正常工作。 +你需要构建 [APISIX-runtime](./FAQ.md#如何构建-APISIX-runtime-环境？)，并且需要在配置文件中设定 `etcd.tls` 来使 ETCD 的双向认证功能正常工作。 ```yaml title="conf/config.yaml" deployment: @@ -163,7 +163,7 @@ curl --resolve 'mtls.test.com::' "https:// -目前，OpenSSL 3.0 [支持了](https://www.openssl.org/blog/blog/2022/08/24/FIPS-validation-certificate-issued/) [FIPS](https://en.wikipedia.org/wiki/FIPS_140-2) 模式。为了在 APISIX 中支持 FIPS 模式，你应该使用 OpenSSL 3.0 来编译 apisix-base。 +目前，OpenSSL 3.0 [支持了](https://www.openssl.org/blog/blog/2022/08/24/FIPS-validation-certificate-issued/) [FIPS](https://en.wikipedia.org/wiki/FIPS_140-2) 模式。为了在 APISIX 中支持 FIPS 模式，你应该使用 OpenSSL 3.0 来编译 apisix-runtime。 ## 编译 -如果你需要使用 OpenSSL 3.0 来编译 apisix-base，请以 root 用户角色来执行以下命令： +如果你需要使用 OpenSSL 3.0 来编译 apisix-runtime，请以 root 用户角色来执行以下命令： ```bash cd $(mktemp -d) @@ -52,9 +52,9 @@ cd .. export cc_opt="-I$OPENSSL3_PREFIX/openssl-3.0/include" export ld_opt="-L$OPENSSL3_PREFIX/openssl-3.0/lib64 -Wl,-rpath,$OPENSSL3_PREFIX/openssl-3.0/lib64" -wget https://raw.githubusercontent.com/api7/apisix-build-tools/master/build-apisix-base.sh -chmod +x build-apisix-base.sh -./build-apisix-base.sh latest +wget --no-check-certificate https://raw.githubusercontent.com/api7/apisix-build-tools/master/build-apisix-runtime.sh +chmod +x build-apisix-runtime.sh +./build-apisix-runtime.sh ``` -apisix-base 将安装在 `/usr/local/openresty-debug`。 +apisix-runtime 将安装在 `/usr/local/openresty`。 diff --git a/docs/zh/latest/upgrade-guide-from-2.15.x-to-3.0.0.md b/docs/zh/latest/upgrade-guide-from-2.15.x-to-3.0.0.md index 20c47d9c93a4..914c2931f506 100644 --- a/docs/zh/latest/upgrade-guide-from-2.15.x-to-3.0.0.md +++ b/docs/zh/latest/upgrade-guide-from-2.15.x-to-3.0.0.md @@ -58,7 +58,7 @@ APISIX 的版本号遵循[语义化版本](https://semver.org/lang/zh-CN/)。 如果你使用提供的二进制包（Debian 和 RHEL）或者镜像，则它们已经捆绑了 APISIX 所有必要的依赖项，你可以跳过本节。 -APISIX 的一些特性需要在 OpenResty 中引入额外的 NGINX 模块。如果要使用这些功能，你需要构建一个自定义的 OpenResty 发行版（APISIX-Base）。你可以参考 [api7/apisix-build-tools](https://github.com/api7/apisix-build-tools) 中的代码，构建自己的 APISIX-Base 环境。 +APISIX 的一些特性需要在 OpenResty 中引入额外的 NGINX 模块。如果要使用这些功能，你需要构建一个自定义的 OpenResty 发行版（APISIX-Runtime）。你可以参考 [api7/apisix-build-tools](https://github.com/api7/apisix-build-tools) 中的代码，构建自己的 APISIX-Runtime 环境。 如果你希望 APISIX 运行在原生的 OpenResty 上，这种情况下将只支持运行在 OpenResty 1.19.3.2 及以上的版本。 diff --git a/t/cli/test_apisix_mirror.sh b/t/cli/test_apisix_mirror.sh index f54d7ddfdd3d..5f685e77c781 100755 --- a/t/cli/test_apisix_mirror.sh +++ b/t/cli/test_apisix_mirror.sh @@ -50,13 +50,13 @@ curl -k -i http://127.0.0.1:9080/get sleep 0.1 if ! grep "apisix_mirror_on_demand on;" conf/nginx.conf > /dev/null; then - echo "failed: apisix_mirror_on_demand should on when running on apisix-base" + echo "failed: apisix_mirror_on_demand should on when running on apisix-runtime" exit 1 fi if grep -E "invalid URL prefix" logs/error.log > /dev/null; then - echo "failed: apisix_mirror_on_demand should on when running on apisix-base" + echo "failed: apisix_mirror_on_demand should on when running on apisix-runtime" exit 1 fi -echo "passed: apisix_mirror_on_demand is on when running on apisix-base" +echo "passed: apisix_mirror_on_demand is on when running on apisix-runtime" diff --git a/t/error_page/error_page.t b/t/error_page/error_page.t index 35a29815fe3e..c51185660726 100644 --- a/t/error_page/error_page.t +++ b/t/error_page/error_page.t @@ -19,7 +19,7 @@ use t::APISIX; my $nginx_binary = $ENV{'TEST_NGINX_BINARY'} || 'nginx'; my $version = eval { `$nginx_binary -V 2>&1` }; -# We put the error page into apisix-base. It is fine since this installation is the default. +# We put the error page into apisix-runtime. It is fine since this installation is the default. if ($version !~ m/\/apisix-nginx-module/) { plan(skip_all => "apisix-nginx-module not installed"); } else {