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 2018-09-13 23:54:10 +00:00
parent b3d5b69555
commit ca7aeec8ab
51 changed files with 5886 additions and 6747 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -32,7 +32,7 @@
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="../../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-0.17.5, mkdocs-material-2.9.4">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-3.0.4">
@ -54,8 +54,8 @@
<script src="../../../assets/javascripts/modernizr.1aa3b519.js"></script>
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
@ -100,7 +100,7 @@
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
<a href="#annotations" tabindex="1" class="md-skip">
<a href="../../../#annotations" tabindex="1" class="md-skip">
Skip to content
</a>
@ -205,13 +205,16 @@
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../../.." title="Welcome" class="md-tabs__link">
Welcome
</a>
</li>
<li class="md-tabs__item">
<a href="../../.." title="Welcome" class="md-tabs__link">
Welcome
</a>
</li>
@ -259,12 +262,6 @@
</ul>
</div>
</nav>
@ -315,12 +312,72 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-1" type="checkbox" id="nav-1">
<label class="md-nav__link" for="nav-1">
Welcome
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-1">
Welcome
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." title="Welcome" class="md-nav__link">
Welcome
</a>
</li>
<li class="md-nav__item">
<a href="../../../how-it-works/" title="How it works" class="md-nav__link">
How it works
</a>
</li>
<li class="md-nav__item">
<a href="../../../troubleshooting/" title="Troubleshooting" class="md-nav__link">
Troubleshooting
</a>
</li>
<li class="md-nav__item">
<a href="../../../development/" title="Development" class="md-nav__link">
Development
</a>
</li>
</ul>
</nav>
</li>
@ -383,8 +440,8 @@
<li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrading" class="md-nav__link">
Upgrading
<a href="../../../deploy/upgrade/" title="Upgrade" class="md-nav__link">
Upgrade
</a>
</li>
@ -442,8 +499,8 @@
<li class="md-nav__item">
<a href="../" title="NGINX Configuration" class="md-nav__link">
NGINX Configuration
<a href="../" title="Introduction" class="md-nav__link">
Introduction
</a>
</li>
@ -789,8 +846,8 @@
<li class="md-nav__item">
<a href="../configmap/" title="ConfigMaps" class="md-nav__link">
ConfigMaps
<a href="../configmap/" title="ConfigMap" class="md-nav__link">
ConfigMap
</a>
</li>
@ -1010,8 +1067,8 @@
<li class="md-nav__item">
<a href="../../../examples/" title="Ingress examples" class="md-nav__link">
Ingress examples
<a href="../../../examples/" title="Introduction" class="md-nav__link">
Introduction
</a>
</li>
@ -1034,8 +1091,8 @@
<li class="md-nav__item">
<a href="../../../examples/affinity/cookie/README/" title="Sticky Session" class="md-nav__link">
Sticky Session
<a href="../../../examples/affinity/cookie/" title="Sticky Sessions" class="md-nav__link">
Sticky Sessions
</a>
</li>
@ -1065,7 +1122,7 @@
<li class="md-nav__item">
<a href="../../../examples/auth/basic/README/" title="Basic Authentication" class="md-nav__link">
<a href="../../../examples/auth/basic/" title="Basic Authentication" class="md-nav__link">
Basic Authentication
</a>
</li>
@ -1077,7 +1134,7 @@
<li class="md-nav__item">
<a href="../../../examples/auth/client-certs/README/" title="Client Certificate Authentication" class="md-nav__link">
<a href="../../../examples/auth/client-certs/" title="Client Certificate Authentication" class="md-nav__link">
Client Certificate Authentication
</a>
</li>
@ -1089,7 +1146,7 @@
<li class="md-nav__item">
<a href="../../../examples/auth/external-auth/README/" title="External Basic Authentication" class="md-nav__link">
<a href="../../../examples/auth/external-auth/" title="External Basic Authentication" class="md-nav__link">
External Basic Authentication
</a>
</li>
@ -1101,7 +1158,7 @@
<li class="md-nav__item">
<a href="../../../examples/auth/oauth-external-auth/README/" title="External OAUTH Authentication" class="md-nav__link">
<a href="../../../examples/auth/oauth-external-auth/" title="External OAUTH Authentication" class="md-nav__link">
External OAUTH Authentication
</a>
</li>
@ -1137,7 +1194,7 @@
<li class="md-nav__item">
<a href="../../../examples/customization/configuration-snippets/README/" title="Configuration Snippets" class="md-nav__link">
<a href="../../../examples/customization/configuration-snippets/" title="Configuration Snippets" class="md-nav__link">
Configuration Snippets
</a>
</li>
@ -1149,7 +1206,7 @@
<li class="md-nav__item">
<a href="../../../examples/customization/custom-configuration/README/" title="Custom Configuration" class="md-nav__link">
<a href="../../../examples/customization/custom-configuration/" title="Custom Configuration" class="md-nav__link">
Custom Configuration
</a>
</li>
@ -1161,7 +1218,7 @@
<li class="md-nav__item">
<a href="../../../examples/customization/custom-errors/README/" title="Custom Errors" class="md-nav__link">
<a href="../../../examples/customization/custom-errors/" title="Custom Errors" class="md-nav__link">
Custom Errors
</a>
</li>
@ -1173,7 +1230,7 @@
<li class="md-nav__item">
<a href="../../../examples/customization/custom-headers/README/" title="Custom Headers" class="md-nav__link">
<a href="../../../examples/customization/custom-headers/" title="Custom Headers" class="md-nav__link">
Custom Headers
</a>
</li>
@ -1185,7 +1242,7 @@
<li class="md-nav__item">
<a href="../../../examples/customization/custom-upstream-check/README/" title="Custom Upstream server checks" class="md-nav__link">
<a href="../../../examples/customization/custom-upstream-check/" title="Custom Upstream server checks" class="md-nav__link">
Custom Upstream server checks
</a>
</li>
@ -1197,8 +1254,8 @@
<li class="md-nav__item">
<a href="../../../examples/customization/external-auth-headers/README/" title="External authentication, authentication service response headers propagation" class="md-nav__link">
External authentication, authentication service response headers propagation
<a href="../../../examples/customization/external-auth-headers/" title="External authentication" class="md-nav__link">
External authentication
</a>
</li>
@ -1209,7 +1266,7 @@
<li class="md-nav__item">
<a href="../../../examples/customization/ssl-dh-param/README/" title="Custom DH parameters for perfect forward secrecy" class="md-nav__link">
<a href="../../../examples/customization/ssl-dh-param/" title="Custom DH parameters for perfect forward secrecy" class="md-nav__link">
Custom DH parameters for perfect forward secrecy
</a>
</li>
@ -1221,7 +1278,7 @@
<li class="md-nav__item">
<a href="../../../examples/customization/sysctl/README/" title="Sysctl tuning" class="md-nav__link">
<a href="../../../examples/customization/sysctl/" title="Sysctl tuning" class="md-nav__link">
Sysctl tuning
</a>
</li>
@ -1238,7 +1295,7 @@
<li class="md-nav__item">
<a href="../../../examples/docker-registry/README/" title="Docker registry" class="md-nav__link">
<a href="../../../examples/docker-registry/" title="Docker registry" class="md-nav__link">
Docker registry
</a>
</li>
@ -1250,7 +1307,7 @@
<li class="md-nav__item">
<a href="../../../examples/grpc/README/" title="gRPC" class="md-nav__link">
<a href="../../../examples/grpc/" title="gRPC" class="md-nav__link">
gRPC
</a>
</li>
@ -1262,7 +1319,7 @@
<li class="md-nav__item">
<a href="../../../examples/multi-tls/README/" title="Multi TLS certificate termination" class="md-nav__link">
<a href="../../../examples/multi-tls/" title="Multi TLS certificate termination" class="md-nav__link">
Multi TLS certificate termination
</a>
</li>
@ -1274,7 +1331,7 @@
<li class="md-nav__item">
<a href="../../../examples/rewrite/README/" title="Rewrite" class="md-nav__link">
<a href="../../../examples/rewrite/" title="Rewrite" class="md-nav__link">
Rewrite
</a>
</li>
@ -1286,7 +1343,7 @@
<li class="md-nav__item">
<a href="../../../examples/static-ip/README/" title="Static IPs" class="md-nav__link">
<a href="../../../examples/static-ip/" title="Static IPs" class="md-nav__link">
Static IPs
</a>
</li>
@ -1298,7 +1355,7 @@
<li class="md-nav__item">
<a href="../../../examples/tls-termination/README/" title="TLS termination" class="md-nav__link">
<a href="../../../examples/tls-termination/" title="TLS termination" class="md-nav__link">
TLS termination
</a>
</li>
@ -1309,42 +1366,6 @@
</li>
<li class="md-nav__item">
<a href="../../../development/" title="Developing for NGINX Ingress Controller" class="md-nav__link">
Developing for NGINX Ingress Controller
</a>
</li>
<li class="md-nav__item">
<a href="../../../how-it-works/" title="How it works" class="md-nav__link">
How it works
</a>
</li>
<li class="md-nav__item">
<a href="../../../troubleshooting/" title="Troubleshooting" class="md-nav__link">
Troubleshooting
</a>
</li>
</ul>
</nav>
</div>
@ -1993,14 +2014,14 @@ Set the annotation <code class="codehilite">nginx.ingress.kubernetes.io/rewrite-
<p>If the Application Root is exposed in a different path and needs to be redirected, set the annotation <code class="codehilite">nginx.ingress.kubernetes.io/app-root</code> to redirect requests for <code class="codehilite">/</code>.</p>
<div class="admonition example">
<p class="admonition-title">Example</p>
<p>Please check the <a href="../../../examples/rewrite/README/">rewrite</a> example.</p>
<p>Please check the <a href="../../../examples/rewrite/">rewrite</a> example.</p>
</div>
<h3 id="session-affinity">Session Affinity<a class="headerlink" href="#session-affinity" title="Permanent link">&para;</a></h3>
<p>The annotation <code class="codehilite">nginx.ingress.kubernetes.io/affinity</code> enables and sets the affinity type in all Upstreams of an Ingress. This way, a request will always be directed to the same upstream server.
The only affinity type available for NGINX is <code class="codehilite">cookie</code>.</p>
<div class="admonition example">
<p class="admonition-title">Example</p>
<p>Please check the <a href="../../../examples/affinity/cookie/README/">affinity</a> example.</p>
<p>Please check the <a href="../../../examples/affinity/cookie/">affinity</a> example.</p>
</div>
<h4 id="cookie-affinity">Cookie affinity<a class="headerlink" href="#cookie-affinity" title="Permanent link">&para;</a></h4>
<p>If you use the <code class="codehilite">cookie</code> affinity type you can also specify the name of the cookie that will be used to route the requests with the annotation <code class="codehilite">nginx.ingress.kubernetes.io/session-cookie-name</code>. The default is to create a cookie named 'INGRESSCOOKIE'.</p>
@ -2029,7 +2050,7 @@ This annotation also accepts the alternative form "namespace/secretName", in whi
<div class="admonition example">
<p class="admonition-title">Example</p>
<p>Please check the <a href="../../../examples/auth/basic/README/">auth</a> example.</p>
<p>Please check the <a href="../../../examples/auth/basic/">auth</a> example.</p>
</div>
<h3 id="custom-nginx-upstream-checks">Custom NGINX upstream checks<a class="headerlink" href="#custom-nginx-upstream-checks" title="Permanent link">&para;</a></h3>
<p>NGINX exposes some flags in the <a href="http://nginx.org/en/docs/http/ngx_http_upstream_module.html#upstream">upstream configuration</a> that enable the configuration of each server in the upstream. The Ingress controller allows custom <code class="codehilite">max_fails</code> and <code class="codehilite">fail_timeout</code> parameters in a global context using <code class="codehilite">upstream-max-fails</code> and <code class="codehilite">upstream-fail-timeout</code> in the NGINX ConfigMap or in a particular Ingress rule. <code class="codehilite">upstream-max-fails</code> defaults to 0. This means NGINX will respect the container's <code class="codehilite">readinessProbe</code> if it is defined. If there is no probe and no values for <code class="codehilite">upstream-max-fails</code> NGINX will continue to send traffic to the container.</p>
@ -2048,7 +2069,7 @@ Only one of the Ingress rules should define annotations to configure the upstrea
</div>
<div class="admonition example">
<p class="admonition-title">Example</p>
<p>Please check the <a href="../../../examples/customization/custom-upstream-check/README/">custom upstream check</a> example.</p>
<p>Please check the <a href="../../../examples/customization/custom-upstream-check/">custom upstream check</a> example.</p>
</div>
<h3 id="custom-nginx-upstream-hashing">Custom NGINX upstream hashing<a class="headerlink" href="#custom-nginx-upstream-hashing" title="Permanent link">&para;</a></h3>
<p>NGINX supports load balancing by client-server mapping based on <a href="http://nginx.org/en/docs/http/ngx_http_upstream_module.html#hash">consistent hashing</a> for a given key. The key can contain text, variables or any combination thereof. This feature allows for request stickiness other than client IP or cookies. The <a href="http://www.last.fm/user/RJ/journal/2007/04/10/392555/">ketama</a> consistent hashing method will be used which ensures only a few keys would be remapped to different servers on upstream group changes.</p>
@ -2079,7 +2100,7 @@ Only one of the Ingress rules should define annotations to configure the upstrea
</ul>
<div class="admonition example">
<p class="admonition-title">Example</p>
<p>Please check the <a href="../../../examples/auth/client-certs/README/">client-certs</a> example.</p>
<p>Please check the <a href="../../../examples/auth/client-certs/">client-certs</a> example.</p>
</div>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
@ -2217,7 +2238,7 @@ applied to each location provided in the ingress rule.</p>
</ul>
<div class="admonition example">
<p class="admonition-title">Example</p>
<p>Please check the <a href="../../../examples/auth/external-auth/README/">external-auth</a> example.</p>
<p>Please check the <a href="../../../examples/auth/external-auth/">external-auth</a> example.</p>
</div>
<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.
@ -2239,12 +2260,12 @@ This can be used to mitigate <a href="https://www.nginx.com/blog/mitigating-ddos
<p>This annotation allows you to modify the status code used for permanent redirects. For example <code class="codehilite">nginx.ingress.kubernetes.io/permanent-redirect-code: &#39;308&#39;</code> would return your permanent-redirect with a 308.</p>
<h3 id="ssl-passthrough">SSL Passthrough<a class="headerlink" href="#ssl-passthrough" title="Permanent link">&para;</a></h3>
<p>The annotation <code class="codehilite">nginx.ingress.kubernetes.io/ssl-passthrough</code> instructs the controller to send TLS connections directly
to the backend instead of letting NGINX decrypt the communication. See also <a href="../../tls/#ssl-passthrough">TLS/HTTPS</a> in
to the backend instead of letting NGINX decrypt the communication. See also <a href="../tls/#ssl-passthrough">TLS/HTTPS</a> in
the User guide.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>SSL Passthrough is <strong>disabled by default</strong> and requires starting the controller with the
<a href="../../cli-arguments/"><code class="codehilite">--enable-ssl-passthrough</code></a> flag.</p>
<a href="../cli-arguments/"><code class="codehilite">--enable-ssl-passthrough</code></a> flag.</p>
</div>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
@ -2436,7 +2457,7 @@ Valid Values: HTTP, HTTPS, GRPC, GRPCS and AJP</p>
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="../" title="NGINX Configuration" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../" title="Introduction" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
</div>
@ -2445,19 +2466,19 @@ Valid Values: HTTP, HTTPS, GRPC, GRPCS and AJP</p>
<span class="md-footer-nav__direction">
Previous
</span>
NGINX Configuration
Introduction
</span>
</div>
</a>
<a href="../configmap/" title="ConfigMaps" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../configmap/" title="ConfigMap" 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">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
ConfigMaps
ConfigMap
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
@ -2487,9 +2508,9 @@ Valid Values: HTTP, HTTPS, GRPC, GRPCS and AJP</p>
</div>
<script src="../../../assets/javascripts/application.30f6b8b1.js"></script>
<script src="../../../assets/javascripts/application.583bbe55.js"></script>
<script>app.initialize({version:"0.17.5",url:{base:"../../.."}})</script>
<script>app.initialize({version:"1.0.4",url:{base:"../../.."}})</script>