summaryrefslogtreecommitdiff
path: root/pod/nginx/ngx_http_proxy_protocol_vendor_module.pod
blob: f4d8f71af7685aee4bf1c5ba56920ccda46bec8d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
=encoding utf-8

=head1 NAME

ngx_http_proxy_protocol_vendor_module - Module ngx_http_proxy_protocol_vendor_module




=head1



The C<ngx_http_proxy_protocol_vendor_module> module (1.23.3)
allows obtaining additional information about a connection in
cloud platforms from application-specific TLVs of the
L<PROXY
protocol|http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt>
header.





Supported cloud platforms:

=over




=item *

Amazon Web Services



=item *

Google Cloud Platform



=item *

Microsoft Azure



=back







The PROXY protocol must be previously enabled by setting the
C<proxy_protocol> parameter
in the L<ngx_http_core_module> directive.






B<NOTE>

This module is available as part of our
commercial subscription.





=head1 Example Configuration




    
    proxy_set_header X-Conn-ID $proxy_protocol_tlv_gcp_conn_id;
    
    server {
        listen 80   proxy_protocol;
        listen 443  ssl proxy_protocol;
        ...
    }






=head1 Embedded Variables




=over



=item C<$proxy_protocol_tlv_aws_vpce_id>




TLV value from the PROXY Protocol header representing the
L<ID
of AWS VPC endpoint|https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#proxy-protocol>



=item C<$proxy_protocol_tlv_azure_pel_id>




TLV value from the PROXY Protocol header representing the
L<LinkID
of Azure private endpoint|https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview#getting-connection-information-using-tcp-proxy-v2>



=item C<$proxy_protocol_tlv_gcp_conn_id>




TLV value from the PROXY Protocol header representing
L<Google Cloud PSC
connection ID|https://cloud.google.com/vpc/docs/configure-private-service-connect-producer#proxy-protocol>




=back