nginx-site: xml/en/docs/stream/ngx_stream_zone_sync

annotate xml/en/docs/stream/ngx_stream_zone_sync_module.xml @ 2769:16f6fa718be2

Updated TLSv1.3 support notes. Previous notes described some early development snapshot of OpenSSL 1.1.1 with disabled TLSv1.3 by default. It was then enabled in the first alpha. Further, the updated text covers later major releases such as OpenSSL 3.0.

author	Sergey Kandaurov <pluknet@nginx.com>
date	Thu, 30 Sep 2021 16:29:20 +0300
parents	52500ccb82c1
children	92e5dca02091

rev	line source
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 <!--
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4 Copyright (C) Nginx, Inc.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	5 -->
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	6
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 <module name="Module ngx_stream_zone_sync_module"
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 link="/en/docs/stream/ngx_stream_zone_sync_module.html"
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 lang="en"
2377 2313c14d93b5 Added obligatory port to zone_sync_server examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2373 diff changeset	12 rev="5">
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14 <section id="summary">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16 <para>
2151 ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	17 The <literal>ngx_stream_zone_sync_module</literal> module (1.13.8)
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 provides the necessary support for synchronizing contents of
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 <link doc="ngx_stream_upstream_module.xml" id="zone">shared memory zones</link>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20 between nodes of a cluster.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 To enable synchronization for a particular zone, a corresponding module
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 must support this feature.
2230 283b1e67eaa6 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2151 diff changeset	23 Currently, it is possible to synchronize HTTP
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 <link doc="../http/ngx_http_upstream_module.xml" id="sticky">sticky</link>
2230 283b1e67eaa6 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2151 diff changeset	25 sessions, information about
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2151 diff changeset	26 <link doc="../http/ngx_http_limit_req_module.xml">excessive HTTP requests</link>,
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2151 diff changeset	27 and key-value pairs both in
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2151 diff changeset	28 <link doc="../http/ngx_http_keyval_module.xml">http</link>
283b1e67eaa6 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2151 diff changeset	29 and <link doc="../stream/ngx_stream_keyval_module.xml">stream</link>.
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 </para>
2145 5a31c6b83cbc Corrected appeared-in version for the zone_sync module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	31
5a31c6b83cbc Corrected appeared-in version for the zone_sync module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	32 <para>
5a31c6b83cbc Corrected appeared-in version for the zone_sync module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	33 <note>
5a31c6b83cbc Corrected appeared-in version for the zone_sync module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	34 This module is available as part of our
5a31c6b83cbc Corrected appeared-in version for the zone_sync module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	35 <commercial_version>commercial subscription</commercial_version>.
5a31c6b83cbc Corrected appeared-in version for the zone_sync module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	36 </note>
5a31c6b83cbc Corrected appeared-in version for the zone_sync module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	37 </para>
5a31c6b83cbc Corrected appeared-in version for the zone_sync module. Yaroslav Zhuravlev <yar@nginx.com> parents: 2142 diff changeset	38
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 </section>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 <section id="example" name="Example Configuration">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 Minimal configuration:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 <example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47 http {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 ...
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50 upstream backend {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 server backend1.example.com:8080;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52 server backend2.example.com:8081;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54 sticky learn
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 create=$upstream_cookie_examplecookie
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 lookup=$cookie_examplecookie
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 zone=client_sessions:1m <emphasis>sync</emphasis>;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	60 ...
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	61 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63 stream {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 ...
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	67 server {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 zone_sync;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69
2377 2313c14d93b5 Added obligatory port to zone_sync_server examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2373 diff changeset	70 listen 127.0.0.1:12345;
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71
2151 ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	72 # cluster of 2 nodes
2377 2313c14d93b5 Added obligatory port to zone_sync_server examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2373 diff changeset	73 zone_sync_server a.example.com:12345;
2313c14d93b5 Added obligatory port to zone_sync_server examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2373 diff changeset	74 zone_sync_server b.example.com:12345;
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 </example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 A more complex configuration with SSL enabled
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 and with cluster members defined by DNS:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 <example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 ...
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 stream {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 ...
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 resolver 127.0.0.1 valid=10s;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 server {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89 zone_sync;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 # the name resolves to multiple addresses that correspond to cluster nodes
2377 2313c14d93b5 Added obligatory port to zone_sync_server examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2373 diff changeset	92 zone_sync_server cluster.example.com:12345 resolve;
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 listen 127.0.0.1:4433 ssl;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 ssl_certificate localhost.crt;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	97 ssl_certificate_key localhost.key;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99 zone_sync_ssl on;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 zone_sync_ssl_certificate localhost.crt;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 zone_sync_ssl_certificate_key localhost.key;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 </example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 </section>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111 <section id="directives" name="Directives">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 <directive name="zone_sync">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 <syntax></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 <default></default>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 Enables the synchronization of shared memory zones between cluster nodes.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 Cluster nodes are defined using <link id="zone_sync_server"/> directives.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	125
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	126 <directive name="zone_sync_buffers">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	127 <syntax><value>number</value> <value>size</value></syntax>
2370 075d88b3749b Fixed the "zone_sync_buffers" directive default value. Vladimir Homutov <vl@nginx.com> parents: 2304 diff changeset	128 <default>8 4k\|8k</default>
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	129 <context>stream</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	130 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	131
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	132 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	133 Sets the <value>number</value> and <value>size</value> of the
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	134 per-zone buffers used for pushing zone contents.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	135 By default, the buffer size is equal to one memory page.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	136 This is either 4K or 8K, depending on a platform.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	137 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	138
2372 d25d7ec9147e Added note about selecting the "zone_sync_buffers" directive value. Vladimir Homutov <vl@nginx.com> parents: 2370 diff changeset	139 <para>
d25d7ec9147e Added note about selecting the "zone_sync_buffers" directive value. Vladimir Homutov <vl@nginx.com> parents: 2370 diff changeset	140 <note>
d25d7ec9147e Added note about selecting the "zone_sync_buffers" directive value. Vladimir Homutov <vl@nginx.com> parents: 2370 diff changeset	141 A single buffer must be large enough to hold any entry of each zone being
d25d7ec9147e Added note about selecting the "zone_sync_buffers" directive value. Vladimir Homutov <vl@nginx.com> parents: 2370 diff changeset	142 synchronized.
d25d7ec9147e Added note about selecting the "zone_sync_buffers" directive value. Vladimir Homutov <vl@nginx.com> parents: 2370 diff changeset	143 </note>
d25d7ec9147e Added note about selecting the "zone_sync_buffers" directive value. Vladimir Homutov <vl@nginx.com> parents: 2370 diff changeset	144 </para>
d25d7ec9147e Added note about selecting the "zone_sync_buffers" directive value. Vladimir Homutov <vl@nginx.com> parents: 2370 diff changeset	145
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	146 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	147
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	148
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	149 <directive name="zone_sync_connect_retry_interval">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	150 <syntax><value>time</value></syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	151 <default>1s</default>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	152 <context>stream</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	153 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	154
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	155 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	156 Defines an interval between connection attempts to another cluster node.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	157 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	158
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	159 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	160
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	161
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	162 <directive name="zone_sync_connect_timeout">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	163 <syntax><value>time</value></syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	164 <default>5s</default>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	165 <context>stream</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	166 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	167
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	168 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	169 Defines a timeout for establishing a connection with another cluster node.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	170 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	171
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	172 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	173
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	174
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	175 <directive name="zone_sync_interval">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	176 <syntax><value>time</value></syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	177 <default>1s</default>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	178 <context>stream</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	179 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	180
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	181 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	182 Defines an interval for polling updates in a shared memory zone.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	183 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	184
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	185 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	186
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	187
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	188 <directive name="zone_sync_recv_buffer_size">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	189 <syntax><value>size</value></syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	190 <default>4k\|8k</default>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	191 <context>stream</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	192 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	193
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	194 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	195 Sets <value>size</value> of a per-connection receive buffer used to parse
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	196 incoming stream of synchronization messages.
2373 bb4c75bec3f7 Updated the "zone_sync_recv_buffer_size" directive description. Vladimir Homutov <vl@nginx.com> parents: 2372 diff changeset	197 The buffer size must be equal or greater than one of the
bb4c75bec3f7 Updated the "zone_sync_recv_buffer_size" directive description. Vladimir Homutov <vl@nginx.com> parents: 2372 diff changeset	198 <link id="zone_sync_buffers"/>.
bb4c75bec3f7 Updated the "zone_sync_recv_buffer_size" directive description. Vladimir Homutov <vl@nginx.com> parents: 2372 diff changeset	199 By default, the buffer size is equal to
bb4c75bec3f7 Updated the "zone_sync_recv_buffer_size" directive description. Vladimir Homutov <vl@nginx.com> parents: 2372 diff changeset	200 <link id="zone_sync_buffers">zone_sync_buffers</link> <value>size</value>
bb4c75bec3f7 Updated the "zone_sync_recv_buffer_size" directive description. Vladimir Homutov <vl@nginx.com> parents: 2372 diff changeset	201 multiplied by <value>number</value>.
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	202 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	203
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	204 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	205
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	206
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 <directive name="zone_sync_server">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 <syntax><value>address</value> [<literal>resolve</literal>]</syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209 <default></default>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212 <para>
2151 ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	213 Defines the <value>address</value> of a cluster node.
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214 The address can be specified as a domain name or IP address
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215 with a mandatory port, or as a UNIX-domain socket path
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216 specified after the “<literal>unix:</literal>” prefix.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217 A domain name that resolves to several IP addresses defines
2151 ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	218 multiple nodes at once.
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220
2304 f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	221 <para id="resolve">
2151 ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	222 The <literal>resolve</literal> parameter instructs nginx to monitor
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	223 changes of the IP addresses that correspond to a domain name of the node
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	224 and automatically modify the configuration
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225 without the need of restarting nginx.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	228 <para>
2151 ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	229 Cluster nodes are specified either dynamically as a single
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	230 <literal>zone_sync_server</literal> directive with
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	231 the <literal>resolve</literal> parameter, or statically as a series of several
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	232 directives without the parameter.
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	233 <note>
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	234 Each cluster node should be specified only once.
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	235 </note>
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	236 <note>
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	237 All cluster nodes should use the same configuration.
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	238 </note>
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	239 </para>
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	240
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	241 <para>
ed6b44206600 Clarified the "zone_sync_server" directive description. Vladimir Homutov <vl@nginx.com> parents: 2145 diff changeset	242 In order for the <literal>resolve</literal> parameter to work,
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 the <link doc="ngx_stream_core_module.xml" id="resolver"/> directive
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 must be specified in the
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 <link doc="ngx_stream_core_module.xml" id="stream"/> block.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 Example:
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 <example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248 stream {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249 resolver 10.0.0.1;
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 server {
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	252 zone_sync;
2377 2313c14d93b5 Added obligatory port to zone_sync_server examples. Yaroslav Zhuravlev <yar@nginx.com> parents: 2373 diff changeset	253 zone_sync_server cluster.example.com:12345 resolve;
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254 ...
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256 }
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	257 </example>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 <directive name="zone_sync_ssl">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 <default>off</default>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 Enables the SSL/TLS protocol for connections to another cluster server.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	276 <directive name="zone_sync_ssl_certificate">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 <syntax><value>file</value></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 <default/>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 Specifies a <value>file</value> with the certificate in the PEM format
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 used for authentication to another cluster server.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 <directive name="zone_sync_ssl_certificate_key">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291 <syntax><value>file</value></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 <default/>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297 Specifies a <value>file</value> with the secret key in the PEM format
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298 used for authentication to another cluster server.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	302
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 <directive name="zone_sync_ssl_ciphers">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 <syntax><value>ciphers</value></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 <default>DEFAULT</default>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311 Specifies the enabled ciphers for connections to another cluster server.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 The ciphers are specified in the format understood by the OpenSSL library.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316 The full list can be viewed using the
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 “<command>openssl ciphers</command>” command.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	319
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322
2632 52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	323 <directive name="zone_sync_ssl_conf_command">
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	324 <syntax><value>command</value></syntax>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	325 <default/>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	326 <context>stream</context>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	327 <context>server</context>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	328 <appeared-in>1.19.4</appeared-in>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	329
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	330 <para>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	331 Sets arbitrary OpenSSL configuration
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	332 <link url="https://www.openssl.org/docs/man1.1.1/man3/SSL_CONF_cmd.html">commands</link>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	333 when establishing a connection with another cluster server.
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	334 <note>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	335 The directive is supported when using OpenSSL 1.0.2 or higher.
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	336 </note>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	337 </para>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	338
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	339 <para>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	340 Several <literal>zone_sync_ssl_conf_command</literal> directives
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	341 can be specified on the same level.
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	342 These directives are inherited from the previous configuration level
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	343 if and only if there are
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	344 no <literal>zone_sync_ssl_conf_command</literal> directives
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	345 defined on the current level.
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	346 </para>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	347
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	348 <para>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	349 <note>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	350 Note that configuring OpenSSL directly
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	351 might result in unexpected behavior.
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	352 </note>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	353 </para>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	354
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	355 </directive>
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	356
52500ccb82c1 Updated docs for the upcoming NGINX Plus release. Yaroslav Zhuravlev <yar@nginx.com> parents: 2377 diff changeset	357
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358 <directive name="zone_sync_ssl_crl">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 <syntax><value>file</value></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360 <default/>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	362 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	363
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	364 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365 Specifies a <value>file</value> with revoked certificates (CRL)
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	366 in the PEM format used to <link id="zone_sync_ssl_verify">verify</link>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367 the certificate of another cluster server.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372
2304 f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	373 <directive name="zone_sync_ssl_name">
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	374 <syntax><value>name</value></syntax>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	375 <default>host from zone_sync_server</default>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	376 <context>stream</context>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	377 <context>server</context>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	378 <appeared-in>1.15.7</appeared-in>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	379
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	380 <para>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	381 Allows overriding the server name used to
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	382 <link id="zone_sync_ssl_verify">verify</link>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	383 the certificate of a cluster server and to be
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	384 <link id="zone_sync_ssl_server_name">passed through SNI</link>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	385 when establishing a connection with the cluster server.
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	386 </para>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	387
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	388 <para>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	389 By default, the host part of the <link id="zone_sync_server"/> address is used,
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	390 or resolved IP address if the <link id="resolve"/> parameter is specified.
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	391 </para>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	392
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	393 </directive>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	394
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	395
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	396 <directive name="zone_sync_ssl_password_file">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	397 <syntax><value>file</value></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	398 <default/>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	399 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	400 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	401
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	402 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	403 Specifies a <value>file</value> with passphrases for
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	404 <link id="zone_sync_ssl_certificate_key">secret keys</link>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405 where each passphrase is specified on a separate line.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	406 Passphrases are tried in turn when loading the key.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	407 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	408
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	409 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	410
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412 <directive name="zone_sync_ssl_protocols">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413 <syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414 [<literal>SSLv2</literal>]
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	415 [<literal>SSLv3</literal>]
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	416 [<literal>TLSv1</literal>]
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	417 [<literal>TLSv1.1</literal>]
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	418 [<literal>TLSv1.2</literal>]
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419 [<literal>TLSv1.3</literal>]</syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	420 <default>TLSv1 TLSv1.1 TLSv1.2</default>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	421 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	422 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425 Enables the specified protocols for connections to another cluster server.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	427
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	428 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	429
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	430
2304 f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	431 <directive name="zone_sync_ssl_server_name">
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	432 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	433 <default>off</default>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	434 <context>stream</context>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	435 <context>server</context>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	436 <appeared-in>1.15.7</appeared-in>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	437
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	438 <para>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	439 Enables or disables passing of the server name through
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	440 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">TLS
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	441 Server Name Indication extension</link> (SNI, RFC 6066)
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	442 when establishing a connection with another cluster server.
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	443 </para>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	444
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	445 </directive>
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	446
f4b9660316c5 Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: 2230 diff changeset	447
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	448 <directive name="zone_sync_ssl_trusted_certificate">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	449 <syntax><value>file</value></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450 <default/>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	453
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	454 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	455 Specifies a <value>file</value> with trusted CA certificates in the PEM format
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	456 used to <link id="zone_sync_ssl_verify">verify</link>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 the certificate of another cluster server.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	461
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	462
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	463 <directive name="zone_sync_ssl_verify">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	465 <default>off</default>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	467 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	468
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	469 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	470 Enables or disables verification of another cluster server certificate.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	471 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	473 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	474
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	475
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 <directive name="zone_sync_ssl_verify_depth">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477 <syntax><value>number</value></syntax>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	478 <default>1</default>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	479 <context>stream</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	480 <context>server</context>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	481
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	482 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	483 Sets the verification depth in another cluster server certificates chain.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	484 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	485
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	486 </directive>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	487
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	488
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	489 <directive name="zone_sync_timeout">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	490 <syntax><value>timeout</value></syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	491 <default>5s</default>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	492 <context>stream</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	493 <context>server</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	494
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	495 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	496 Sets the <value>timeout</value> between two successive
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	497 read or write operations on connection to another cluster node.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	498 If no data is transmitted within this time, the connection is closed.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	499 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	500
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	501 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2140 diff changeset	502
2139 f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	503 </section>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	504
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	505
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	506 <section id="stream_zone_sync_status" name="API endpoints">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	507 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	508 The synchronization status of a node is available via the
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	509 <link doc= "../http/ngx_http_api_module.xml" id="stream_zone_sync_">/stream/zone_sync/</link>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	510 endpoint of the API which returns the
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	511 <link doc= "../http/ngx_http_api_module.xml" id="def_nginx_stream_zone_sync">following</link>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	512 metrics.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	513 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	514
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	515 </section>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	516
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	517
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	518 <section id="controlling_cluster_node" name="Starting, stopping, removing a cluster node">
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	519 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	520 To start a new node, update a DNS record of a cluster hostname
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	521 with the IP address of the new node and start an instance.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	522 The new node will discover other nodes from DNS or static configuration
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	523 and will start sending updates to them.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	524 Other nodes will eventually discover the new node using DNS and
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	525 start pushing updates to it.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	526 In case of static configuration,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	527 other nodes need to be reloaded in order to send updates to the new node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	528 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	529
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	530 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	531 To stop a node, send the <literal>QUIT</literal> signal to the instance.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	532 The node will finish zone synchronization
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	533 and gracefully close open connections.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	534 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	535
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	536 <para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	537 To remove a node, update a DNS record of a cluster hostname
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	538 and remove the IP address of the node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	539 All other nodes will eventually discover that the node is removed,
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	540 close connections to the node, and will no longer try to connect to it.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	541 After the node is removed, it can be stopped as described above.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	542 In case of static configuration, other nodes need to be reloaded
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	543 in order to stop sending updates to the removed node.
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	544 </para>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	545
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	546 </section>
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	547
f6e578b1b02d Updated docs for the upcoming NGINX Plus release. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	548 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/stream/ngx_stream_zone_sync_module.xml @ 2769:16f6fa718be2