Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_proxy_protocol_vendor_module.xml @ 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
children
comparison
equal deleted inserted replaced
2914:3a2d342533fb 2915:923977f02d39
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8
9 <module name="Module ngx_stream_proxy_protocol_vendor_module"
10 link="/en/docs/stream/ngx_stream_proxy_protocol_vendor_module.html"
11 lang="en"
12 rev="1">
13
14 <section id="summary">
15
16 <para>
17 The <literal>ngx_stream_proxy_protocol_vendor_module</literal> module (1.23.3)
18 allows obtaining additional information about a connection in
19 cloud platforms from application-specific TLVs of the
20 <link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">PROXY
21 protocol</link>
22 header.
23 </para>
24
25 <para>
26 Supported cloud platforms:
27 <list type="bullet">
28
29 <listitem>
30 Amazon Web Services
31 </listitem>
32
33 <listitem>
34 Google Cloud Platform
35 </listitem>
36
37 <listitem>
38 Microsoft Azure
39 </listitem>
40
41 </list>
42 </para>
43
44 <para>
45 The PROXY protocol must be previously enabled by setting the
46 <literal>proxy_protocol</literal> parameter
47 in the <link doc="ngx_stream_core_module.xml" id="listen"/> directive.
48 </para>
49
50 <para>
51 <note>
52 This module is available as part of our
53 <commercial_version>commercial subscription</commercial_version>.
54 </note>
55 </para>
56
57 </section>
58
59
60 <section id="example" name="Example Configuration">
61
62 <para>
63 <example>
64 server {
65 listen 12345 proxy_protocol;
66 return $proxy_protocol_tlv_gcp_conn_id;
67 }
68 </example>
69 </para>
70
71 </section>
72
73
74 <section id="variables" name="Embedded Variables">
75
76 <para>
77 <list type="tag">
78
79 <tag-name id="var_proxy_protocol_tlv_aws_vpce_id"><var>$proxy_protocol_tlv_aws_vpce_id</var></tag-name>
80 <tag-desc>
81 TLV value from the PROXY Protocol header representing the
82 <link url="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#proxy-protocol">ID
83 of AWS VPC endpoint</link>
84 </tag-desc>
85
86 <tag-name id="var_proxy_protocol_tlv_azure_pel_id"><var>$proxy_protocol_tlv_azure_pel_id</var></tag-name>
87 <tag-desc>
88 TLV value from the PROXY Protocol header representing the
89 <link url="https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview#getting-connection-information-using-tcp-proxy-v2">LinkID
90 of Azure private endpoint</link>
91 </tag-desc>
92
93 <tag-name id="var_proxy_protocol_tlv_gcp_conn_id"><var>$proxy_protocol_tlv_gcp_conn_id</var></tag-name>
94 <tag-desc>
95 TLV value from the PROXY Protocol header representing
96 <link url="https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#proxy-protocol">Google Cloud PSC
97 connection ID</link>
98 </tag-desc>
99
100 </list>
101 </para>
102
103 </section>
104
105 </module>