comparison xml/en/docs/http/ngx_http_upstream_module.xml @ 2469:98fd810c13e0

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 02 Dec 2019 13:23:05 +0300
parents a26a42699207
children 504536999408
comparison
equal deleted inserted replaced
2468:409e1f755037 2469:98fd810c13e0
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_upstream_module" 10 <module name="Module ngx_http_upstream_module"
11 link="/en/docs/http/ngx_http_upstream_module.html" 11 link="/en/docs/http/ngx_http_upstream_module.html"
12 lang="en" 12 lang="en"
13 rev="82"> 13 rev="83">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_upstream_module</literal> module 18 The <literal>ngx_http_upstream_module</literal> module
876 <link id="var_upstream_header_time">response header</link> is used. 876 <link id="var_upstream_header_time">response header</link> is used.
877 If <literal>least_time=last_byte</literal> is specified, the time to receive the 877 If <literal>least_time=last_byte</literal> is specified, the time to receive the
878 <link id="var_upstream_response_time">full response</link> is used. 878 <link id="var_upstream_response_time">full response</link> is used.
879 <note> 879 <note>
880 The <literal>least_time</literal> method is available as a part of our 880 The <literal>least_time</literal> method is available as a part of our
881 <commercial_version>commercial subscription</commercial_version>.
882 </note>
883 </para>
884
885 </directive>
886
887
888 <directive name="resolver">
889 <syntax>
890 <value>address</value> ...
891 [<literal>valid</literal>=<value>time</value>]
892 [<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]
893 [<literal>status_zone</literal>=<value>zone</value>]</syntax>
894 <default/>
895 <context>upstream</context>
896 <appeared-in>1.17.5</appeared-in>
897
898 <para>
899 Configures name servers used to resolve names of upstream servers
900 into addresses, for example:
901 <example>
902 resolver 127.0.0.1 [::1]:5353;
903 </example>
904 The address can be specified as a domain name or IP address,
905 with an optional port.
906 If port is not specified, the port 53 is used.
907 Name servers are queried in a round-robin fashion.
908 </para>
909
910 <para id="resolver_ipv6">
911 By default, nginx will look up both IPv4 and IPv6 addresses while resolving.
912 If looking up of IPv6 addresses is not desired,
913 the <literal>ipv6=off</literal> parameter can be specified.
914 </para>
915
916 <para id="resolver_valid">
917 By default, nginx caches answers using the TTL value of a response.
918 An optional <literal>valid</literal> parameter allows overriding it:
919 <example>
920 resolver 127.0.0.1 [::1]:5353 valid=30s;
921 </example>
922 <note>
923 To prevent DNS spoofing, it is recommended
924 configuring DNS servers in a properly secured trusted local network.
925 </note>
926 </para>
927
928 <para id="resolver_status_zone">
929 The optional <literal>status_zone</literal> parameter
930 enables
931 <link doc="ngx_http_api_module.xml" id="resolvers_">collection</link>
932 of DNS server statistics of requests and responses
933 in the specified <value>zone</value>.
934 </para>
935
936 <para>
937 <note>
938 This directive is available as part of our
939 <commercial_version>commercial subscription</commercial_version>.
940 </note>
941 </para>
942
943 </directive>
944
945
946 <directive name="resolver_timeout">
947 <syntax><value>time</value></syntax>
948 <default>30s</default>
949 <context>upstream</context>
950 <appeared-in>1.17.5</appeared-in>
951
952 <para>
953 Sets a timeout for name resolution, for example:
954 <example>
955 resolver_timeout 5s;
956 </example>
957 </para>
958
959 <para>
960 <note>
961 This directive is available as part of our
881 <commercial_version>commercial subscription</commercial_version>. 962 <commercial_version>commercial subscription</commercial_version>.
882 </note> 963 </note>
883 </para> 964 </para>
884 965
885 </directive> 966 </directive>