DevFW-CICD/ingress-nginx-helm
16
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
Show stats Download patch file Download diff file Expand all files Collapse all files

12
404.html
View file

@ -466,6 +466,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"> <li class="md-nav__item">
<a href="/deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="/deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
deploy/baremetal/index.html
View file

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

106
deploy/index.html
View file

@ -628,6 +628,18 @@
<li class="md-nav__item">
<a href="validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="upgrade/" title="Upgrade" class="md-nav__link"> <a href="upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1423,6 +1435,10 @@
<p>The following <strong>Mandatory Command</strong> is required for all deployments.</p> <p>The following <strong>Mandatory Command</strong> is required for all deployments.</p>
<div class="admonition attention"> <div class="admonition attention">
<p class="admonition-title">Attention</p> <p class="admonition-title">Attention</p>
<p>These commands depend on having kubectl version 1.14 or newer.</p>
</div>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>The default configuration watches Ingress object from all the namespaces. <p>The default configuration watches Ingress object from all the namespaces.
To change this behavior use the flag <code class="codehilite">--watch-namespace</code> to limit the scope to a particular namespace.</p> To change this behavior use the flag <code class="codehilite">--watch-namespace</code> to limit the scope to a particular namespace.</p>
</div> </div>
@ -1430,22 +1446,24 @@ To change this behavior use the flag <code class="codehilite">--watch-namespace<
<p class="admonition-title">Warning</p> <p class="admonition-title">Warning</p>
<p>If multiple Ingresses define different paths for the same host, the ingress controller will merge the definitions.</p> <p>If multiple Ingresses define different paths for the same host, the ingress controller will merge the definitions.</p>
</div> </div>
<div class="admonition attention"> <div class="codehilite"><pre><span></span><span class="go">kubectl create namespace ingress-nginx</span>
<p class="admonition-title">Attention</p> </pre></div>
<p>If you're using GKE you need to initialize your user as a cluster-admin with the following command:
<code class="codehilite">kubectl create clusterrolebinding cluster-admin-binding --clusterrole cluster-admin --user $(gcloud config get-value account)</code></p> <div class="codehilite"><pre><span></span><span class="go">cat &lt;&lt; EOF &gt; kustomization.yaml</span>
</div> <span class="go">apiVersion: kustomize.config.k8s.io/v1beta1</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/mandatory.yaml</span> <span class="go">kind: Kustomization</span>
<span class="go">namespace: ingress-nginx</span>
<span class="go">bases:</span>
<span class="go">- github.com/kubernetes/ingress-nginx/deploy/cluster-wide</span>
<span class="go">- # provider-specific, see below</span>
<span class="go">EOF</span>
</pre></div> </pre></div>
<h3 id="provider-specific-steps">Provider Specific Steps<a class="headerlink" href="#provider-specific-steps" title="Permanent link">&para;</a></h3> <h3 id="provider-specific-steps">Provider Specific Steps<a class="headerlink" href="#provider-specific-steps" title="Permanent link">&para;</a></h3>
<p>There are cloud provider specific yaml files.</p> <p>There are cloud provider specific kustomize bases.</p>
<h4 id="docker-for-mac">Docker for Mac<a class="headerlink" href="#docker-for-mac" title="Permanent link">&para;</a></h4> <h4 id="docker-for-mac">Docker for Mac<a class="headerlink" href="#docker-for-mac" title="Permanent link">&para;</a></h4>
<p>Kubernetes is available in Docker for Mac (from <a href="https://docs.docker.com/docker-for-mac/release-notes/#stable-releases-of-2018">version 18.06.0-ce</a>)</p> <p>Kubernetes is available in Docker for Mac (from <a href="https://docs.docker.com/docker-for-mac/release-notes/#stable-releases-of-2018">version 18.06.0-ce</a>)</p>
<p>Create a service</p> <p>Add <code class="codehilite">github.com/kubernetes/ingress-nginx/deploy/cloud-generic</code> to the <code class="codehilite">bases</code> list in <code class="codehilite">kustomization.yaml</code> and run <code class="codehilite">kubectl apply --kustomize .</code>.</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml</span>
</pre></div>
<h4 id="minikube">minikube<a class="headerlink" href="#minikube" title="Permanent link">&para;</a></h4> <h4 id="minikube">minikube<a class="headerlink" href="#minikube" title="Permanent link">&para;</a></h4>
<p>For standard usage:</p> <p>For standard usage:</p>
<div class="codehilite"><pre><span></span><span class="go">minikube addons enable ingress</span> <div class="codehilite"><pre><span></span><span class="go">minikube addons enable ingress</span>
@ -1478,21 +1496,43 @@ Please check the <a href="https://aws.amazon.com/elasticloadbalancing/details/">
<li><a href="https://en.wikipedia.org/wiki/OSI_model#Layer_4:_Transport_Layer">Layer 4</a>: use TCP as the listener protocol for ports 80 and 443.</li> <li><a href="https://en.wikipedia.org/wiki/OSI_model#Layer_4:_Transport_Layer">Layer 4</a>: use TCP as the listener protocol for ports 80 and 443.</li>
<li><a href="https://en.wikipedia.org/wiki/OSI_model#Layer_7:_Application_Layer">Layer 7</a>: use HTTP as the listener protocol for port 80 and terminate TLS in the ELB</li> <li><a href="https://en.wikipedia.org/wiki/OSI_model#Layer_7:_Application_Layer">Layer 7</a>: use HTTP as the listener protocol for port 80 and terminate TLS in the ELB</li>
</ul> </ul>
<p>Check that no change is necessary with regards to the ELB idle timeout. In some scenarios, users may want to modify the ELB idle timeout, so please check the <a href="#elb-idle-timeouts">ELB Idle Timeouts section</a> for additional information. If a change is required, users will need to override the value of the annotation <code class="codehilite">service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout</code> on the service object.</p>
<p>To do this, create a patch file which will replace the annotation.</p>
<div class="codehilite"><pre><span></span>cat &lt;&lt; EOF &gt; elb-timeout.yaml
kind: Service
apiVersion: v1
metadata:
name: ingress-nginx
annotations:
service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout: &quot;3600&quot; # Recommended value for WebSockets
EOF
</pre></div>
<p>After creating the patch file, reference it in your <code class="codehilite">kustomization.yaml</code>:
<div class="codehilite"><pre><span></span><span class="nt">patchesStrategicMerge</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">elb-timeout.yaml</span>
</pre></div></p>
<p>For L4:</p> <p>For L4:</p>
<p>Check that no change is necessary with regards to the ELB idle timeout. In some scenarios, users may want to modify the ELB idle timeout, so please check the <a href="#elb-idle-timeouts">ELB Idle Timeouts section</a> for additional information. If a change is required, users will need to update the value of <code class="codehilite">service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout</code> in <code class="codehilite">provider/aws/service-l4.yaml</code></p> <p>To deploy the default example, add the base <code class="codehilite">github.com/kubernetes/ingress-nginx/deploy/aws/l4</code> and then run <code class="codehilite">kubectl apply --kustomize .</code></p>
<p>Then execute:</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-l4.yaml</span>
<span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/patch-configmap-l4.yaml</span>
</pre></div>
<p>For L7:</p> <p>For L7:</p>
<p>Change line of the file <code class="codehilite">provider/aws/service-l7.yaml</code> replacing the dummy id with a valid one <code class="codehilite">&quot;arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX&quot;</code></p> <p>Create a a patch that will annotate the ingress-controller's service with your ssl certificate id.</p>
<p>Check that no change is necessary with regards to the ELB idle timeout. In some scenarios, users may want to modify the ELB idle timeout, so please check the <a href="#elb-idle-timeouts">ELB Idle Timeouts section</a> for additional information. If a change is required, users will need to update the value of <code class="codehilite">service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout</code> in <code class="codehilite">provider/aws/service-l7.yaml</code></p> <div class="codehilite"><pre><span></span><span class="go">cat &lt;&lt; EOF &gt; elb-ssl.yaml</span>
<p>Then execute:</p> <span class="go">kind: Service</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-l7.yaml</span> <span class="go">apiVersion: v1</span>
<span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/patch-configmap-l7.yaml</span> <span class="go">metadata:</span>
<span class="go"> name: ingress-nginx</span>
<span class="go"> annotations:</span>
<span class="gp"> #</span> replace with the correct value of the generated certificate in the AWS console
<span class="go"> service.beta.kubernetes.io/aws-load-balancer-ssl-cert: &quot;arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX&quot;</span>
<span class="go">EOF</span>
</pre></div> </pre></div>
<p>Reference this patch in your <code class="codehilite">kustomization.yaml</code>:</p>
<div class="codehilite"><pre><span></span><span class="nt">patchesStrategicMerge</span><span class="p">:</span>
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">elb-ssl.yaml</span>
</pre></div>
<p>Then add the l7 base, <code class="codehilite">github.com/kubernetes/ingress-nginx/deploy/aws/l7</code> and execute <code class="codehilite">kubectl apply --kustomize .</code></p>
<p>This example creates an ELB with just two listeners, one in port 80 and another in port 443</p> <p>This example creates an ELB with just two listeners, one in port 80 and another in port 443</p>
<p><img alt="Listeners" src="../images/elb-l7-listener.png" /></p> <p><img alt="Listeners" src="../images/elb-l7-listener.png" /></p>
<h5 id="elb-idle-timeouts">ELB Idle Timeouts<a class="headerlink" href="#elb-idle-timeouts" title="Permanent link">&para;</a></h5> <h5 id="elb-idle-timeouts">ELB Idle Timeouts<a class="headerlink" href="#elb-idle-timeouts" title="Permanent link">&para;</a></h5>
@ -1501,24 +1541,20 @@ Please check the <a href="https://aws.amazon.com/elasticloadbalancing/details/">
<p><em>Please Note: An idle timeout of <code class="codehilite">3600s</code> is recommended when using WebSockets.</em></p> <p><em>Please Note: An idle timeout of <code class="codehilite">3600s</code> is recommended when using WebSockets.</em></p>
<p>More information with regards to idle timeouts for your Load Balancer can be found in the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html">official AWS documentation</a>.</p> <p>More information with regards to idle timeouts for your Load Balancer can be found in the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/config-idle-timeout.html">official AWS documentation</a>.</p>
<h5 id="network-load-balancer-nlb">Network Load Balancer (NLB)<a class="headerlink" href="#network-load-balancer-nlb" title="Permanent link">&para;</a></h5> <h5 id="network-load-balancer-nlb">Network Load Balancer (NLB)<a class="headerlink" href="#network-load-balancer-nlb" title="Permanent link">&para;</a></h5>
<p>This type of load balancer is supported since v1.10.0 as an ALPHA feature.</p> <p>This type of load balancer is supported since v1.10.0 as an ALPHA feature. Use the base <code class="codehilite">github.com/kubernetes/ingress-nginx/deploy/aws/nlb</code> and execute <code class="codehilite">kubectl apply --kustomize .</code></p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/aws/service-nlb.yaml</span>
</pre></div>
<h4 id="gce-gke">GCE-GKE<a class="headerlink" href="#gce-gke" title="Permanent link">&para;</a></h4> <h4 id="gce-gke">GCE-GKE<a class="headerlink" href="#gce-gke" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml</span> <div class="admonition attention">
</pre></div> <p class="admonition-title">Attention</p>
<p>If you're using GKE you need to initialize your user as a cluster-admin with the following command:
<code class="codehilite">kubectl create clusterrolebinding cluster-admin-binding --clusterrole cluster-admin --user $(gcloud config get-value account)</code></p>
</div>
<p>Use the base <code class="codehilite">github.com/kubernetes/ingress-nginx/deploy/cloud-generic</code> and execute <code class="codehilite">kubectl apply --kustomize .</code></p>
<p><strong>Important Note:</strong> proxy protocol is not supported in GCE/GKE</p> <p><strong>Important Note:</strong> proxy protocol is not supported in GCE/GKE</p>
<h4 id="azure">Azure<a class="headerlink" href="#azure" title="Permanent link">&para;</a></h4> <h4 id="azure">Azure<a class="headerlink" href="#azure" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/cloud-generic.yaml</span> <p>Use the base <code class="codehilite">github.com/kubernetes/ingress-nginx/deploy/cloud-generic</code> and execute <code class="codehilite">kubectl apply --kustomize .</code></p>
</pre></div>
<h4 id="bare-metal">Bare-metal<a class="headerlink" href="#bare-metal" title="Permanent link">&para;</a></h4> <h4 id="bare-metal">Bare-metal<a class="headerlink" href="#bare-metal" title="Permanent link">&para;</a></h4>
<p>Using <a href="https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport">NodePort</a>:</p> <p>Using <a href="https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport">NodePort</a>:</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/provider/baremetal/service-nodeport.yaml</span> <p>Use the base <code class="codehilite">github.com/kubernetes/ingress-nginx/deploy/baremetal</code> and execute <code class="codehilite">kubectl apply --kustomize .</code></p>
</pre></div>
<div class="admonition tip"> <div class="admonition tip">
<p class="admonition-title">Tip</p> <p class="admonition-title">Tip</p>
<p>For extended notes regarding deployments on bare-metal, see <a href="baremetal/">Bare-metal considerations</a>.</p> <p>For extended notes regarding deployments on bare-metal, see <a href="baremetal/">Bare-metal considerations</a>.</p>

16
deploy/rbac/index.html
View file

@ -553,6 +553,18 @@
<li class="md-nav__item">
<a href="../validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../upgrade/" title="Upgrade" class="md-nav__link"> <a href="../upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1351,13 +1363,13 @@ container arguments, and POD_NAMESPACE should be in the nginx-ingress namespace.
</a> </a>
<a href="../upgrade/" title="Upgrade" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> <a href="../validating-webhook/" title="Validating Webhook (admission controller)" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis"> <span class="md-flex__ellipsis">
<span class="md-footer-nav__direction"> <span class="md-footer-nav__direction">
Next Next
</span> </span>
Upgrade Validating Webhook (admission controller)
</span> </span>
</div> </div>
<div class="md-flex__cell md-flex__cell--shrink"> <div class="md-flex__cell md-flex__cell--shrink">

16
deploy/upgrade/index.html
View file

@ -473,6 +473,18 @@
<li class="md-nav__item">
<a href="../validating-webhook/" title="Validating Webhook (admission controller)" class="md-nav__link">
Validating Webhook (admission controller)
</a>
</li>
@ -1242,7 +1254,7 @@ you should be able to upgrade using</p>
<div class="md-footer-nav"> <div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid"> <nav class="md-footer-nav__inner md-grid">
<a href="../rbac/" title="Role Based Access Control (RBAC)" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> <a href="../validating-webhook/" title="Validating Webhook (admission controller)" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-flex__cell md-flex__cell--shrink"> <div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
</div> </div>
@ -1251,7 +1263,7 @@ you should be able to upgrade using</p>
<span class="md-footer-nav__direction"> <span class="md-footer-nav__direction">
Previous Previous
</span> </span>
Role Based Access Control (RBAC) Validating Webhook (admission controller)
</span> </span>
</div> </div>
</a> </a>

1575
deploy/validating-webhook/index.html Normal file
View file

File diff suppressed because it is too large Load diff

12
development/index.html
View file

@ -587,6 +587,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"> <li class="md-nav__item">
<a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/PREREQUISITES/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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/affinity/cookie/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/auth/basic/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/auth/client-certs/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/auth/external-auth/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/auth/oauth-external-auth/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/customization/configuration-snippets/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/customization/custom-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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/customization/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

34
examples/customization/custom-headers/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1173,19 +1185,21 @@
<h1 id="custom-headers">Custom Headers<a class="headerlink" href="#custom-headers" title="Permanent link">&para;</a></h1> <h1 id="custom-headers">Custom Headers<a class="headerlink" href="#custom-headers" title="Permanent link">&para;</a></h1>
<p>This example aims to demonstrate the deployment of an nginx ingress controller and <p>This example demonstrates configuration of the nginx ingress controller via
use a ConfigMap to configure a custom list of headers to be passed to the upstream a ConfigMap to pass a custom list of headers to the upstream
server</p> server.</p>
<div class="codehilite"><pre><span></span><span class="go">curl https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/examples/customization/custom-headers/configmap.yaml \</span> <p><a href="custom-headers.yaml">custom-headers.yaml</a> defines a ConfigMap in the <code class="codehilite">ingress-nginx</code> namespace named <code class="codehilite">custom-headers</code>, holding several custom X-prefixed HTTP headers.</p>
<span class="go"> | kubectl apply -f -</span> <div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/examples/customization/custom-headers/custom-headers.yaml</span>
<span class="go">curl https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/examples/customization/custom-headers/custom-headers.yaml \</span>
<span class="go"> | kubectl apply -f -</span>
</pre></div> </pre></div>
<p><a href="configmap.yaml">configmap.yaml</a> defines a ConfigMap in the <code class="codehilite">ingress-nginx</code> namespace named <code class="codehilite">nginx-configuration</code>. This controls the <a href="../../../user-guide/nginx-configuration/configmap/">global configuration</a> of the ingress controller, and already exists in a standard installation. The key <code class="codehilite">proxy-set-headers</code> is set to cite the previously-created <code class="codehilite">ingress-nginx/custom-headers</code> ConfigMap.</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/examples/customization/custom-headers/configmap.yaml</span>
</pre></div>
<p>The nginx ingress controller will read the <code class="codehilite">ingress-nginx/nginx-configuration</code> ConfigMap, find the <code class="codehilite">proxy-set-headers</code> key, read HTTP headers from the <code class="codehilite">ingress-nginx/custom-headers</code> ConfigMap, and include those HTTP headers in all requests flowing from nginx to the backends.</p>
<h2 id="test">Test<a class="headerlink" href="#test" title="Permanent link">&para;</a></h2> <h2 id="test">Test<a class="headerlink" href="#test" title="Permanent link">&para;</a></h2>
<p>Check the contents of the configmap is present in the nginx.conf file using: <p>Check the contents of the ConfigMaps are present in the nginx.conf file using:
<code class="codehilite">kubectl exec nginx-ingress-controller-873061567-4n3k2 -n kube-system cat /etc/nginx/nginx.conf</code></p> <code class="codehilite">kubectl exec nginx-ingress-controller-873061567-4n3k2 -n ingress-nginx cat /etc/nginx/nginx.conf</code></p>

12
examples/customization/external-auth-headers/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/customization/ssl-dh-param/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/customization/sysctl/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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/docker-registry/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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/grpc/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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/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"> <li class="md-nav__item">
<a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/multi-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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

14
examples/rewrite/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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1313,7 +1325,7 @@ and that you have an ingress controller <a href="../../deploy">running</a> in yo
<span class="go">&#39; | kubectl create -f -</span> <span class="go">&#39; | kubectl create -f -</span>
</pre></div> </pre></div>
<p>In this ingress definition, any characters captured by <code class="codehilite">(.*)</code> will be assigned to the placeholder <code class="codehilite">$1</code>, which is then used as a parameter in the <code class="codehilite">rewrite-target</code> annotation. </p> <p>In this ingress definition, any characters captured by <code class="codehilite">(.*)</code> will be assigned to the placeholder <code class="codehilite">$2</code>, which is then used as a parameter in the <code class="codehilite">rewrite-target</code> annotation. </p>
<p>For example, the ingress definition above will result in the following rewrites: <p>For example, the ingress definition above will result in the following rewrites:
- <code class="codehilite">rewrite.bar.com/something</code> rewrites to <code class="codehilite">rewrite.bar.com/</code> - <code class="codehilite">rewrite.bar.com/something</code> rewrites to <code class="codehilite">rewrite.bar.com/</code>
- <code class="codehilite">rewrite.bar.com/something/</code> rewrites to <code class="codehilite">rewrite.bar.com/</code> - <code class="codehilite">rewrite.bar.com/something/</code> rewrites to <code class="codehilite">rewrite.bar.com/</code>

12
examples/static-ip/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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
examples/tls-termination/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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

30
how-it-works/index.html
View file

@ -434,6 +434,13 @@
Avoiding reloads on Endpoints changes Avoiding reloads on Endpoints changes
</a> </a>
</li>
<li class="md-nav__item">
<a href="#avoiding-outage-from-wrong-configuration" title="Avoiding outage from wrong configuration" class="md-nav__link">
Avoiding outage from wrong configuration
</a>
</li> </li>
</ul> </ul>
@ -553,6 +560,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"> <li class="md-nav__item">
<a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1226,6 +1245,13 @@
Avoiding reloads on Endpoints changes Avoiding reloads on Endpoints changes
</a> </a>
</li>
<li class="md-nav__item">
<a href="#avoiding-outage-from-wrong-configuration" title="Avoiding outage from wrong configuration" class="md-nav__link">
Avoiding outage from wrong configuration
</a>
</li> </li>
</ul> </ul>
@ -1299,6 +1325,10 @@
<h3 id="avoiding-reloads-on-endpoints-changes">Avoiding reloads on Endpoints changes<a class="headerlink" href="#avoiding-reloads-on-endpoints-changes" title="Permanent link">&para;</a></h3> <h3 id="avoiding-reloads-on-endpoints-changes">Avoiding reloads on Endpoints changes<a class="headerlink" href="#avoiding-reloads-on-endpoints-changes" title="Permanent link">&para;</a></h3>
<p>On every endpoint change the controller fetches endpoints from all the services it sees and generates corresponding Backend objects. It then sends these objects to a Lua handler running inside Nginx. The Lua code in turn stores those backends in a shared memory zone. Then for every request Lua code running in <a href="https://github.com/openresty/lua-resty-core/blob/master/lib/ngx/balancer.md"><code class="codehilite">balancer_by_lua</code></a> context detects what endpoints it should choose upstream peer from and applies the configured load balancing algorithm to choose the peer. Then Nginx takes care of the rest. This way we avoid reloading Nginx on endpoint changes. <em>Note</em> that this includes annotation changes that affects only <code class="codehilite">upstream</code> configuration in Nginx as well.</p> <p>On every endpoint change the controller fetches endpoints from all the services it sees and generates corresponding Backend objects. It then sends these objects to a Lua handler running inside Nginx. The Lua code in turn stores those backends in a shared memory zone. Then for every request Lua code running in <a href="https://github.com/openresty/lua-resty-core/blob/master/lib/ngx/balancer.md"><code class="codehilite">balancer_by_lua</code></a> context detects what endpoints it should choose upstream peer from and applies the configured load balancing algorithm to choose the peer. Then Nginx takes care of the rest. This way we avoid reloading Nginx on endpoint changes. <em>Note</em> that this includes annotation changes that affects only <code class="codehilite">upstream</code> configuration in Nginx as well.</p>
<p>In a relatively big clusters with frequently deploying apps this feature saves significant number of Nginx reloads which can otherwise affect response latency, load balancing quality (after every reload Nginx resets the state of load balancing) and so on.</p> <p>In a relatively big clusters with frequently deploying apps this feature saves significant number of Nginx reloads which can otherwise affect response latency, load balancing quality (after every reload Nginx resets the state of load balancing) and so on.</p>
<h3 id="avoiding-outage-from-wrong-configuration">Avoiding outage from wrong configuration<a class="headerlink" href="#avoiding-outage-from-wrong-configuration" title="Permanent link">&para;</a></h3>
<p>Because the ingress controller works using the <a href="https://coreos.com/kubernetes/docs/latest/replication-controller.html#the-reconciliation-loop-in-detail">synchronization loop pattern</a>, it is applying the configuration for all matching objects. In case some Ingress objects have a broken configuration, for example a syntax error in the <code class="codehilite">nginx.ingress.kubernetes.io/configuration-snippet</code> annotation, the generated configuration becomes invalid, does not reload and hence no more ingresses will be taken into account.</p>
<p>To prevent this situation to happen, the nginx ingress controller exposes optionnally a <a href="https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#validatingadmissionwebhook">validating admission webhook server</a> to ensure the validity of incoming ingress objects.
This webhook appends the incoming ingress objects to the list of ingresses, generates the configuration and calls nginx to ensure the configuration has no syntax errors.</p>

12
index.html
View file

@ -512,6 +512,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"> <li class="md-nav__item">
<a href="deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

12
kubectl-plugin/index.html
View file

@ -602,6 +602,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"> <li class="md-nav__item">
<a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

2
search/search_index.json
View file

File diff suppressed because one or more lines are too long

99
sitemap.xml
View file

@ -2,237 +2,242 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>None</loc> <loc>None</loc>
<lastmod>2019-05-02</lastmod> <lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>None</loc>
<lastmod>2019-05-26</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
</urlset> </urlset>

BIN
sitemap.xml.gz
View file

Binary file not shown.

12
troubleshooting/index.html
View file

@ -553,6 +553,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"> <li class="md-nav__item">
<a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade

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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1288,6 +1300,22 @@
<td><code class="codehilite">--watch-namespace string</code></td> <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> <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>
<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> </tbody>
</table> </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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1232,22 +1244,18 @@
</div> </div>
<h2 id="before-you-begin">Before You Begin<a class="headerlink" href="#before-you-begin" title="Permanent link">&para;</a></h2> <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>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> <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>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>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> <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> <div class="codehilite"><pre><span></span><span class="go">kubectl apply --kustomize github.com/kubernetes/ingress-nginx/deploy/prometheus/</span>
<span class="go">clusterrole &quot;prometheus-server&quot; created</span> <span class="go">serviceaccount/prometheus-server created</span>
<span class="go">serviceaccount &quot;prometheus-server&quot; created</span> <span class="go">role.rbac.authorization.k8s.io/prometheus-server created</span>
<span class="go">clusterrolebinding &quot;prometheus-server&quot; created</span> <span class="go">rolebinding.rbac.authorization.k8s.io/prometheus-server created</span>
<span class="go">deployment &quot;prometheus-server&quot; created</span> <span class="go">configmap/prometheus-configuration-bc6bcg7b65 created</span>
<span class="go">service &quot;prometheus-server&quot; created</span> <span class="go">service/prometheus-server created</span>
<span class="go">deployment.apps/prometheus-server created</span>
</pre></div> </pre></div>
<h3 id="prometheus-dashboard">Prometheus Dashboard<a class="headerlink" href="#prometheus-dashboard" title="Permanent link">&para;</a></h3> <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>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> <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> <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> </pre></div>
<div class="codehilite"><pre><span></span><span class="go">kubectl get svc -n ingress-nginx</span> <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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -712,6 +724,19 @@
External Authentication External Authentication
</a> </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>
<li class="md-nav__item"> <li class="md-nav__item">
@ -1610,6 +1635,19 @@
External Authentication External Authentication
</a> </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>
<li class="md-nav__item"> <li class="md-nav__item">
@ -1912,6 +1950,10 @@ table below.</p>
<td>string</td> <td>string</td>
</tr> </tr>
<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><a href="#backend-protocol">nginx.ingress.kubernetes.io/backend-protocol</a></td>
<td>string</td> <td>string</td>
</tr> </tr>
@ -2470,6 +2512,11 @@ applied to each location provided in the ingress rule.</p>
<p class="admonition-title">Example</p> <p class="admonition-title">Example</p>
<p>Please check the <a href="../../../examples/auth/external-auth/">external-auth</a> example.</p> <p>Please check the <a href="../../../examples/auth/external-auth/">external-auth</a> example.</p>
</div> </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> <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. <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> 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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1264,6 +1276,20 @@
jaeger-sampler-param jaeger-sampler-param
</a> </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>
<li class="md-nav__item"> <li class="md-nav__item">
@ -1460,6 +1486,48 @@
no-tls-redirect-locations no-tls-redirect-locations
</a> </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>
<li class="md-nav__item"> <li class="md-nav__item">
@ -2705,6 +2773,20 @@
jaeger-sampler-param jaeger-sampler-param
</a> </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>
<li class="md-nav__item"> <li class="md-nav__item">
@ -2901,6 +2983,48 @@
no-tls-redirect-locations no-tls-redirect-locations
</a> </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>
<li class="md-nav__item"> <li class="md-nav__item">
@ -3465,6 +3589,16 @@ Same for numbers, like "100".</p>
<td align="left">"1"</td> <td align="left">"1"</td>
</tr> </tr>
<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"><a href="#main-snippet">main-snippet</a></td>
<td align="left">string</td> <td align="left">string</td>
<td align="left">""</td> <td align="left">""</td>
@ -3605,6 +3739,36 @@ Same for numbers, like "100".</p>
<td align="left">"/.well-known/acme-challenge"</td> <td align="left">"/.well-known/acme-challenge"</td>
</tr> </tr>
<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"><a href="#no-auth-locations">no-auth-locations</a></td>
<td align="left">string</td> <td align="left">string</td>
<td align="left">"/.well-known/acme-challenge"</td> <td align="left">"/.well-known/acme-challenge"</td>
@ -3678,9 +3842,9 @@ Same for numbers, like "100".</p>
<p><em>References:</em> <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> <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> <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> <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> <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> <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> <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. <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> <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> <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>. <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>
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>
<h2 id="use-geoip">use-geoip<a class="headerlink" href="#use-geoip" title="Permanent link">&para;</a></h2> <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. <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> <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> <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> <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> <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> <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>. <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> 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> <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. <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> 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> <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> <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> <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> <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> <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>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> <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>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> <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> <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. <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> <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> <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. <p>A comma-separated list of locations that should not get authenticated.
<em><strong>default:</strong></em> "/.well-known/acme-challenge"</p> <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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade 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"> <li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade
@ -1269,6 +1281,13 @@ jaeger-sampler-type
# specifies the argument to be passed to the sampler constructor, Default: 1 # specifies the argument to be passed to the sampler constructor, Default: 1
jaeger-sampler-param 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 # specifies the port to use when uploading traces, Default 8126
datadog-collector-port 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"> <li class="md-nav__item">
<a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link"> <a href="../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade Upgrade