Deploy GitHub Pages

This commit is contained in:
Travis Bot 2018-05-03 14:08:21 +00:00
parent a078100980
commit 467b6d7499
54 changed files with 5641 additions and 2237 deletions

View file

@ -246,7 +246,7 @@
<li class="md-tabs__item">
<a href="../../../examples/PREREQUISITES/" title="Examples" class="md-tabs__link">
<a href="../../../examples/" title="Examples" class="md-tabs__link">
Examples
</a>
@ -360,6 +360,18 @@
</li>
<li class="md-nav__item">
<a href="../../../deploy/upgrade/" title="Upgrading" class="md-nav__link">
Upgrading
</a>
</li>
</ul>
</nav>
</li>
@ -510,6 +522,18 @@
<li class="md-nav__item">
<a href="../../default-backend/" title="Default backend" class="md-nav__link">
Default backend
</a>
</li>
<li class="md-nav__item">
<a href="../../exposing-tcp-udp-services/" title="Exposing TCP and UDP services" class="md-nav__link">
Exposing TCP and UDP services
@ -547,8 +571,8 @@
<li class="md-nav__item">
<a href="../../multiple-ingress/" title="Multiple ingress controllers" class="md-nav__link">
Multiple ingress controllers
<a href="../../multiple-ingress/" title="Multiple Ingress controllers" class="md-nav__link">
Multiple Ingress controllers
</a>
</li>
@ -571,8 +595,8 @@
<li class="md-nav__item">
<a href="../../tls/" title="TLS" class="md-nav__link">
TLS
<a href="../../tls/" title="TLS/HTTPS" class="md-nav__link">
TLS/HTTPS
</a>
</li>
@ -584,13 +608,13 @@
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-10" type="checkbox" id="nav-3-10">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3-11" type="checkbox" id="nav-3-11">
<label class="md-nav__link" for="nav-3-10">
<label class="md-nav__link" for="nav-3-11">
Third party addons
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
<label class="md-nav__title" for="nav-3-10">
<label class="md-nav__title" for="nav-3-11">
Third party addons
</label>
<ul class="md-nav__list" data-md-scrollfix>
@ -655,8 +679,8 @@
<li class="md-nav__item">
<a href="../../../examples/PREREQUISITES/" title="Prerequisites" class="md-nav__link">
Prerequisites
<a href="../../../examples/" title="Ingress examples" class="md-nav__link">
Ingress examples
</a>
</li>
@ -667,8 +691,8 @@
<li class="md-nav__item">
<a href="../../../examples/README/" title="Ingress examples" class="md-nav__link">
Ingress examples
<a href="../../../examples/PREREQUISITES/" title="Prerequisites" class="md-nav__link">
Prerequisites
</a>
</li>
@ -740,6 +764,18 @@
</li>
<li class="md-nav__item">
<a href="../../../examples/auth/oauth-external-auth/README/" title="External Authentication" class="md-nav__link">
External Authentication
</a>
</li>
</ul>
</nav>
</li>
@ -830,8 +866,8 @@
<li class="md-nav__item">
<a href="../../../examples/customization/custom-vts-metrics-prometheus/README/" title="Deploying the Nginx Ingress controller" class="md-nav__link">
Deploying the Nginx Ingress controller
<a href="../../../examples/customization/custom-vts-metrics-prometheus/README/" title="Custom VTS metrics with Prometheus" class="md-nav__link">
Custom VTS metrics with Prometheus
</a>
</li>
@ -854,8 +890,8 @@
<li class="md-nav__item">
<a href="../../../examples/customization/ssl-dh-param/README/" title="Deploying the Nginx Ingress controller" class="md-nav__link">
Deploying the Nginx Ingress controller
<a href="../../../examples/customization/ssl-dh-param/README/" title="Custom DH parameters for perfect forward secrecy" class="md-nav__link">
Custom DH parameters for perfect forward secrecy
</a>
</li>
@ -894,18 +930,6 @@
<li class="md-nav__item">
<a href="../../../examples/external-auth/README/" title="External Authentication" class="md-nav__link">
External Authentication
</a>
</li>
<li class="md-nav__item">
<a href="../../../examples/multi-tls/README/" title="Multi TLS certificate termination" class="md-nav__link">
Multi TLS certificate termination
@ -1021,37 +1045,98 @@
<h1 id="log-format">Log format<a class="headerlink" href="#log-format" title="Permanent link">&para;</a></h1>
<p>The default configuration uses a custom logging format to add additional information about upstreams, response time and status</p>
<div class="codehilite"><pre><span></span><span class="x"> log_format upstreaminfo &#39;</span><span class="cp">{{</span> <span class="k">if</span> <span class="err">$</span><span class="nv">cfg.useProxyProtocol</span> <span class="cp">}}</span><span class="x">$proxy_protocol_addr</span><span class="cp">{{</span> <span class="k">else</span> <span class="cp">}}</span><span class="x">$remote_addr</span><span class="cp">{{</span> <span class="nv">end</span> <span class="cp">}}</span><span class="x"> - &#39;</span>
<span class="x"> &#39;[$the_real_ip] - $remote_user [$time_local] &quot;$request&quot; $status $body_bytes_sent &quot;$http_referer&quot; &quot;$http_user_agent&quot; &#39;</span>
<span class="x"> &#39;$request_length $request_time [$proxy_upstream_name] $upstream_addr $upstream_response_length $upstream_response_time $upstream_status&#39;;</span>
<p>The default configuration uses a custom logging format to add additional information about upstreams, response time and status.</p>
<div class="codehilite"><pre><span></span><span class="x">log_format upstreaminfo</span>
<span class="x"> &#39;</span><span class="cp">{{</span> <span class="k">if</span> <span class="err">$</span><span class="nv">cfg.useProxyProtocol</span> <span class="cp">}}</span><span class="x">$proxy_protocol_addr</span><span class="cp">{{</span> <span class="k">else</span> <span class="cp">}}</span><span class="x">$remote_addr</span><span class="cp">{{</span> <span class="nv">end</span> <span class="cp">}}</span><span class="x"> - &#39;</span>
<span class="x"> &#39;[$the_real_ip] - $remote_user [$time_local] &quot;$request&quot; &#39;</span>
<span class="x"> &#39;$status $body_bytes_sent &quot;$http_referer&quot; &quot;$http_user_agent&quot; &#39;</span>
<span class="x"> &#39;$request_length $request_time [$proxy_upstream_name] $upstream_addr &#39;</span>
<span class="x"> &#39;$upstream_response_length $upstream_response_time $upstream_status&#39;;</span>
</pre></div>
<table>
<thead>
<tr>
<th>Placeholder</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code class="codehilite">$proxy_protocol_addr</code></td>
<td>remote address if proxy protocol is enabled</td>
</tr>
<tr>
<td><code class="codehilite">$remote_addr</code></td>
<td>remote address if proxy protocol is disabled (default)</td>
</tr>
<tr>
<td><code class="codehilite">$the_real_ip</code></td>
<td>the source IP address of the client</td>
</tr>
<tr>
<td><code class="codehilite">$remote_user</code></td>
<td>user name supplied with the Basic authentication</td>
</tr>
<tr>
<td><code class="codehilite">$time_local</code></td>
<td>local time in the Common Log Format</td>
</tr>
<tr>
<td><code class="codehilite">$request</code></td>
<td>full original request line</td>
</tr>
<tr>
<td><code class="codehilite">$status</code></td>
<td>response status</td>
</tr>
<tr>
<td><code class="codehilite">$body_bytes_sent</code></td>
<td>number of bytes sent to a client, not counting the response header</td>
</tr>
<tr>
<td><code class="codehilite">$http_referer</code></td>
<td>value of the Referer header</td>
</tr>
<tr>
<td><code class="codehilite">$http_user_agent</code></td>
<td>value of User-Agent header</td>
</tr>
<tr>
<td><code class="codehilite">$request_length</code></td>
<td>request length (including request line, header, and request body)</td>
</tr>
<tr>
<td><code class="codehilite">$request_time</code></td>
<td>time elapsed since the first bytes were read from the client</td>
</tr>
<tr>
<td><code class="codehilite">$proxy_upstream_name</code></td>
<td>name of the upstream. The format is <code class="codehilite">upstream-&lt;namespace&gt;-&lt;service name&gt;-&lt;service port&gt;</code></td>
</tr>
<tr>
<td><code class="codehilite">$upstream_addr</code></td>
<td>the IP address and port (or the path to the domain socket) of the upstream server. If several servers were contacted during request processing, their addresses are separated by commas.</td>
</tr>
<tr>
<td><code class="codehilite">$upstream_response_length</code></td>
<td>the length of the response obtained from the upstream server</td>
</tr>
<tr>
<td><code class="codehilite">$upstream_response_time</code></td>
<td>time spent on receiving the response from the upstream server as seconds with millisecond resolution</td>
</tr>
<tr>
<td><code class="codehilite">$upstream_status</code></td>
<td>status code of the response obtained from the upstream server</td>
</tr>
</tbody>
</table>
<p>Sources:</p>
<ul>
<li><a href="http://nginx.org/en/docs/http/ngx_http_upstream_module.html#variables">upstream variables</a></li>
<li><a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#variables">embedded variables</a></li>
</ul>
<p>Description:</p>
<ul>
<li><code class="codehilite">$proxy_protocol_addr</code>: if PROXY protocol is enabled</li>
<li><code class="codehilite">$remote_addr</code>: if PROXY protocol is disabled (default)</li>
<li><code class="codehilite">$the_real_ip</code>: the source IP address of the client</li>
<li><code class="codehilite">$remote_user</code>: user name supplied with the Basic authentication</li>
<li><code class="codehilite">$time_local</code>: local time in the Common Log Format</li>
<li><code class="codehilite">$request</code>: full original request line</li>
<li><code class="codehilite">$status</code>: response status</li>
<li><code class="codehilite">$body_bytes_sent</code>: number of bytes sent to a client, not counting the response header</li>
<li><code class="codehilite">$http_referer</code>: value of the Referer header</li>
<li><code class="codehilite">$http_user_agent</code>: value of User-Agent header</li>
<li><code class="codehilite">$request_length</code>: request length (including request line, header, and request body)</li>
<li><code class="codehilite">$request_time</code>: time elapsed since the first bytes were read from the client</li>
<li><code class="codehilite">$proxy_upstream_name</code>: name of the upstream. The format is <code class="codehilite">upstream-&lt;namespace&gt;-&lt;service name&gt;-&lt;service port&gt;</code></li>
<li><code class="codehilite">$upstream_addr</code>: keeps the IP address and port, or the path to the UNIX-domain socket of the upstream server. If several servers were contacted during request processing, their addresses are separated by commas</li>
<li><code class="codehilite">$upstream_response_length</code>: keeps the length of the response obtained from the upstream server</li>
<li><code class="codehilite">$upstream_response_time</code>: keeps time spent on receiving the response from the upstream server; the time is kept in seconds with millisecond resolution</li>
<li><code class="codehilite">$upstream_status</code>: keeps status code of the response obtained from the upstream server</li>
<li><a href="http://nginx.org/en/docs/http/ngx_http_upstream_module.html#variables">Upstream variables</a></li>
<li><a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#variables">Embedded variables</a></li>
</ul>