changeset 2632:52500ccb82c1

Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 04 Dec 2020 13:34:05 +0000
parents 7da360f50017
children ffaf58e96708
files xml/en/docs/http/ngx_http_upstream_hc_module.xml xml/en/docs/http/ngx_http_upstream_module.xml xml/en/docs/stream/ngx_stream_zone_sync_module.xml xml/ru/docs/http/ngx_http_upstream_hc_module.xml xml/ru/docs/http/ngx_http_upstream_module.xml
diffstat 5 files changed, 117 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_upstream_hc_module.xml
+++ b/xml/en/docs/http/ngx_http_upstream_hc_module.xml
@@ -201,6 +201,36 @@ By default, equals the
 <link doc="ngx_http_upstream_module.xml" id="server"/> port.
 </tag-desc>
 
+<tag-name id="health_check_grpc">
+<literal>type</literal>=<literal>grpc</literal>
+[<literal>grpc_service</literal>=<value>name</value>]
+[<literal>grpc_status</literal>=<value>code</value>]
+</tag-name>
+<tag-desc>
+enables periodic
+<link url="https://github.com/grpc/grpc/blob/master/doc/health-checking.md#grpc-health-checking-protocol">health
+checks</link> of a gRPC server
+or a particular gRPC service specified with the optional
+<literal>grpc_service</literal> parameter (1.19.5).
+If the server does not support the gRPC Health Checking Protocol,
+the optional <literal>grpc_status</literal> parameter can be used
+to specify non-zero gRPC
+<link url="https://github.com/grpc/grpc/blob/master/doc/statuscodes.md#status-codes-and-their-use-in-grpc">status</link>
+(for example,
+status code “<literal>12</literal>” / “<literal>UNIMPLEMENTED</literal>”)
+that will be treated as healthy:
+<example>
+health_check mandatory type=grpc grpc_status=12;
+</example>
+The <literal>type</literal>=<literal>grpc</literal> parameter
+must be specified after all other directive parameters,
+<literal>grpc_service</literal> and <literal>grpc_status</literal>
+must follow <literal>type</literal>=<literal>grpc</literal>.
+The parameter is not compatible with
+<link id="health_check_uri"><literal>uri</literal></link> or
+<link id="health_check_match"><literal>match</literal></link> parameters.
+</tag-desc>
+
 </list>
 </para>
 
--- a/xml/en/docs/http/ngx_http_upstream_module.xml
+++ b/xml/en/docs/http/ngx_http_upstream_module.xml
@@ -961,6 +961,7 @@ This directive is available as part of o
     [<literal>expires=</literal><value>time</value>]
     [<literal>domain=</literal><value>domain</value>]
     [<literal>httponly</literal>]
+    [<literal>samesite=</literal><literal>strict</literal>|<literal>lax</literal>|<literal>none</literal>]
     [<literal>secure</literal>]
     [<literal>path=</literal><value>path</value>]</syntax>
 <syntax>
@@ -1050,10 +1051,19 @@ Parameter value can contain variables (1
 Adds the <literal>HttpOnly</literal> attribute to the cookie (1.7.11).
 </tag-desc>
 
+<tag-name id="sticky_samesite"><literal>samesite=</literal><literal>strict</literal> |
+<literal>lax</literal> | <literal>none</literal></tag-name>
+<tag-desc>
+Adds the <literal>SameSite</literal> attribute to the cookie
+with one of the following values (1.19.4):
+<literal>Strict</literal>,
+<literal>Lax</literal>, or
+<literal>None</literal>.
+</tag-desc>
+
 <tag-name><literal>secure</literal></tag-name>
 <tag-desc>
 Adds the <literal>Secure</literal> attribute to the cookie (1.7.11).
-
 </tag-desc>
 
 <tag-name><literal>path=</literal><value>path</value></tag-name>
--- a/xml/en/docs/stream/ngx_stream_zone_sync_module.xml
+++ b/xml/en/docs/stream/ngx_stream_zone_sync_module.xml
@@ -320,6 +320,41 @@ The full list can be viewed using the
 </directive>
 
 
+<directive name="zone_sync_ssl_conf_command">
+<syntax><value>command</value></syntax>
+<default/>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.19.4</appeared-in>
+
+<para>
+Sets arbitrary OpenSSL configuration
+<link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">commands</link>
+when establishing a connection with another cluster server.
+<note>
+The directive is supported when using OpenSSL 1.0.2 or higher.
+</note>
+</para>
+
+<para>
+Several <literal>zone_sync_ssl_conf_command</literal> directives
+can be specified on the same level.
+These directives are inherited from the previous configuration level
+if and only if there are
+no <literal>zone_sync_ssl_conf_command</literal> directives
+defined on the current level.
+</para>
+
+<para>
+<note>
+Note that configuring OpenSSL directly
+might result in unexpected behavior.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="zone_sync_ssl_crl">
 <syntax><value>file</value></syntax>
 <default/>
--- a/xml/ru/docs/http/ngx_http_upstream_hc_module.xml
+++ b/xml/ru/docs/http/ngx_http_upstream_hc_module.xml
@@ -201,6 +201,36 @@ http {
 <link doc="ngx_http_upstream_module.xml" id="server">сервера</link>.
 </tag-desc>
 
+<tag-name id="health_check_grpc">
+<literal>type</literal>=<literal>grpc</literal>
+[<literal>grpc_service</literal>=<value>имя</value>]
+[<literal>grpc_status</literal>=<value>код</value>]
+</tag-name>
+<tag-desc>
+активирует периодические
+<link url="https://github.com/grpc/grpc/blob/master/doc/health-checking.md#grpc-health-checking-protocol">проверки
+работоспособности</link> gRPC-сервера
+или службы gRPC, указанной при помощи необязательного
+параметра <literal>grpc_service</literal> (1.19.5).
+Если сервер не поддерживает протокол проверки работоспособности gRPC,
+то можно использовать необязательный параметр <literal>grpc_status</literal>
+для указания
+<link url="https://github.com/grpc/grpc/blob/master/doc/statuscodes.md#status-codes-and-their-use-in-grpc">статуса</link>
+(например
+статус “<literal>12</literal>” / “<literal>UNIMPLEMENTED</literal>”)
+при получении которого сервер признаётся работоспособным:
+<example>
+health_check mandatory type=grpc grpc_status=12;
+</example>
+Параметр <literal>type</literal>=<literal>grpc</literal>
+должен быть указан после остальных параметров директивы,
+<literal>grpc_service</literal> и <literal>grpc_status</literal>
+должны быть указаны после <literal>type</literal>=<literal>grpc</literal>.
+Параметр несовместим с параметрами
+<link id="health_check_uri"><literal>uri</literal></link> и
+<link id="health_check_match"><literal>match</literal></link>.
+</tag-desc>
+
 </list>
 </para>
 
--- a/xml/ru/docs/http/ngx_http_upstream_module.xml
+++ b/xml/ru/docs/http/ngx_http_upstream_module.xml
@@ -971,6 +971,7 @@ resolver_timeout 5s;
     [<literal>expires=</literal><value>время</value>]
     [<literal>domain=</literal><value>домен</value>]
     [<literal>httponly</literal>]
+    [<literal>samesite=</literal><literal>strict</literal>|<literal>lax</literal>|<literal>none</literal>]
     [<literal>secure</literal>]
     [<literal>path=</literal><value>путь</value>]</syntax>
 <syntax>
@@ -1058,6 +1059,16 @@ 31 декабря 2037 года 23:55:55 GMT.
 Добавляет атрибут <literal>HttpOnly</literal> к куке (1.7.11).
 </tag-desc>
 
+<tag-name id="sticky_samesite"><literal>samesite=</literal><literal>strict</literal> |
+<literal>lax</literal> | <literal>none</literal></tag-name>
+<tag-desc>
+Добавляет атрибут <literal>SameSite</literal> к куке
+с одним из следующих значений (1.19.4):
+<literal>Strict</literal>,
+<literal>Lax</literal> или
+<literal>None</literal>.
+</tag-desc>
+
 <tag-name><literal>secure</literal></tag-name>
 <tag-desc>
 Добавляет атрибут <literal>Secure</literal> к куке (1.7.11).