DevFW-CICD/ingress-nginx-helm
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Deploy GitHub Pages

Browse source
This commit is contained in:
Travis Bot 2019-05-26 08:06:36 +00:00
parent c2332fe720
commit d680fbc4ae
52 changed files with 2554 additions and 116 deletions
Download patch file Download diff file Expand all files Collapse all files

12
user-guide/basic-usage/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

28
user-guide/cli-arguments/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade
@ -1288,6 +1300,22 @@
<td><code class="codehilite">--watch-namespace string</code></td>
<td>Namespace the controller watches for updates to Kubernetes objects. This includes Ingresses, Services and all configuration resources. All namespaces are watched if this parameter is left empty.</td>
</tr>
<tr>
<td><code class="codehilite">--disable-catch-all</code></td>
<td>Disable support for catch-all Ingresses.</td>
</tr>
<tr>
<td><code class="codehilite">--validating-webhook</code></td>
<td>The address to start an admission controller on</td>
</tr>
<tr>
<td><code class="codehilite">--validating-webhook-certificate</code></td>
<td>The certificate the webhook is using for its TLS handling</td>
</tr>
<tr>
<td><code class="codehilite">--validating-webhook-key</code></td>
<td>The key the webhook is using for its TLS handling</td>
</tr>
</tbody>
</table>

12
user-guide/custom-errors/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

12
user-guide/default-backend/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

12
user-guide/exposing-tcp-udp-services/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

12
user-guide/external-articles/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

12
user-guide/ingress-path-matching/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

12
user-guide/miscellaneous/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

34
user-guide/monitoring/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade
@ -1232,22 +1244,18 @@
</div>
<h2 id="before-you-begin">Before You Begin<a class="headerlink" href="#before-you-begin" title="Permanent link">&para;</a></h2>
<p>The NGINX Ingress controller should already be deployed according to the deployment instructions <a href="../../deploy/">here</a>.</p>
<p>Note that the yaml files used in this tutorial are stored in the <a href="https://github.com/kubernetes/ingress-nginx/tree/master/deploy/monitoring">deploy/monitoring</a> folder of the GitHub repository <a href="https://github.com/kubernetes/ingress-nginx">kubernetes/ingress-nginx</a>.</p>
<p>Note that the kustomize bases used in this tutorial are stored in the <a href="https://github.com/kubernetes/ingress-nginx/tree/master/deploy">deploy</a> folder of the GitHub repository <a href="https://github.com/kubernetes/ingress-nginx">kubernetes/ingress-nginx</a>.</p>
<h2 id="deploy-and-configure-prometheus-server">Deploy and configure Prometheus Server<a class="headerlink" href="#deploy-and-configure-prometheus-server" title="Permanent link">&para;</a></h2>
<p>The Prometheus server must be configured so that it can discover endpoints of services. If a Prometheus server is already running in the cluster and if it is configured in a way that it can find the ingress controller pods, no extra configuration is needed.</p>
<p>If there is no existing Prometheus server running, the rest of this tutorial will guide you through the steps needed to deploy a properly configured Prometheus server.</p>
<p>Running the following command deploys the prometheus configuration in Kubernetes:</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl create -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/monitoring/configuration.yaml</span>
<span class="go">configmap &quot;prometheus-configuration&quot; created</span>
</pre></div>
<p>Running the following command deploys prometheus in Kubernetes:</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl create -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/monitoring/prometheus.yaml</span>
<span class="go">clusterrole &quot;prometheus-server&quot; created</span>
<span class="go">serviceaccount &quot;prometheus-server&quot; created</span>
<span class="go">clusterrolebinding &quot;prometheus-server&quot; created</span>
<span class="go">deployment &quot;prometheus-server&quot; created</span>
<span class="go">service &quot;prometheus-server&quot; created</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply --kustomize github.com/kubernetes/ingress-nginx/deploy/prometheus/</span>
<span class="go">serviceaccount/prometheus-server created</span>
<span class="go">role.rbac.authorization.k8s.io/prometheus-server created</span>
<span class="go">rolebinding.rbac.authorization.k8s.io/prometheus-server created</span>
<span class="go">configmap/prometheus-configuration-bc6bcg7b65 created</span>
<span class="go">service/prometheus-server created</span>
<span class="go">deployment.apps/prometheus-server created</span>
</pre></div>
<h3 id="prometheus-dashboard">Prometheus Dashboard<a class="headerlink" href="#prometheus-dashboard" title="Permanent link">&para;</a></h3>
@ -1272,7 +1280,7 @@
<p>According to the above example, this URL will be http://10.192.0.3:32630</p>
<p><img alt="Dashboard" src="../../images/prometheus-dashboard.png" /></p>
<h3 id="grafana">Grafana<a class="headerlink" href="#grafana" title="Permanent link">&para;</a></h3>
<div class="codehilite"><pre><span></span><span class="go">kubectl create -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/monitoring/grafana.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply --kustomize github.com/kubernetes/ingress-nginx/deploy/grafana/</span>
</pre></div>
<div class="codehilite"><pre><span></span><span class="go">kubectl get svc -n ingress-nginx</span>

12
user-guide/multiple-ingress/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

47
user-guide/nginx-configuration/annotations/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade
@ -712,6 +724,19 @@
External Authentication
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#global-external-authentication" title="Global External Authentication" class="md-nav__link">
Global External Authentication
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -1610,6 +1635,19 @@
External Authentication
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#global-external-authentication" title="Global External Authentication" class="md-nav__link">
Global External Authentication
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@ -1912,6 +1950,10 @@ table below.</p>
<td>string</td>
</tr>
<tr>
<td><a href="#external-authentication">nginx.ingress.kubernetes.io/enable-global-auth</a></td>
<td>"true" or "false"</td>
</tr>
<tr>
<td><a href="#backend-protocol">nginx.ingress.kubernetes.io/backend-protocol</a></td>
<td>string</td>
</tr>
@ -2470,6 +2512,11 @@ applied to each location provided in the ingress rule.</p>
<p class="admonition-title">Example</p>
<p>Please check the <a href="../../../examples/auth/external-auth/">external-auth</a> example.</p>
</div>
<h4 id="global-external-authentication">Global External Authentication<a class="headerlink" href="#global-external-authentication" title="Permanent link">&para;</a></h4>
<p>By default the controller redirects all requests to an existing service that provides authentication if <code class="codehilite">global-auth-url</code> is set in the NGINX ConfigMap. If you want to disable this behavior for that ingress, you can use <code class="codehilite">enable-global-auth: &quot;false&quot;</code> in the NGINX ConfigMap.
<code class="codehilite">nginx.ingress.kubernetes.io/enable-global-auth</code>:
indicates if GlobalExternalAuth configuration should be applied or not to this Ingress rule. Default values is set to <code class="codehilite">&quot;true&quot;</code>.</p>
<p>!!! note For more information please see <a href="../configmap/#global-auth-url">global-auth-url</a>.</p>
<h3 id="rate-limiting">Rate limiting<a class="headerlink" href="#rate-limiting" title="Permanent link">&para;</a></h3>
<p>These annotations define a limit on the connections that can be opened by a single client IP address.
This can be used to mitigate <a href="https://www.nginx.com/blog/mitigating-ddos-attacks-with-nginx-and-nginx-plus">DDoS Attacks</a>.</p>

206
user-guide/nginx-configuration/configmap/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade
@ -1264,6 +1276,20 @@
jaeger-sampler-param
</a>
</li>
<li class="md-nav__item">
<a href="#jaeger-sampler-host" title="jaeger-sampler-host" class="md-nav__link">
jaeger-sampler-host
</a>
</li>
<li class="md-nav__item">
<a href="#jaeger-sampler-port" title="jaeger-sampler-port" class="md-nav__link">
jaeger-sampler-port
</a>
</li>
<li class="md-nav__item">
@ -1460,6 +1486,48 @@
no-tls-redirect-locations
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-url" title="global-auth-url" class="md-nav__link">
global-auth-url
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-method" title="global-auth-method" class="md-nav__link">
global-auth-method
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-signin" title="global-auth-signin" class="md-nav__link">
global-auth-signin
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-response-headers" title="global-auth-response-headers" class="md-nav__link">
global-auth-response-headers
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-request-redirect" title="global-auth-request-redirect" class="md-nav__link">
global-auth-request-redirect
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-snippet" title="global-auth-snippet" class="md-nav__link">
global-auth-snippet
</a>
</li>
<li class="md-nav__item">
@ -2705,6 +2773,20 @@
jaeger-sampler-param
</a>
</li>
<li class="md-nav__item">
<a href="#jaeger-sampler-host" title="jaeger-sampler-host" class="md-nav__link">
jaeger-sampler-host
</a>
</li>
<li class="md-nav__item">
<a href="#jaeger-sampler-port" title="jaeger-sampler-port" class="md-nav__link">
jaeger-sampler-port
</a>
</li>
<li class="md-nav__item">
@ -2901,6 +2983,48 @@
no-tls-redirect-locations
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-url" title="global-auth-url" class="md-nav__link">
global-auth-url
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-method" title="global-auth-method" class="md-nav__link">
global-auth-method
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-signin" title="global-auth-signin" class="md-nav__link">
global-auth-signin
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-response-headers" title="global-auth-response-headers" class="md-nav__link">
global-auth-response-headers
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-request-redirect" title="global-auth-request-redirect" class="md-nav__link">
global-auth-request-redirect
</a>
</li>
<li class="md-nav__item">
<a href="#global-auth-snippet" title="global-auth-snippet" class="md-nav__link">
global-auth-snippet
</a>
</li>
<li class="md-nav__item">
@ -3465,6 +3589,16 @@ Same for numbers, like "100".</p>
<td align="left">"1"</td>
</tr>
<tr>
<td align="left"><a href="#jaeger-sampler-host">jaeger-sampler-host</a></td>
<td align="left">string</td>
<td align="left">"http://127.0.0.1"</td>
</tr>
<tr>
<td align="left"><a href="#jaeger-sampler-port">jaeger-sampler-port</a></td>
<td align="left">int</td>
<td align="left">5778</td>
</tr>
<tr>
<td align="left"><a href="#main-snippet">main-snippet</a></td>
<td align="left">string</td>
<td align="left">""</td>
@ -3605,6 +3739,36 @@ Same for numbers, like "100".</p>
<td align="left">"/.well-known/acme-challenge"</td>
</tr>
<tr>
<td align="left"><a href="#global-auth-url">global-auth-url</a></td>
<td align="left">string</td>
<td align="left">""</td>
</tr>
<tr>
<td align="left"><a href="#global-auth-method">global-auth-method</a></td>
<td align="left">string</td>
<td align="left">""</td>
</tr>
<tr>
<td align="left"><a href="#global-auth-signin">global-auth-signin</a></td>
<td align="left">string</td>
<td align="left">""</td>
</tr>
<tr>
<td align="left"><a href="#global-auth-response-headers">global-auth-response-headers</a></td>
<td align="left">string</td>
<td align="left">""</td>
</tr>
<tr>
<td align="left"><a href="#global-auth-request-redirect">global-auth-request-redirect</a></td>
<td align="left">string</td>
<td align="left">""</td>
</tr>
<tr>
<td align="left"><a href="#global-auth-snippet">global-auth-snippet</a></td>
<td align="left">string</td>
<td align="left">""</td>
</tr>
<tr>
<td align="left"><a href="#no-auth-locations">no-auth-locations</a></td>
<td align="left">string</td>
<td align="left">"/.well-known/acme-challenge"</td>
@ -3678,9 +3842,9 @@ Same for numbers, like "100".</p>
<p><em>References:</em>
<a href="http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log">http://nginx.org/en/docs/http/ngx_http_log_module.html#access_log</a></p>
<h2 id="disable-ipv6">disable-ipv6<a class="headerlink" href="#disable-ipv6" title="Permanent link">&para;</a></h2>
<p>Disable listening on IPV6. <em><strong>default:</strong></em> is disabled</p>
<p>Disable listening on IPV6. <em><strong>default:</strong></em> <code class="codehilite">false</code>; IPv6 listening is enabled</p>
<h2 id="disable-ipv6-dns">disable-ipv6-dns<a class="headerlink" href="#disable-ipv6-dns" title="Permanent link">&para;</a></h2>
<p>Disable IPV6 for nginx DNS resolver. <em><strong>default:</strong></em> is disabled</p>
<p>Disable IPV6 for nginx DNS resolver. <em><strong>default:</strong></em> <code class="codehilite">false</code>; IPv6 resolving enabled.</p>
<h2 id="enable-underscores-in-headers">enable-underscores-in-headers<a class="headerlink" href="#enable-underscores-in-headers" title="Permanent link">&para;</a></h2>
<p>Enables underscores in header names. <em><strong>default:</strong></em> is disabled</p>
<h2 id="ignore-invalid-headers">ignore-invalid-headers<a class="headerlink" href="#ignore-invalid-headers" title="Permanent link">&para;</a></h2>
@ -3835,8 +3999,7 @@ To create a ticket: <code class="codehilite">openssl rand 80 | openssl enc -A -b
<p>Sets the timeout value for receiving the proxy-protocol headers. The default of 5 seconds prevents the TLS passthrough handler from waiting indefinitely on a dropped connection.
<em><strong>default:</strong></em> 5s</p>
<h2 id="use-gzip">use-gzip<a class="headerlink" href="#use-gzip" title="Permanent link">&para;</a></h2>
<p>Enables or disables compression of HTTP responses using the <a href="http://nginx.org/en/docs/http/ngx_http_gzip_module.html">"gzip" module</a>.
The default mime type list to compress is: <code class="codehilite">application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component</code>.</p>
<p>Enables or disables compression of HTTP responses using the <a href="http://nginx.org/en/docs/http/ngx_http_gzip_module.html">"gzip" module</a>. MIME types to compress are controlled by <a href="#gzip-types">gzip-types</a>. <em><strong>default:</strong></em> true</p>
<h2 id="use-geoip">use-geoip<a class="headerlink" href="#use-geoip" title="Permanent link">&para;</a></h2>
<p>Enables or disables <a href="http://nginx.org/en/docs/http/ngx_http_geoip_module.html">"geoip" module</a> that creates variables with values depending on the client IP address, using the precompiled MaxMind databases.
<em><strong>default:</strong></em> true</p>
@ -3862,7 +4025,8 @@ The default mime type list to compress is: <code class="codehilite">application/
<h2 id="gzip-level">gzip-level<a class="headerlink" href="#gzip-level" title="Permanent link">&para;</a></h2>
<p>Sets the gzip Compression Level that will be used. <em><strong>default:</strong></em> 5</p>
<h2 id="gzip-types">gzip-types<a class="headerlink" href="#gzip-types" title="Permanent link">&para;</a></h2>
<p>Sets the MIME types in addition to "text/html" to compress. The special value "*" matches any MIME type. Responses with the "text/html" type are always compressed if <code class="codehilite">use-gzip</code> is enabled.</p>
<p>Sets the MIME types in addition to "text/html" to compress. The special value "*" matches any MIME type. Responses with the "text/html" type are always compressed if <code class="codehilite">[use-gzip](#use-gzip)</code> is enabled.
<em><strong>default:</strong></em> <code class="codehilite">application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component</code>.</p>
<h2 id="worker-processes">worker-processes<a class="headerlink" href="#worker-processes" title="Permanent link">&para;</a></h2>
<p>Sets the number of <a href="http://nginx.org/en/docs/ngx_core_module.html#worker_processes">worker processes</a>.
The default of "auto" means number of available CPU cores.</p>
@ -3962,6 +4126,11 @@ requests is made, the connection is closed.
<h2 id="jaeger-sampler-param">jaeger-sampler-param<a class="headerlink" href="#jaeger-sampler-param" title="Permanent link">&para;</a></h2>
<p>Specifies the argument to be passed to the sampler constructor. Must be a number.
For const this should be 0 to never sample and 1 to always sample. <em><strong>default:</strong></em> 1</p>
<h2 id="jaeger-sampler-host">jaeger-sampler-host<a class="headerlink" href="#jaeger-sampler-host" title="Permanent link">&para;</a></h2>
<p>Specifies the custom remote sampler host to be passed to the sampler constructor. Must be a valid URL.
Leave blank to use default value (localhost). <em><strong>default:</strong></em> http://127.0.0.1</p>
<h2 id="jaeger-sampler-port">jaeger-sampler-port<a class="headerlink" href="#jaeger-sampler-port" title="Permanent link">&para;</a></h2>
<p>Specifies the custom remote sampler port to be passed to the sampler constructor. Must be a number. <em><strong>default:</strong></em> 5778</p>
<h2 id="main-snippet">main-snippet<a class="headerlink" href="#main-snippet" title="Permanent link">&para;</a></h2>
<p>Adds custom configuration to the main section of the nginx configuration.</p>
<h2 id="http-snippet">http-snippet<a class="headerlink" href="#http-snippet" title="Permanent link">&para;</a></h2>
@ -3970,6 +4139,7 @@ For const this should be 0 to never sample and 1 to always sample. <em><strong>d
<p>Adds custom configuration to all the servers in the nginx configuration.</p>
<h2 id="location-snippet">location-snippet<a class="headerlink" href="#location-snippet" title="Permanent link">&para;</a></h2>
<p>Adds custom configuration to all the locations in the nginx configuration.</p>
<p>You can not use this to add new locations that proxy to the Kubernetes pods, as the snippet does not have access to the Go template functions. If you want to add custom locations you will have to <a href="https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/custom-template/">provide your own nginx.tmpl</a>.</p>
<h2 id="custom-http-errors">custom-http-errors<a class="headerlink" href="#custom-http-errors" title="Permanent link">&para;</a></h2>
<p>Enables which HTTP codes should be passed for processing with the <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#error_page">error_page directive</a></p>
<p>Setting at least one code also enables <a href="http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_intercept_errors">proxy_intercept_errors</a> which are required to process error_page.</p>
@ -4036,6 +4206,32 @@ Supported codes are <a href="https://developer.mozilla.org/docs/Web/HTTP/Status/
<h2 id="no-tls-redirect-locations">no-tls-redirect-locations<a class="headerlink" href="#no-tls-redirect-locations" title="Permanent link">&para;</a></h2>
<p>A comma-separated list of locations on which http requests will never get redirected to their https counterpart.
<em><strong>default:</strong></em> "/.well-known/acme-challenge"</p>
<h2 id="global-auth-url">global-auth-url<a class="headerlink" href="#global-auth-url" title="Permanent link">&para;</a></h2>
<p>A url to an existing service that provides authentication for all the locations.
Similar to the Ingress rule annotation <code class="codehilite">nginx.ingress.kubernetes.io/auth-url</code>.
Locations that should not get authenticated can be listed using <code class="codehilite">no-auth-locations</code> See <a href="#no-auth-locations">no-auth-locations</a>. In addition, each service can be excluded from authentication via annotation <code class="codehilite">enable-global-auth</code> set to "false".
<em><strong>default:</strong></em> ""</p>
<p><em>References:</em> <a href="https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/annotations.md#external-authentication">https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/annotations.md#external-authentication</a></p>
<h2 id="global-auth-method">global-auth-method<a class="headerlink" href="#global-auth-method" title="Permanent link">&para;</a></h2>
<p>A HTTP method to use for an existing service that provides authentication for all the locations.
Similar to the Ingress rule annotation <code class="codehilite">nginx.ingress.kubernetes.io/auth-method</code>.
<em><strong>default:</strong></em> ""</p>
<h2 id="global-auth-signin">global-auth-signin<a class="headerlink" href="#global-auth-signin" title="Permanent link">&para;</a></h2>
<p>Sets the location of the error page for an existing service that provides authentication for all the locations.
Similar to the Ingress rule annotation <code class="codehilite">nginx.ingress.kubernetes.io/auth-signin</code>.
<em><strong>default:</strong></em> ""</p>
<h2 id="global-auth-response-headers">global-auth-response-headers<a class="headerlink" href="#global-auth-response-headers" title="Permanent link">&para;</a></h2>
<p>Sets the headers to pass to backend once authentication request completes. Applied to all the locations.
Similar to the Ingress rule annotation <code class="codehilite">nginx.ingress.kubernetes.io/auth-response-headers</code>.
<em><strong>default:</strong></em> ""</p>
<h2 id="global-auth-request-redirect">global-auth-request-redirect<a class="headerlink" href="#global-auth-request-redirect" title="Permanent link">&para;</a></h2>
<p>Sets the X-Auth-Request-Redirect header value. Applied to all the locations.
Similar to the Ingress rule annotation <code class="codehilite">nginx.ingress.kubernetes.io/auth-request-redirect</code>.
<em><strong>default:</strong></em> ""</p>
<h2 id="global-auth-snippet">global-auth-snippet<a class="headerlink" href="#global-auth-snippet" title="Permanent link">&para;</a></h2>
<p>Sets a custom snippet to use with external authentication. Applied to all the locations.
Similar to the Ingress rule annotation <code class="codehilite">nginx.ingress.kubernetes.io/auth-request-redirect</code>.
<em><strong>default:</strong></em> ""</p>
<h2 id="no-auth-locations">no-auth-locations<a class="headerlink" href="#no-auth-locations" title="Permanent link">&para;</a></h2>
<p>A comma-separated list of locations that should not get authenticated.
<em><strong>default:</strong></em> "/.well-known/acme-challenge"</p>

12
user-guide/nginx-configuration/custom-template/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

12
user-guide/nginx-configuration/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

12
user-guide/nginx-configuration/log-format/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

12
user-guide/third-party-addons/modsecurity/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade

19
user-guide/third-party-addons/opentracing/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade
@ -1269,6 +1281,13 @@ jaeger-sampler-type
# specifies the argument to be passed to the sampler constructor, Default: 1
jaeger-sampler-param
# Specifies the custom remote sampler host to be passed to the sampler constructor. Must be a valid URL.
# Default: http://127.0.0.1
jaeger-sampler-host
# Specifies the custom remote sampler port to be passed to the sampler constructor. Must be a number. Default: 5778
jaeger-sampler-port
# specifies the port to use when uploading traces, Default 8126
datadog-collector-port

12
user-guide/tls/index.html
View file

@ -472,6 +472,18 @@
<li class="md-nav__item">
<a href="../../deploy/validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade