Deploy GitHub Pages

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

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="#command-line-arguments" tabindex="1" class="md-skip">
<a href="../../#command-line-arguments" 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>
@ -440,8 +497,8 @@
<li class="md-nav__item">
<a href="../nginx-configuration/" title="NGINX Configuration" class="md-nav__link">
NGINX Configuration
<a href="../nginx-configuration/" title="Introduction" class="md-nav__link">
Introduction
</a>
</li>
@ -464,8 +521,8 @@
<li class="md-nav__item">
<a href="../nginx-configuration/configmap/" title="ConfigMaps" class="md-nav__link">
ConfigMaps
<a href="../nginx-configuration/configmap/" title="ConfigMap" class="md-nav__link">
ConfigMap
</a>
</li>
@ -694,8 +751,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>
@ -718,8 +775,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>
@ -749,7 +806,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>
@ -761,7 +818,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>
@ -773,7 +830,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>
@ -785,7 +842,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>
@ -821,7 +878,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>
@ -833,7 +890,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>
@ -845,7 +902,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>
@ -857,7 +914,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>
@ -869,7 +926,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>
@ -881,8 +938,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>
@ -893,7 +950,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>
@ -905,7 +962,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>
@ -922,7 +979,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>
@ -934,7 +991,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>
@ -946,7 +1003,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>
@ -958,7 +1015,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>
@ -970,7 +1027,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>
@ -982,7 +1039,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>
@ -993,42 +1050,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>
@ -1061,7 +1082,7 @@
<h1 id="command-line-arguments">Command line arguments<a class="headerlink" href="#command-line-arguments" title="Permanent link">&para;</a></h1>
<p>The following command line arguments are accepted by the Ingress controller executable.</p>
<p>They are set in the container spec of the <code class="codehilite">nginx-ingress-controller</code> Deployment manifest (see <code class="codehilite">deploy/with-rbac.yaml</code> or <code class="codehilite">deploy/without-rbac.yaml</code>).</p>
<p>They are set in the container spec of the <code class="codehilite">nginx-ingress-controller</code> Deployment manifest</p>
<table>
<thead>
<tr>
@ -1071,163 +1092,163 @@
</thead>
<tbody>
<tr>
<td>--alsologtostderr</td>
<td><code class="codehilite">--alsologtostderr</code></td>
<td>log to standard error as well as files</td>
</tr>
<tr>
<td>--annotations-prefix string</td>
<td><code class="codehilite">--annotations-prefix string</code></td>
<td>Prefix of the Ingress annotations specific to the NGINX controller. (default "nginx.ingress.kubernetes.io")</td>
</tr>
<tr>
<td>--apiserver-host string</td>
<td><code class="codehilite">--apiserver-host string</code></td>
<td>Address of the Kubernetes API server. Takes the form "protocol://address:port". If not specified, it is assumed the program runs inside a Kubernetes cluster and local discovery is attempted.</td>
</tr>
<tr>
<td>--configmap string</td>
<td><code class="codehilite">--configmap string</code></td>
<td>Name of the ConfigMap containing custom global configurations for the controller.</td>
</tr>
<tr>
<td>--default-backend-service string</td>
<td><code class="codehilite">--default-backend-service string</code></td>
<td>Service used to serve HTTP requests not matching any known server name (catch-all). Takes the form "namespace/name". The controller configures NGINX to forward requests to the first port of this Service.</td>
</tr>
<tr>
<td>--default-server-port int</td>
<td><code class="codehilite">--default-server-port int</code></td>
<td>Port to use for exposing the default server (catch-all). (default 8181)</td>
</tr>
<tr>
<td>--default-ssl-certificate string</td>
<td><code class="codehilite">--default-ssl-certificate string</code></td>
<td>Secret containing a SSL certificate to be used by the default HTTPS server (catch-all). Takes the form "namespace/name".</td>
</tr>
<tr>
<td>--election-id string</td>
<td><code class="codehilite">--election-id string</code></td>
<td>Election id to use for Ingress status updates. (default "ingress-controller-leader")</td>
</tr>
<tr>
<td>--enable-dynamic-configuration</td>
<td>Dynamically refresh backends on topology changes instead of reloading NGINX. Feature backed by OpenResty Lua libraries. (enabled by default)</td>
</tr>
<tr>
<td>--enable-dynamic-certificates</td>
<td><code class="codehilite">--enable-dynamic-certificates</code></td>
<td>Dynamically serves certificates instead of reloading NGINX when certificates are created, updated, or deleted. Currently does not support OCSP stapling, so --enable-ssl-chain-completion must be turned off. Assuming the certificate is generated with a 2048 bit RSA key/cert pair, this feature can store roughly 5000 certificates. This is an experiemental feature that currently is not ready for production use. Feature backed by OpenResty Lua libraries. (disabled by default)</td>
</tr>
<tr>
<td>--enable-ssl-chain-completion</td>
<td><code class="codehilite">--enable-dynamic-configuration</code></td>
<td>Dynamically refresh backends on topology changes instead of reloading NGINX. Feature backed by OpenResty Lua libraries. (default true)</td>
</tr>
<tr>
<td><code class="codehilite">--enable-ssl-chain-completion</code></td>
<td>Autocomplete SSL certificate chains with missing intermediate CA certificates. A valid certificate chain is required to enable OCSP stapling. Certificates uploaded to Kubernetes must have the "Authority Information Access" X.509 v3 extension for this to succeed. (default true)</td>
</tr>
<tr>
<td>--enable-ssl-passthrough</td>
<td><code class="codehilite">--enable-ssl-passthrough</code></td>
<td>Enable SSL Passthrough.</td>
</tr>
<tr>
<td>--force-namespace-isolation</td>
<td><code class="codehilite">--force-namespace-isolation</code></td>
<td>Force namespace isolation. Prevents Ingress objects from referencing Secrets and ConfigMaps located in a different namespace than their own. May be used together with watch-namespace.</td>
</tr>
<tr>
<td>--health-check-path string</td>
<td><code class="codehilite">--health-check-path string</code></td>
<td>URL path of the health check endpoint. Configured inside the NGINX status server. All requests received on the port defined by the healthz-port parameter are forwarded internally to this path. (default "/healthz")</td>
</tr>
<tr>
<td>--healthz-port int</td>
<td><code class="codehilite">--healthz-port int</code></td>
<td>Port to use for the healthz endpoint. (default 10254)</td>
</tr>
<tr>
<td>--http-port int</td>
<td><code class="codehilite">--http-port int</code></td>
<td>Port to use for servicing HTTP traffic. (default 80)</td>
</tr>
<tr>
<td>--https-port int</td>
<td><code class="codehilite">--https-port int</code></td>
<td>Port to use for servicing HTTPS traffic. (default 443)</td>
</tr>
<tr>
<td>--ingress-class string</td>
<td><code class="codehilite">--ingress-class string</code></td>
<td>Name of the ingress class this controller satisfies. The class of an Ingress object is set using the annotation "kubernetes.io/ingress.class". All ingress classes are satisfied if this parameter is left empty.</td>
</tr>
<tr>
<td>--kubeconfig string</td>
<td><code class="codehilite">--kubeconfig string</code></td>
<td>Path to a kubeconfig file containing authorization and API server information.</td>
</tr>
<tr>
<td>--log_backtrace_at traceLocation</td>
<td><code class="codehilite">--log_backtrace_at traceLocation</code></td>
<td>when logging hits line file:N, emit a stack trace (default :0)</td>
</tr>
<tr>
<td>--log_dir string</td>
<td><code class="codehilite">--log_dir string</code></td>
<td>If non-empty, write log files in this directory</td>
</tr>
<tr>
<td>--logtostderr</td>
<td><code class="codehilite">--logtostderr</code></td>
<td>log to standard error instead of files (default true)</td>
</tr>
<tr>
<td>--profiling</td>
<td><code class="codehilite">--profiling</code></td>
<td>Enable profiling via web interface host:port/debug/pprof/ (default true)</td>
</tr>
<tr>
<td>--publish-service string</td>
<td><code class="codehilite">--publish-service string</code></td>
<td>Service fronting the Ingress controller. Takes the form "namespace/name". When used together with update-status, the controller mirrors the address of this service's endpoints to the load-balancer status of all Ingress objects it satisfies.</td>
</tr>
<tr>
<td>--publish-status-address string</td>
<td><code class="codehilite">--publish-status-address string</code></td>
<td>Customized address to set as the load-balancer status of Ingress objects this controller satisfies. Requires the update-status parameter.</td>
</tr>
<tr>
<td>--report-node-internal-ip-address</td>
<td><code class="codehilite">--report-node-internal-ip-address</code></td>
<td>Set the load-balancer status of Ingress objects to internal Node addresses instead of external. Requires the update-status parameter.</td>
</tr>
<tr>
<td>--sort-backends</td>
<td><code class="codehilite">--sort-backends</code></td>
<td>Sort servers inside NGINX upstreams.</td>
</tr>
<tr>
<td>--ssl-passthrough-proxy-port int</td>
<td><code class="codehilite">--ssl-passthrough-proxy-port int</code></td>
<td>Port to use internally for SSL Passthrough. (default 442)</td>
</tr>
<tr>
<td>--status-port int</td>
<td><code class="codehilite">--status-port int</code></td>
<td>Port to use for exposing NGINX status pages. (default 18080)</td>
</tr>
<tr>
<td>--stderrthreshold severity</td>
<td><code class="codehilite">--stderrthreshold severity</code></td>
<td>logs at or above this threshold go to stderr (default 2)</td>
</tr>
<tr>
<td>--sync-period duration</td>
<td>Period at which the controller forces the repopulation of its local object stores. (default is 0)</td>
<td><code class="codehilite">--sync-period duration</code></td>
<td>Period at which the controller forces the repopulation of its local object stores. Disabled by default.</td>
</tr>
<tr>
<td>--sync-rate-limit float32</td>
<td><code class="codehilite">--sync-rate-limit float32</code></td>
<td>Define the sync frequency upper limit (default 0.3)</td>
</tr>
<tr>
<td>--tcp-services-configmap string</td>
<td><code class="codehilite">--tcp-services-configmap string</code></td>
<td>Name of the ConfigMap containing the definition of the TCP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port number or name. TCP ports 80 and 443 are reserved by the controller for servicing HTTP traffic.</td>
</tr>
<tr>
<td>--udp-services-configmap string</td>
<td><code class="codehilite">--udp-services-configmap string</code></td>
<td>Name of the ConfigMap containing the definition of the UDP services to expose. The key in the map indicates the external port to be used. The value is a reference to a Service in the form "namespace/name:port", where "port" can either be a port name or number.</td>
</tr>
<tr>
<td>--update-status</td>
<td><code class="codehilite">--update-status</code></td>
<td>Update the load-balancer status of Ingress objects this controller satisfies. Requires setting the publish-service parameter to a valid Service reference. (default true)</td>
</tr>
<tr>
<td>--update-status-on-shutdown</td>
<td><code class="codehilite">--update-status-on-shutdown</code></td>
<td>Update the load-balancer status of Ingress objects when the controller shuts down. Requires the update-status parameter. (default true)</td>
</tr>
<tr>
<td>--v Level</td>
<td><code class="codehilite">-v</code>, <code class="codehilite">--v Level</code></td>
<td>log level for V logs</td>
</tr>
<tr>
<td>--version</td>
<td><code class="codehilite">--version</code></td>
<td>Show release information about the NGINX Ingress controller and exit.</td>
</tr>
<tr>
<td>--vmodule moduleSpec</td>
<td><code class="codehilite">--vmodule moduleSpec</code></td>
<td>comma-separated list of pattern=N settings for file-filtered logging</td>
</tr>
<tr>
<td>--watch-namespace string</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>
</tr>
</tbody>
@ -1303,9 +1324,9 @@
</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>