diff xml/en/docs/stream/ngx_stream_proxy_module.xml @ 2359:d5e576eb7677

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 08 Apr 2019 11:45:08 +0300
parents f047bd9403d5
children e58281e2a93f
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_proxy_module.xml
+++ b/xml/en/docs/stream/ngx_stream_proxy_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_proxy_module"
         link="/en/docs/stream/ngx_stream_proxy_module.html"
         lang="en"
-        rev="22">
+        rev="23">
 
 <section id="summary">
 
@@ -296,6 +296,40 @@ session is still not finished, the respo
 </directive>
 
 
+<directive name="proxy_session_drop">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.15.8</appeared-in>
+
+<para>
+Enables terminating all sessions to a proxied server
+after it was removed from the group or marked as permanently unavailable.
+This can occur because of
+<link doc="ngx_stream_core_module.xml" id="resolver">re-resolve</link>
+or with the API
+<link doc="../http/ngx_http_api_module.xml" id="deleteStreamUpstreamServer"><literal>DELETE</literal></link>
+command.
+A server can be marked as permanently unavailable if it is considered
+<link doc="ngx_stream_upstream_hc_module.xml" id="health_check">unhealthy</link>
+or with the API
+<link doc="../http/ngx_http_api_module.xml" id="patchStreamUpstreamServer"><literal>PATCH</literal></link>
+command.
+Each session is terminated when the next
+read or write event is processed for the client or proxied server.
+</para>
+
+<para>
+<note>
+This directive is available as part of our
+<commercial_version>commercial subscription</commercial_version>.
+</note>
+</para>
+
+</directive>
+
+
 <directive name="proxy_socket_keepalive">
 <syntax><literal>on</literal> | <literal>off</literal></syntax>
 <default>off</default>