Deploy GitHub Pages
This commit is contained in:
Travis Bot
parent
b3d5b69555
commit
ca7aeec8ab
51 changed files with 5886 additions and 6747 deletions
|
|
@ -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="#bare-metal-considerations" tabindex="1" class="md-skip">
|
||||
<a href="../../#bare-metal-considerations" 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>
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -451,8 +508,8 @@
|
|||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../upgrade/" title="Upgrading" class="md-nav__link">
|
||||
Upgrading
|
||||
<a href="../upgrade/" title="Upgrade" class="md-nav__link">
|
||||
Upgrade
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
|
@ -506,8 +563,8 @@
|
|||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../user-guide/nginx-configuration/" title="NGINX Configuration" class="md-nav__link">
|
||||
NGINX Configuration
|
||||
<a href="../../user-guide/nginx-configuration/" title="Introduction" class="md-nav__link">
|
||||
Introduction
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
|
@ -530,8 +587,8 @@
|
|||
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="../../user-guide/nginx-configuration/configmap/" title="ConfigMaps" class="md-nav__link">
|
||||
ConfigMaps
|
||||
<a href="../../user-guide/nginx-configuration/configmap/" title="ConfigMap" class="md-nav__link">
|
||||
ConfigMap
|
||||
</a>
|
||||
</li>
|
||||
|
||||
|
|
@ -751,8 +808,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>
|
||||
|
||||
|
|
@ -775,8 +832,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>
|
||||
|
||||
|
|
@ -806,7 +863,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>
|
||||
|
|
@ -818,7 +875,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>
|
||||
|
|
@ -830,7 +887,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>
|
||||
|
|
@ -842,7 +899,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>
|
||||
|
|
@ -878,7 +935,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>
|
||||
|
|
@ -890,7 +947,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>
|
||||
|
|
@ -902,7 +959,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>
|
||||
|
|
@ -914,7 +971,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>
|
||||
|
|
@ -926,7 +983,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>
|
||||
|
|
@ -938,8 +995,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>
|
||||
|
||||
|
|
@ -950,7 +1007,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>
|
||||
|
|
@ -962,7 +1019,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>
|
||||
|
|
@ -979,7 +1036,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>
|
||||
|
|
@ -991,7 +1048,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>
|
||||
|
|
@ -1003,7 +1060,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>
|
||||
|
|
@ -1015,7 +1072,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>
|
||||
|
|
@ -1027,7 +1084,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>
|
||||
|
|
@ -1039,7 +1096,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>
|
||||
|
|
@ -1050,42 +1107,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>
|
||||
|
|
@ -1165,8 +1186,8 @@
|
|||
suffices to provide a single point of contact to the NGINX Ingress controller to external clients and, indirectly, to
|
||||
any application running inside the cluster. <em>Bare-metal</em> environments lack this commodity, requiring a slightly
|
||||
different setup to offer the same kind of access to external consumers.</p>
|
||||
<p><img alt="Cloud environment" src="../../images/baremetal/cloud_overview.jpg" />
|
||||
<img alt="Bare-metal environment" src="../../images/baremetal/baremetal_overview.jpg" /></p>
|
||||
<p><img alt="Cloud environment" src="/images/baremetal/cloud_overview.jpg" />
|
||||
<img alt="Bare-metal environment" src="/images/baremetal/baremetal_overview.jpg" /></p>
|
||||
<p>The rest of this document describes a few recommended approaches to deploying the NGINX Ingress controller inside a
|
||||
Kubernetes cluster running on bare-metal.</p>
|
||||
<h2 id="a-pure-software-solution-metallb">A pure software solution: MetalLB<a class="headerlink" href="#a-pure-software-solution-metallb" title="Permanent link">¶</a></h2>
|
||||
|
|
@ -1175,7 +1196,7 @@ supported cloud provider, effectively allowing the usage of LoadBalancer Service
|
|||
<p>This section demonstrates how to use the <a href="https://metallb.universe.tf/tutorial/layer2/">Layer 2 configuration mode</a> of MetalLB together with the NGINX
|
||||
Ingress controller in a Kubernetes cluster that has <strong>publicly accessible nodes</strong>. In this mode, one node attracts all
|
||||
the traffic for the <code class="codehilite">ingress-nginx</code> Service IP. See <a href="https://metallb.universe.tf/usage/#traffic-policies">Traffic policies</a> for more details.</p>
|
||||
<p><img alt="MetalLB in L2 mode" src="../../images/baremetal/metallb.jpg" /></p>
|
||||
<p><img alt="MetalLB in L2 mode" src="/images/baremetal/metallb.jpg" /></p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The description of other supported configuration modes is off-scope for this document.</p>
|
||||
|
|
@ -1241,7 +1262,7 @@ well as in the next section.</p>
|
|||
</div>
|
||||
<h2 id="over-a-nodeport-service">Over a NodePort Service<a class="headerlink" href="#over-a-nodeport-service" title="Permanent link">¶</a></h2>
|
||||
<p>Due to its simplicity, this is the setup a user will deploy by default when following the steps described in the
|
||||
<a href="../deploy/#baremetal">installation guide</a>.</p>
|
||||
<a href="./deploy/#baremetal">installation guide</a>.</p>
|
||||
<div class="admonition info">
|
||||
<p class="admonition-title">Info</p>
|
||||
<p>A Service of type <code class="codehilite">NodePort</code> exposes, via the <code class="codehilite">kube-proxy</code> component, the <strong>same unprivileged</strong> port (default:
|
||||
|
|
@ -1252,7 +1273,7 @@ any port, including the standard HTTP ports 80 and 443. However, due to the cont
|
|||
located outside the cluster network (e.g. on the public internet) is not able to access Ingress hosts directly on ports
|
||||
80 and 443. Instead, the external client must append the NodePort allocated to the <code class="codehilite">ingress-nginx</code> Service to HTTP
|
||||
requests.</p>
|
||||
<p><img alt="NodePort request flow" src="../../images/baremetal/nodeport.jpg" /></p>
|
||||
<p><img alt="NodePort request flow" src="/images/baremetal/nodeport.jpg" /></p>
|
||||
<div class="admonition example">
|
||||
<p class="admonition-title">Example</p>
|
||||
<p>Given the NodePort <code class="codehilite">30100</code> allocated to the <code class="codehilite">ingress-nginx</code> Service</p>
|
||||
|
|
@ -1433,7 +1454,7 @@ of a traditional Deployment.</p>
|
|||
</div>
|
||||
<p>Because most properties of DaemonSet objects are identical to Deployment objects, this documentation page leaves the
|
||||
configuration of the corresponding manifest at the user's discretion.</p>
|
||||
<p><img alt="DaemonSet with hostNetwork flow" src="../../images/baremetal/hostnetwork.jpg" /></p>
|
||||
<p><img alt="DaemonSet with hostNetwork flow" src="/images/baremetal/hostnetwork.jpg" /></p>
|
||||
<p>Like with NodePorts, this approach has a few quirks it is important to be aware of.</p>
|
||||
<ul>
|
||||
<li><strong>DNS resolution</strong></li>
|
||||
|
|
@ -1453,7 +1474,7 @@ blank.</p>
|
|||
</pre></div>
|
||||
|
||||
<p>Instead, and because bare-metal nodes usually don't have an ExternalIP, one has to enable the
|
||||
<a href="../../../user-guide/cli-arguments/"><code class="codehilite">--report-node-internal-ip-address</code></a> flag, which sets the status of all Ingress objects to the internal IP
|
||||
<a href="../../user-guide/cli-arguments/"><code class="codehilite">--report-node-internal-ip-address</code></a> flag, which sets the status of all Ingress objects to the internal IP
|
||||
address of all nodes running the NGINX Ingress controller.</p>
|
||||
<div class="admonition example">
|
||||
<p class="admonition-title">Example</p>
|
||||
|
|
@ -1475,7 +1496,7 @@ address of all nodes running the NGINX Ingress controller.</p>
|
|||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>Alternatively, it is possible to override the address written to Ingress objects using the
|
||||
<code class="codehilite">--publish-status-address</code> flag. See <a href="../../../user-guide/cli-arguments/">Command line arguments</a>.</p>
|
||||
<code class="codehilite">--publish-status-address</code> flag. See <a href="../../user-guide/cli-arguments/">Command line arguments</a>.</p>
|
||||
</div>
|
||||
<h2 id="using-a-self-provisioned-edge">Using a self-provisioned edge<a class="headerlink" href="#using-a-self-provisioned-edge" title="Permanent link">¶</a></h2>
|
||||
<p>Similarly to cloud environments, this deployment approach requires an edge network component providing a public
|
||||
|
|
@ -1487,7 +1508,7 @@ This is particularly suitable for private Kubernetes clusters where none of the
|
|||
<p>On the edge side, the only prerequisite is to dedicate a public IP address that forwards all HTTP traffic to Kubernetes
|
||||
nodes and/or masters. Incoming traffic on TCP ports 80 and 443 is forwarded to the corresponding HTTP and HTTPS NodePort
|
||||
on the target nodes as shown in the diagram below:</p>
|
||||
<p><img alt="User edge" src="../../images/baremetal/user_edge.jpg" /></p>
|
||||
<p><img alt="User edge" src="/images/baremetal/user_edge.jpg" /></p>
|
||||
<h2 id="external-ips">External IPs<a class="headerlink" href="#external-ips" title="Permanent link">¶</a></h2>
|
||||
<div class="admonition danger">
|
||||
<p class="admonition-title">Source IP address</p>
|
||||
|
|
@ -1605,9 +1626,9 @@ and the Service port:</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>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue