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 2020-02-09 23:53:05 +00:00
parent ec2af1dbc3
commit 006cda8fee
62 changed files with 1885 additions and 1843 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -34,7 +34,7 @@
<meta name="lang:search.tokenizer" content="[\s\-]+">
<link rel="shortcut icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.3">
<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.2">
@ -42,7 +42,7 @@
<link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css">
<link rel="stylesheet" href="../../assets/stylesheets/application.adb8469c.css">
<link rel="stylesheet" href="../../assets/stylesheets/application-palette.a8b3c06d.css">
@ -53,12 +53,12 @@
<script src="../../assets/javascripts/modernizr.74668098.js"></script>
<script src="../../assets/javascripts/modernizr.86422ebf.js"></script>
<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&display=fallback">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
@ -114,7 +114,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="#custom-errors" tabindex="1" class="md-skip">
<a href="#custom-errors" tabindex="0" class="md-skip">
Skip to content
</a>
@ -123,7 +123,7 @@
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href="https://kubernetes.github.io/ingress-nginx" title="NGINX Ingress Controller" class="md-header-nav__button md-logo">
<a href="https://kubernetes.github.io/ingress-nginx" title="NGINX Ingress Controller" aria-label="NGINX Ingress Controller" class="md-header-nav__button md-logo">
<i class="md-icon">public</i>
@ -154,7 +154,7 @@
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
<input type="text" class="md-search__input" aria-label="search" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
<label class="md-icon md-search__icon" for="__search"></label>
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
&#xE5CD;
@ -1149,8 +1149,8 @@
<h1 id="custom-errors">Custom errors<a class="headerlink" href="#custom-errors" title="Permanent link"></a></h1>
<p>When the <a href="../nginx-configuration/configmap/#custom-http-errors"><code class="codehilite">custom-http-errors</code></a> option is enabled, the Ingress controller configures NGINX so
that it passes several HTTP headers down to its <code class="codehilite">default-backend</code> in case of error:</p>
<p>When the <a href="../nginx-configuration/configmap/#custom-http-errors"><code class="codehilite"><span class="err">custom-http-errors</span></code></a> option is enabled, the Ingress controller configures NGINX so
that it passes several HTTP headers down to its <code class="codehilite"><span class="err">default-backend</span></code> in case of error:</p>
<table>
<thead>
<tr>
@ -1160,45 +1160,45 @@ that it passes several HTTP headers down to its <code class="codehilite">default
</thead>
<tbody>
<tr>
<td><code class="codehilite">X-Code</code></td>
<td><code class="codehilite"><span class="err">X-Code</span></code></td>
<td>HTTP status code retuned by the request</td>
</tr>
<tr>
<td><code class="codehilite">X-Format</code></td>
<td>Value of the <code class="codehilite">Accept</code> header sent by the client</td>
<td><code class="codehilite"><span class="err">X-Format</span></code></td>
<td>Value of the <code class="codehilite"><span class="err">Accept</span></code> header sent by the client</td>
</tr>
<tr>
<td><code class="codehilite">X-Original-URI</code></td>
<td><code class="codehilite"><span class="err">X-Original-URI</span></code></td>
<td>URI that caused the error</td>
</tr>
<tr>
<td><code class="codehilite">X-Namespace</code></td>
<td><code class="codehilite"><span class="err">X-Namespace</span></code></td>
<td>Namespace where the backend Service is located</td>
</tr>
<tr>
<td><code class="codehilite">X-Ingress-Name</code></td>
<td><code class="codehilite"><span class="err">X-Ingress-Name</span></code></td>
<td>Name of the Ingress where the backend is defined</td>
</tr>
<tr>
<td><code class="codehilite">X-Service-Name</code></td>
<td><code class="codehilite"><span class="err">X-Service-Name</span></code></td>
<td>Name of the Service backing the backend</td>
</tr>
<tr>
<td><code class="codehilite">X-Service-Port</code></td>
<td><code class="codehilite"><span class="err">X-Service-Port</span></code></td>
<td>Port number of the Service backing the backend</td>
</tr>
<tr>
<td><code class="codehilite">X-Request-ID</code></td>
<td><code class="codehilite"><span class="err">X-Request-ID</span></code></td>
<td>Unique ID that identifies the request - same as for backend service</td>
</tr>
</tbody>
</table>
<p>A custom error backend can use this information to return the best possible representation of an error page. For
example, if the value of the <code class="codehilite">Accept</code> header send by the client was <code class="codehilite">application/json</code>, a carefully crafted backend
example, if the value of the <code class="codehilite"><span class="err">Accept</span></code> header send by the client was <code class="codehilite"><span class="err">application/json</span></code>, a carefully crafted backend
could decide to return the error payload as a JSON document instead of HTML.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>The custom backend is expected to return the correct HTTP status code instead of <code class="codehilite">200</code>.
<p>The custom backend is expected to return the correct HTTP status code instead of <code class="codehilite"><span class="err">200</span></code>.
NGINX does not change the response from the custom default backend.</p>
</div>
<p>An example of such custom backend is available inside the source repository at <a href="https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages">images/custom-error-pages</a>.</p>
@ -1206,6 +1206,7 @@ NGINX does not change the response from the custom default backend.</p>
@ -1260,9 +1261,9 @@ NGINX does not change the response from the custom default backend.</p>
<div class="md-footer-copyright">
powered by
<a href="https://www.mkdocs.org">MkDocs</a>
<a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>
and
<a href="https://squidfunk.github.io/mkdocs-material/">
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs</a>
</div>
@ -1272,7 +1273,7 @@ NGINX does not change the response from the custom default backend.</p>
</div>
<script src="../../assets/javascripts/application.ac79c3b0.js"></script>
<script src="../../assets/javascripts/application.c33a9706.js"></script>
<script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>