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

Deploy GitHub Pages

Browse source
This commit is contained in:
Travis Bot 2019-03-08 00:36:59 +00:00
parent 33d6ce7646
commit 39f40f24fb
51 changed files with 678 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -36,7 +36,7 @@
<title>Basic usage - host based routing - NGINX Ingress Controller</title>
<title>Basic usage - NGINX Ingress Controller</title>
@ -154,7 +154,7 @@
NGINX Ingress Controller
</span>
<span class="md-header-nav__topic">
Basic usage - host based routing
Basic usage
</span>
</div>
@ -221,7 +221,9 @@
<nav class="md-tabs" data-md-component="tabs">
<nav class="md-tabs md-tabs--active" data-md-component="tabs">
<div class="md-tabs__inner md-grid">
<ul class="md-tabs__list">
@ -260,7 +262,7 @@
<li class="md-tabs__item">
<a href="../nginx-configuration/" title="User guide" class="md-tabs__link">
<a href="../nginx-configuration/" title="User guide" class="md-tabs__link md-tabs__link--active">
User guide
</a>
@ -474,10 +476,12 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>
<label class="md-nav__link" for="nav-3">
User guide
@ -493,10 +497,12 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-1" type="checkbox" id="nav-3-1">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-1" type="checkbox" id="nav-3-1" checked>
<label class="md-nav__link" for="nav-3-1">
NGINX Configuration
@ -524,6 +530,27 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<a href="./" title="Basic usage" class="md-nav__link md-nav__link--active">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
@ -1148,6 +1175,41 @@ Please note that the ingress resource should be placed inside the same namespace
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="../nginx-configuration/" 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>
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Previous
</span>
Introduction
</span>
</div>
</a>
<a href="../nginx-configuration/annotations/" title="Annotations" 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>
Annotations
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -530,6 +530,18 @@
<li class="md-nav__item">
<a href="../../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
@ -2060,10 +2072,6 @@ table below.</p>
<td>string</td>
</tr>
<tr>
<td><a href="#cookie-affinity">nginx.ingress.kubernetes.io/session-cookie-hash</a></td>
<td>string</td>
</tr>
<tr>
<td><a href="#cookie-affinity">nginx.ingress.kubernetes.io/session-cookie-path</a></td>
<td>string</td>
</tr>
@ -2231,16 +2239,7 @@ The only affinity type available for NGINX is <code class="codehilite">cookie</c
</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>
<p>In case of NGINX the annotation <code class="codehilite">nginx.ingress.kubernetes.io/session-cookie-hash</code> defines which algorithm will be used to hash the used upstream. Default value is <code class="codehilite">md5</code> and possible values are <code class="codehilite">md5</code>, <code class="codehilite">sha1</code> and <code class="codehilite">index</code>.</p>
<p>The NGINX annotation <code class="codehilite">nginx.ingress.kubernetes.io/session-cookie-path</code> defines the path that will be set on the cookie. This is optional unless the annotation <code class="codehilite">nginx.ingress.kubernetes.io/use-regex</code> is set to true; Session cookie paths do not support regex. </p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>The <code class="codehilite">index</code> option is not an actual hash; an in-memory index is used instead, which has less overhead.
However, with <code class="codehilite">index</code>, matching against a changing upstream server list is inconsistent.
So, at reload, if upstream servers have changed, index values are not guaranteed to correspond to the same server as before!
<strong>Use <code class="codehilite">index</code> with caution</strong> and only if you need to!</p>
</div>
<p>In NGINX this feature is implemented by the third party module <a href="https://bitbucket.org/nginx-goodies/nginx-sticky-module-ng">nginx-sticky-module-ng</a>. The workflow used to define which upstream server will be used is explained <a href="https://bitbucket.org/nginx-goodies/nginx-sticky-module-ng/raw/08a395c66e425540982c00482f55034e1fee67b6/docs/sticky.pdf">here</a></p>
<h3 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permanent link">&para;</a></h3>
<p>Is possible to add authentication adding additional annotations in the Ingress rule. The source of the authentication is a secret that contains usernames and passwords inside the key <code class="codehilite">auth</code>.</p>
<p>The annotations are:
@ -2737,7 +2736,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="Introduction" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<a href="../../basic-usage/" title="Basic usage" 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>
@ -2746,7 +2745,7 @@ Valid Values: HTTP, HTTPS, GRPC, GRPCS and AJP</p>
<span class="md-footer-nav__direction">
Previous
</span>
Introduction
Basic usage
</span>
</div>
</a>

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

@ -531,6 +531,18 @@
<li class="md-nav__item">
<a href="../../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -531,6 +531,18 @@
<li class="md-nav__item">
<a href="../../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -540,6 +540,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="annotations/" title="Annotations" class="md-nav__link">
Annotations
@ -1145,13 +1157,13 @@
</a>
<a href="annotations/" title="Annotations" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<a href="../basic-usage/" title="Basic usage" 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>
Annotations
Basic usage
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">

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

@ -531,6 +531,18 @@
<li class="md-nav__item">
<a href="../../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations

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

@ -529,6 +529,18 @@
<li class="md-nav__item">
<a href="../basic-usage/" title="Basic usage" class="md-nav__link">
Basic usage
</a>
</li>
<li class="md-nav__item">
<a href="../nginx-configuration/annotations/" title="Annotations" class="md-nav__link">
Annotations