This is an automated email from the ASF dual-hosted git repository.
wenming pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git
The following commit(s) were added to refs/heads/master by this push:
new f3f5710 doc: Update doc for retries option in the upstream object.
(#1023)
f3f5710 is described below
commit f3f57107a79d60e7cfb1cf7deffa80ff579831a4
Author: agile6v <agil...@agile6v.com>
AuthorDate: Mon Jan 6 07:28:18 2020 +0800
doc: Update doc for retries option in the upstream object. (#1023)
---
doc/architecture-design-cn.md | 2 +-
doc/architecture-design.md | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/architecture-design-cn.md b/doc/architecture-design-cn.md
index 552bdd0..678f9aa 100644
--- a/doc/architecture-design-cn.md
+++ b/doc/architecture-design-cn.md
@@ -239,7 +239,7 @@ APISIX 的 Upstream 除了基本的复杂均衡算法选择外，还支持对上
|nodes |必需|哈希表，内部元素的 key 是上游机器地址列表，格式为`地址 + Port`，其中地址部分可以是 IP
也可以是域名，比如 `192.168.1.100:80`、`foo.com:80`等。value 则是节点的权重，特别的，当权重值为 `0`
有特殊含义，通常代表该上游节点失效，永远不希望被选中。|
|key |必需|该选项只有类型是 `chash` 才有效。根据 `key` 来查找对应的 node `id`，相同的 `key`
在同一个对象中，永远返回相同 id，目前支持的 Nginx 内置变量有 `uri, server_name, server_addr,
request_uri, remote_port, remote_addr, query_string, host, hostname,
arg_***`，其中 `arg_***` 是来自URL的请求参数，[Nginx
变量列表](http://nginx.org/en/docs/varindex.html)|
|checks |可选|配置健康检查的参数，详细可参考[health-check](health-check.md)|
-|retries |可选|使用底层的 Nginx 重试机制将请求传递给下一个上游，默认不启用重试机制|
+|retries |可选|使用底层的 Nginx
重试机制将请求传递给下一个上游，默认APISIX会启用重试机制，根据配置的后端节点个数设置重试次数，如果此参数显式被设置将会覆盖系统默认设置的重试次数。|
创建上游对象用例：
diff --git a/doc/architecture-design.md b/doc/architecture-design.md
index f38cf41..ac12cbb 100644
--- a/doc/architecture-design.md
+++ b/doc/architecture-design.md
@@ -234,7 +234,7 @@ In addition to the basic complex equalization algorithm
selection, APISIX's Upst
|nodes |required|Hash table, the key of the internal element is the
upstream machine address list, the format is `Address + Port`, where the
address part can be IP or domain name, such as `192.168.1.100:80`,
`foo.com:80`, etc. Value is the weight of the node. In particular, when the
weight value is `0`, it has a special meaning, which usually means that the
upstream node is invalid and never wants to be selected.|
|key |required|This option is only valid if the type is `chash`.
Find the corresponding node `id` according to `key`, the same `key` in the same
object, always return the same id. For now, it support nginx built-in variables
like `uri, server_name, server_addr, request_uri, remote_port, remote_addr,
query_string, host, hostname, arg_***`, `arg_***` is arguments in the request
line, [Nginx variables list](http://nginx.org/en/docs/varindex.html)|
|checks |optional|Configure the parameters of the health check. For
details, refer to [health-check](health-check.md).|
-|retries |optional|Pass the request to the next upstream using the
underlying Nginx retry mechanism, the retry mechanism is not enabled by
default.|
+|retries |optional|Pass the request to the next upstream using the
underlying Nginx retry mechanism, the retry mechanism is enabled by default and
set the number of retries according to the number of backend nodes. If
`retries` option is explicitly set, it will override the default value.|
Create an upstream object use case:
