Mercurial > hg > nginx-site

changeset 2915:923977f02d39

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 29 Nov 2022 11:48:55 +0000
parents 3a2d342533fb
children 178f55cf631a
files xml/en/docs/http/ngx_http_proxy_protocol_vendor_module.xml xml/en/docs/stream/ngx_stream_proxy_protocol_vendor_module.xml xml/ru/docs/http/ngx_http_proxy_protocol_vendor_module.xml xml/ru/docs/stream/ngx_stream_proxy_protocol_vendor_module.xml
diffstat 4 files changed, 426 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/xml/en/docs/http/ngx_http_proxy_protocol_vendor_module.xml
@@ -0,0 +1,108 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
+
+<module name="Module ngx_http_proxy_protocol_vendor_module"
+        link="/en/docs/http/ngx_http_proxy_protocol_vendor_module.html"
+        lang="en"
+        rev="1">
+
+<section id="summary">
+
+<para>
+The <literal>ngx_http_proxy_protocol_vendor_module</literal> module (1.23.3)
+allows obtaining additional information about a connection in
+cloud platforms from application-specific TLVs of the
+<link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">PROXY
+protocol</link>
+header.
+</para>
+
+<para>
+Supported cloud platforms:
+<list type="bullet">
+
+<listitem>
+Amazon Web Services
+</listitem>
+
+<listitem>
+Google Cloud Platform
+</listitem>
+
+<listitem>
+Microsoft Azure
+</listitem>
+
+</list>
+</para>
+
+<para>
+The PROXY protocol must be previously enabled by setting the
+<literal>proxy_protocol</literal> parameter
+in the <link doc="ngx_http_core_module.xml" id="listen"/> directive.
+</para>
+
+<para>
+<note>
+This module is available as part of our
+<commercial_version>commercial subscription</commercial_version>.
+</note>
+</para>
+
+</section>
+
+
+<section id="example" name="Example Configuration">
+
+<para>
+<example>
+proxy_set_header X-Conn-ID $proxy_protocol_tlv_gcp_conn_id;
+
+server {
+    listen 80   proxy_protocol;
+    listen 443  ssl proxy_protocol;
+    ...
+}
+</example>
+</para>
+
+</section>
+
+
+<section id="variables" name="Embedded Variables">
+
+<para>
+<list type="tag">
+
+<tag-name id="var_proxy_protocol_tlv_aws_vpce_id"><var>$proxy_protocol_tlv_aws_vpce_id</var></tag-name>
+<tag-desc>
+TLV value from the PROXY Protocol header representing the
+<link url="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#proxy-protocol">ID
+of AWS VPC endpoint</link>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_tlv_azure_pel_id"><var>$proxy_protocol_tlv_azure_pel_id</var></tag-name>
+<tag-desc>
+TLV value from the PROXY Protocol header representing the
+<link url="https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview#getting-connection-information-using-tcp-proxy-v2">LinkID
+of Azure private endpoint</link>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_tlv_gcp_conn_id"><var>$proxy_protocol_tlv_gcp_conn_id</var></tag-name>
+<tag-desc>
+TLV value from the PROXY Protocol header representing
+<link url="https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#proxy-protocol">Google Cloud PSC
+connection ID</link>
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+</module>
new file mode 100644
--- /dev/null
+++ b/xml/en/docs/stream/ngx_stream_proxy_protocol_vendor_module.xml
@@ -0,0 +1,105 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
+
+<module name="Module ngx_stream_proxy_protocol_vendor_module"
+        link="/en/docs/stream/ngx_stream_proxy_protocol_vendor_module.html"
+        lang="en"
+        rev="1">
+
+<section id="summary">
+
+<para>
+The <literal>ngx_stream_proxy_protocol_vendor_module</literal> module (1.23.3)
+allows obtaining additional information about a connection in
+cloud platforms from application-specific TLVs of the
+<link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">PROXY
+protocol</link>
+header.
+</para>
+
+<para>
+Supported cloud platforms:
+<list type="bullet">
+
+<listitem>
+Amazon Web Services
+</listitem>
+
+<listitem>
+Google Cloud Platform
+</listitem>
+
+<listitem>
+Microsoft Azure
+</listitem>
+
+</list>
+</para>
+
+<para>
+The PROXY protocol must be previously enabled by setting the
+<literal>proxy_protocol</literal> parameter
+in the <link doc="ngx_stream_core_module.xml" id="listen"/> directive.
+</para>
+
+<para>
+<note>
+This module is available as part of our
+<commercial_version>commercial subscription</commercial_version>.
+</note>
+</para>
+
+</section>
+
+
+<section id="example" name="Example Configuration">
+
+<para>
+<example>
+server {
+    listen 12345 proxy_protocol;
+    return $proxy_protocol_tlv_gcp_conn_id;
+}
+</example>
+</para>
+
+</section>
+
+
+<section id="variables" name="Embedded Variables">
+
+<para>
+<list type="tag">
+
+<tag-name id="var_proxy_protocol_tlv_aws_vpce_id"><var>$proxy_protocol_tlv_aws_vpce_id</var></tag-name>
+<tag-desc>
+TLV value from the PROXY Protocol header representing the
+<link url="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#proxy-protocol">ID
+of AWS VPC endpoint</link>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_tlv_azure_pel_id"><var>$proxy_protocol_tlv_azure_pel_id</var></tag-name>
+<tag-desc>
+TLV value from the PROXY Protocol header representing the
+<link url="https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview#getting-connection-information-using-tcp-proxy-v2">LinkID
+of Azure private endpoint</link>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_tlv_gcp_conn_id"><var>$proxy_protocol_tlv_gcp_conn_id</var></tag-name>
+<tag-desc>
+TLV value from the PROXY Protocol header representing
+<link url="https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#proxy-protocol">Google Cloud PSC
+connection ID</link>
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+</module>
new file mode 100644
--- /dev/null
+++ b/xml/ru/docs/http/ngx_http_proxy_protocol_vendor_module.xml
@@ -0,0 +1,108 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
+
+<module name="Модуль ngx_http_proxy_protocol_vendor_module"
+        link="/ru/docs/http/ngx_http_proxy_protocol_vendor_module.html"
+        lang="ru"
+        rev="1">
+
+<section id="summary">
+
+<para>
+Модуль <literal>ngx_http_proxy_protocol_vendor_module</literal> (1.23.3)
+позволяет получать дополнительную информацию о соединении из
+облачных платформ при помощи TLV, полученных из
+заголовка
+<link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">протокола
+PROXY</link>.
+</para>
+
+<para>
+Поддерживаемые облачные платформы:
+<list type="bullet">
+
+<listitem>
+Amazon Web Services
+</listitem>
+
+<listitem>
+Google Cloud Platform
+</listitem>
+
+<listitem>
+Microsoft Azure
+</listitem>
+
+</list>
+</para>
+
+<para>
+Протокол PROXY должен быть предварительно включён при помощи установки
+параметра <literal>proxy_protocol</literal> в директиве
+<link doc="ngx_http_core_module.xml" id="listen"/>.
+</para>
+
+<para>
+<note>
+Модуль доступен как часть
+<commercial_version>коммерческой подписки</commercial_version>
+</note>
+</para>
+
+</section>
+
+
+<section id="example" name="Пример конфигурации">
+
+<para>
+<example>
+proxy_set_header X-Conn-ID $proxy_protocol_tlv_gcp_conn_id;
+
+server {
+    listen 80   proxy_protocol;
+    listen 443  ssl proxy_protocol;
+    ...
+}
+</example>
+</para>
+
+</section>
+
+
+<section id="variables" name="Встроенные переменные">
+
+<para>
+<list type="tag">
+
+<tag-name id="var_proxy_protocol_tlv_aws_vpce_id"><var>$proxy_protocol_tlv_aws_vpce_id</var></tag-name>
+<tag-desc>
+значение TLV, полученное из заголовка протокола PROXY, содержащее
+<link url="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#proxy-protocol">ID
+конечной точки VPC AWS</link>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_tlv_azure_pel_id"><var>$proxy_protocol_tlv_azure_pel_id</var></tag-name>
+<tag-desc>
+значение TLV, полученное из заголовка протокола PROXY, содержащее
+<link url="https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview#getting-connection-information-using-tcp-proxy-v2">LinkID
+частной конечной точки Azure</link>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_tlv_gcp_conn_id"><var>$proxy_protocol_tlv_gcp_conn_id</var></tag-name>
+<tag-desc>
+значение TLV, полученное из заголовка протокола PROXY, содержащее
+<link url="https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#proxy-protocol">ID соединения
+Google Cloud PSC</link>
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+</module>
new file mode 100644
--- /dev/null
+++ b/xml/ru/docs/stream/ngx_stream_proxy_protocol_vendor_module.xml
@@ -0,0 +1,105 @@
+<?xml version="1.0"?>
+
+<!--
+  Copyright (C) Nginx, Inc.
+  -->
+
+<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
+
+<module name="Модуль ngx_stream_proxy_protocol_vendor_module"
+        link="/ru/docs/stream/ngx_stream_proxy_protocol_vendor_module.html"
+        lang="ru"
+        rev="1">
+
+<section id="summary">
+
+<para>
+Модуль <literal>ngx_stream_proxy_protocol_vendor_module</literal> (1.23.3)
+позволяет получать дополнительную информацию о соединении из
+облачных платформ при помощи TLV, полученных из
+заголовка
+<link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">протокола
+PROXY</link>.
+</para>
+
+<para>
+Поддерживаемые облачные платформы:
+<list type="bullet">
+
+<listitem>
+Amazon Web Services
+</listitem>
+
+<listitem>
+Google Cloud Platform
+</listitem>
+
+<listitem>
+Microsoft Azure
+</listitem>
+
+</list>
+</para>
+
+<para>
+Протокол PROXY должен быть предварительно включён при помощи установки
+параметра <literal>proxy_protocol</literal> в директиве
+<link doc="ngx_stream_core_module.xml" id="listen"/>.
+</para>
+
+<para>
+<note>
+Модуль доступен как часть
+<commercial_version>коммерческой подписки</commercial_version>
+</note>
+</para>
+
+</section>
+
+
+<section id="example" name="Пример конфигурации">
+
+<para>
+<example>
+server {
+    listen 12345 proxy_protocol;
+    return $proxy_protocol_tlv_gcp_conn_id;
+}
+</example>
+</para>
+
+</section>
+
+
+<section id="variables" name="Встроенные переменные">
+
+<para>
+<list type="tag">
+
+<tag-name id="var_proxy_protocol_tlv_aws_vpce_id"><var>$proxy_protocol_tlv_aws_vpce_id</var></tag-name>
+<tag-desc>
+значение TLV, полученное из заголовка протокола PROXY, содержащее
+<link url="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#proxy-protocol">ID
+конечной точки VPC AWS</link>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_tlv_azure_pel_id"><var>$proxy_protocol_tlv_azure_pel_id</var></tag-name>
+<tag-desc>
+значение TLV, полученное из заголовка протокола PROXY, содержащее
+<link url="https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview#getting-connection-information-using-tcp-proxy-v2">LinkID
+частной конечной точки Azure</link>
+</tag-desc>
+
+<tag-name id="var_proxy_protocol_tlv_gcp_conn_id"><var>$proxy_protocol_tlv_gcp_conn_id</var></tag-name>
+<tag-desc>
+значение TLV, полученное из заголовка протокола PROXY, содержащее
+<link url="https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#proxy-protocol">ID соединения
+Google Cloud PSC</link>
+</tag-desc>
+
+</list>
+</para>
+
+</section>
+
+</module>