From ca7aeec8abcd9e46dd7b43e87f6541db9c3412d1 Mon Sep 17 00:00:00 2001
From: Travis Bot
+
+
+
+
+
+
+
+
-
+
The rest of this document describes a few recommended approaches to deploying the NGINX Ingress controller inside a Kubernetes cluster running on bare-metal.
This section demonstrates how to use the Layer 2 configuration mode of MetalLB together with the NGINX
Ingress controller in a Kubernetes cluster that has publicly accessible nodes. In this mode, one node attracts all
the traffic for the ingress-nginx
Service IP. See Traffic policies for more details.
Note
The description of other supported configuration modes is off-scope for this document.
@@ -1241,7 +1262,7 @@ well as in the next section.Due to its simplicity, this is the setup a user will deploy by default when following the steps described in the -installation guide.
+installation guide.Info
A Service of type NodePort
exposes, via the kube-proxy
component, the same unprivileged 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 ingress-nginx
Service to HTTP
requests.
Example
Given the NodePort 30100
allocated to the ingress-nginx
Service
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.
-Like with NodePorts, this approach has a few quirks it is important to be aware of.
Instead, and because bare-metal nodes usually don't have an ExternalIP, one has to enable the
---report-node-internal-ip-address
flag, which sets the status of all Ingress objects to the internal IP
+--report-node-internal-ip-address
flag, which sets the status of all Ingress objects to the internal IP
address of all nodes running the NGINX Ingress controller.
Example
@@ -1475,7 +1496,7 @@ address of all nodes running the NGINX Ingress controller.Note
Alternatively, it is possible to override the address written to Ingress objects using the
---publish-status-address
flag. See Command line arguments.
--publish-status-address
flag. See Command line arguments.
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
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:
-Source IP address
@@ -1605,9 +1626,9 @@ and the Service port:In some scenarios users will need to modify the value of the ELB idle timeout. Users need to ensure the idle timeout is less than the keepalive_timeout that is configured for NGINX. By default NGINX keepalive_timeout
is set to 75s
.
The default ELB idle timeout will work for most scenarios, unless the NGINX keepalive_timeout has been modified, in which case service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout
will need to be modified to ensure it is less than the keepalive_timeout
the user has configured.
my-nginx
-
+
@@ -1525,7 +1546,7 @@ To install the chart with the release name my-nginx
Previous
- Welcome
+ Development
@@ -1567,9 +1588,9 @@ To install the chart with the release name my-nginx
-
+
-
+
diff --git a/deploy/rbac/index.html b/deploy/rbac/index.html
index b42a86ea0..ffe18cee2 100644
--- a/deploy/rbac/index.html
+++ b/deploy/rbac/index.html
@@ -32,7 +32,7 @@
-
+
@@ -54,8 +54,8 @@
-
+
@@ -100,7 +100,7 @@
-
+
Skip to content
@@ -205,13 +205,16 @@
- -
-
-
- Welcome
-
-
-
+
+
+ -
+
+
+ Welcome
+
+
+
+
@@ -259,12 +262,6 @@
-
-
-
-
-
-
@@ -315,12 +312,72 @@
+
+
+
+
+
+ Welcome
+
+
+
+ Welcome
+
+
+
+
+
+
+
+
+
-
Welcome
+
+
+
+
+
+
+ -
+
+ How it works
+
+
+
+
+
+
+
+
+
+ -
+
+ Troubleshooting
+
+
+
+
+
+
+
+
+
+ -
+
+ Development
+
+
+
+
+
+
+
+
@@ -464,8 +521,8 @@
-
- Upgrading
+
+ Upgrade
@@ -519,8 +576,8 @@
-
- NGINX Configuration
+
+ Introduction
@@ -543,8 +600,8 @@
-
- ConfigMaps
+
+ ConfigMap
@@ -764,8 +821,8 @@
-
- Ingress examples
+
+ Introduction
@@ -788,8 +845,8 @@
-
- Sticky Session
+
+ Sticky Sessions
@@ -819,7 +876,7 @@
-
+
Basic Authentication
@@ -831,7 +888,7 @@
-
+
Client Certificate Authentication
@@ -843,7 +900,7 @@
-
+
External Basic Authentication
@@ -855,7 +912,7 @@
-
+
External OAUTH Authentication
@@ -891,7 +948,7 @@
-
+
Configuration Snippets
@@ -903,7 +960,7 @@
-
+
Custom Configuration
@@ -915,7 +972,7 @@
-
+
Custom Errors
@@ -927,7 +984,7 @@
-
+
Custom Headers
@@ -939,7 +996,7 @@
-
+
Custom Upstream server checks
@@ -951,8 +1008,8 @@
-
- External authentication, authentication service response headers propagation
+
+ External authentication
@@ -963,7 +1020,7 @@
-
+
Custom DH parameters for perfect forward secrecy
@@ -975,7 +1032,7 @@
-
+
Sysctl tuning
@@ -992,7 +1049,7 @@
-
+
Docker registry
@@ -1004,7 +1061,7 @@
-
+
gRPC
@@ -1016,7 +1073,7 @@
-
+
Multi TLS certificate termination
@@ -1028,7 +1085,7 @@
-
+
Rewrite
@@ -1040,7 +1097,7 @@
-
+
Static IPs
@@ -1052,7 +1109,7 @@
-
+
TLS termination
@@ -1063,42 +1120,6 @@
-
-
-
-
-
-
-
- Developing for NGINX Ingress Controller
-
-
-
-
-
-
-
-
-
-
-
- How it works
-
-
-
-
-
-
-
-
-
-
-
- Troubleshooting
-
-
-
-
@@ -1285,13 +1306,13 @@ container arguments, and POD_NAMESPACE should be in the nginx-ingress namespace.
-
+
Next
- Upgrading
+ Upgrade
@@ -1321,9 +1342,9 @@ container arguments, and POD_NAMESPACE should be in the nginx-ingress namespace.
-
+
-
+
diff --git a/deploy/upgrade/index.html b/deploy/upgrade/index.html
index 345570a7a..9223a10df 100644
--- a/deploy/upgrade/index.html
+++ b/deploy/upgrade/index.html
@@ -32,11 +32,11 @@
-
+
- Upgrading - NGINX Ingress Controller
+ Upgrade - NGINX Ingress Controller
@@ -54,8 +54,8 @@
-
+
@@ -100,7 +100,7 @@
-
+
Skip to content
@@ -126,7 +126,7 @@
NGINX Ingress Controller
- Upgrading
+ Upgrade
@@ -205,13 +205,16 @@
- -
-
-
- Welcome
-
-
-
+
+
+ -
+
+
+ Welcome
+
+
+
+
@@ -259,12 +262,6 @@
-
-
-
-
-
-
@@ -315,12 +312,72 @@
+
+
+
+
+
+ Welcome
+
+
+
+ Welcome
+
+
+
+
+
+
+
+
+
-
Welcome
+
+
+
+
+
+
+ -
+
+ How it works
+
+
+
+
+
+
+
+
+
+ -
+
+ Troubleshooting
+
+
+
+
+
+
+
+
+
+ -
+
+ Development
+
+
+
+
+
+
+
+
@@ -394,11 +451,11 @@
- Upgrading
+ Upgrade
-
- Upgrading
+
+ Upgrade
@@ -485,8 +542,8 @@
-
- NGINX Configuration
+
+ Introduction
@@ -509,8 +566,8 @@
-
- ConfigMaps
+
+ ConfigMap
@@ -730,8 +787,8 @@
-
- Ingress examples
+
+ Introduction
@@ -754,8 +811,8 @@
-
- Sticky Session
+
+ Sticky Sessions
@@ -785,7 +842,7 @@
-
+
Basic Authentication
@@ -797,7 +854,7 @@
-
+
Client Certificate Authentication
@@ -809,7 +866,7 @@
-
+
External Basic Authentication
@@ -821,7 +878,7 @@
-
+
External OAUTH Authentication
@@ -857,7 +914,7 @@
-
+
Configuration Snippets
@@ -869,7 +926,7 @@
-
+
Custom Configuration
@@ -881,7 +938,7 @@
-
+
Custom Errors
@@ -893,7 +950,7 @@
-
+
Custom Headers
@@ -905,7 +962,7 @@
-
+
Custom Upstream server checks
@@ -917,8 +974,8 @@
-
- External authentication, authentication service response headers propagation
+
+ External authentication
@@ -929,7 +986,7 @@
-
+
Custom DH parameters for perfect forward secrecy
@@ -941,7 +998,7 @@
-
+
Sysctl tuning
@@ -958,7 +1015,7 @@
-
+
Docker registry
@@ -970,7 +1027,7 @@
-
+
gRPC
@@ -982,7 +1039,7 @@
-
+
Multi TLS certificate termination
@@ -994,7 +1051,7 @@
-
+
Rewrite
@@ -1006,7 +1063,7 @@
-
+
Static IPs
@@ -1018,7 +1075,7 @@
-
+
TLS termination
@@ -1029,42 +1086,6 @@
-
-
-
-
-
-
-
- Developing for NGINX Ingress Controller
-
-
-
-
-
-
-
-
-
-
-
- How it works
-
-
-
-
-
-
-
-
-
-
-
- Troubleshooting
-
-
-
-
@@ -1191,13 +1212,13 @@ you should be able to upgrade using
-
+
Next
- NGINX Configuration
+ Introduction
@@ -1227,9 +1248,9 @@ you should be able to upgrade using
-
+
-
+
diff --git a/development/index.html b/development/index.html
index c7a65d924..ee86af21d 100644
--- a/development/index.html
+++ b/development/index.html
@@ -32,11 +32,11 @@
-
+
- Developing for NGINX Ingress Controller - NGINX Ingress Controller
+ Development - NGINX Ingress Controller
@@ -54,8 +54,8 @@
-
+
@@ -100,7 +100,7 @@
-
+
Skip to content
@@ -126,7 +126,7 @@
NGINX Ingress Controller
- Developing for NGINX Ingress Controller
+ Development
@@ -198,18 +198,23 @@
-
+
+
+
- -
-
-
- Welcome
-
-
-
+
+
+ -
+
+
+ Welcome
+
+
+
+
@@ -257,12 +262,6 @@
-
-
-
-
-
-
@@ -312,6 +311,27 @@
+
+
+
+
+
+
+
+
+ Welcome
+
+
+
+ Welcome
+
+
+
+
+
+
+
+
-
@@ -319,6 +339,160 @@
+
+
+
+
+
+
+ -
+
+ How it works
+
+
+
+
+
+
+
+
+
+ -
+
+ Troubleshooting
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+ Development
+
+
+
+ Development
+
+
+
+
+
+
+
+
+
+ Table of contents
+
+
+ -
+
+ Quick Start
+
+
+
+
+
+ -
+
+ Getting the code
+
+
+
+
+ -
+
+ Initial developer environment build
+
+
+
+
+ -
+
+ Updating the deployment
+
+
+
+
+
+
+
+
+
+ -
+
+ Dependencies
+
+
+
+
+ -
+
+ Building
+
+
+
+
+
+ -
+
+ Nginx Controller
+
+
+
+
+
+
+
+
+
+ -
+
+ Deploying
+
+
+
+
+ -
+
+ Testing
+
+
+
+
+ -
+
+ Releasing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -381,8 +555,8 @@
-
- Upgrading
+
+ Upgrade
@@ -436,8 +610,8 @@
-
- NGINX Configuration
+
+ Introduction
@@ -460,8 +634,8 @@
-
- ConfigMaps
+
+ ConfigMap
@@ -681,8 +855,8 @@
-
- Ingress examples
+
+ Introduction
@@ -705,8 +879,8 @@
-
- Sticky Session
+
+ Sticky Sessions
@@ -736,7 +910,7 @@
-
+
Basic Authentication
@@ -748,7 +922,7 @@
-
+
Client Certificate Authentication
@@ -760,7 +934,7 @@
-
+
External Basic Authentication
@@ -772,7 +946,7 @@
-
+
External OAUTH Authentication
@@ -808,7 +982,7 @@
-
+
Configuration Snippets
@@ -820,7 +994,7 @@
-
+
Custom Configuration
@@ -832,7 +1006,7 @@
-
+
Custom Errors
@@ -844,7 +1018,7 @@
-
+
Custom Headers
@@ -856,7 +1030,7 @@
-
+
Custom Upstream server checks
@@ -868,8 +1042,8 @@
-
- External authentication, authentication service response headers propagation
+
+ External authentication
@@ -880,7 +1054,7 @@
-
+
Custom DH parameters for perfect forward secrecy
@@ -892,7 +1066,7 @@
-
+
Sysctl tuning
@@ -909,7 +1083,7 @@
-
+
Docker registry
@@ -921,7 +1095,7 @@
-
+
gRPC
@@ -933,7 +1107,7 @@
-
+
Multi TLS certificate termination
@@ -945,7 +1119,7 @@
-
+
Rewrite
@@ -957,7 +1131,7 @@
-
+
Static IPs
@@ -969,7 +1143,7 @@
-
+
TLS termination
@@ -980,155 +1154,6 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Developing for NGINX Ingress Controller
-
-
-
- Developing for NGINX Ingress Controller
-
-
-
-
-
-
-
-
-
- Table of contents
-
-
- -
-
- Quick Start
-
-
-
-
-
- -
-
- Getting the code
-
-
-
-
- -
-
- Initial developer environment build
-
-
-
-
- -
-
- Updating the deployment
-
-
-
-
-
-
-
-
-
- -
-
- Dependencies
-
-
-
-
- -
-
- Building
-
-
-
-
-
- -
-
- Nginx Controller
-
-
-
-
-
-
-
-
-
- -
-
- Deploying
-
-
-
-
- -
-
- Testing
-
-
-
-
- -
-
- Releasing
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- How it works
-
-
-
-
-
-
-
-
-
-
-
- Troubleshooting
-
-
-
-
@@ -1335,7 +1360,7 @@ or push an image to a remote repository.
Deploying¶
There are several ways to deploy the ingress controller onto a cluster.
-Please check the deployment guide
+Please check the deployment guide
Testing¶
To run unit-tests, just run
$ cd $GOPATH/src/k8s.io/ingress-nginx
@@ -1395,7 +1420,7 @@ Typically, a release branch should have stable code.
-
+
@@ -1404,19 +1429,19 @@ Typically, a release branch should have stable code.
Previous
- TLS termination
+ Troubleshooting
-
+
Next
- How it works
+ Installation Guide
@@ -1446,9 +1471,9 @@ Typically, a release branch should have stable code.
-
+
-
+
diff --git a/examples/PREREQUISITES/index.html b/examples/PREREQUISITES/index.html
index cfd283079..03e774c70 100644
--- a/examples/PREREQUISITES/index.html
+++ b/examples/PREREQUISITES/index.html
@@ -32,7 +32,7 @@
-
+
@@ -54,8 +54,8 @@
-
+
@@ -100,7 +100,7 @@
-
+
Skip to content
@@ -205,13 +205,16 @@
- -
-
-
- Welcome
-
-
-
+
+
+ -
+
+
+ Welcome
+
+
+
+
@@ -259,12 +262,6 @@
-
-
-
-
-
-
@@ -315,12 +312,72 @@
+
+
+
+
+
+ Welcome
+
+
+
+ Welcome
+
+
+
+
+
+
+
+
+
-
Welcome
+
+
+
+
+
+
+ -
+
+ How it works
+
+
+
+
+
+
+
+
+
+ -
+
+ Troubleshooting
+
+
+
+
+
+
+
+
+
+ -
+
+ Development
+
+
+
+
+
+
+
+
@@ -383,8 +440,8 @@
-
- Upgrading
+
+ Upgrade
@@ -438,8 +495,8 @@
-
- NGINX Configuration
+
+ Introduction
@@ -462,8 +519,8 @@
-
- ConfigMaps
+
+ ConfigMap
@@ -685,8 +742,8 @@
-
- Ingress examples
+
+ Introduction
@@ -788,8 +845,8 @@
-
- Sticky Session
+
+ Sticky Sessions
@@ -819,7 +876,7 @@
-
+
Basic Authentication
@@ -831,7 +888,7 @@
-
+
Client Certificate Authentication
@@ -843,7 +900,7 @@
-
+
External Basic Authentication
@@ -855,7 +912,7 @@
-
+
External OAUTH Authentication
@@ -891,7 +948,7 @@
-
+
Configuration Snippets
@@ -903,7 +960,7 @@
-
+
Custom Configuration
@@ -915,7 +972,7 @@
-
+
Custom Errors
@@ -927,7 +984,7 @@
-
+
Custom Headers
@@ -939,7 +996,7 @@
-
+
Custom Upstream server checks
@@ -951,8 +1008,8 @@
-
- External authentication, authentication service response headers propagation
+
+ External authentication
@@ -963,7 +1020,7 @@
-
+
Custom DH parameters for perfect forward secrecy
@@ -975,7 +1032,7 @@
-
+
Sysctl tuning
@@ -992,7 +1049,7 @@
-
+
Docker registry
@@ -1004,7 +1061,7 @@
-
+
gRPC
@@ -1016,7 +1073,7 @@
-
+
Multi TLS certificate termination
@@ -1028,7 +1085,7 @@
-
+
Rewrite
@@ -1040,7 +1097,7 @@
-
+
Static IPs
@@ -1052,7 +1109,7 @@
-
+
TLS termination
@@ -1063,42 +1120,6 @@
-
-
-
-
-
-
-
- Developing for NGINX Ingress Controller
-
-
-
-
-
-
-
-
-
-
-
- How it works
-
-
-
-
-
-
-
-
-
-
-
- Troubleshooting
-
-
-
-
@@ -1362,7 +1383,7 @@ which you can deploy as follows
-
+
@@ -1371,19 +1392,19 @@ which you can deploy as follows
Previous
- Ingress examples
+ Introduction
-
+
Next
- Sticky Session
+ Sticky Sessions
@@ -1413,9 +1434,9 @@ which you can deploy as follows
-
+
-
+
diff --git a/examples/affinity/cookie/README/index.html b/examples/affinity/cookie/index.html
similarity index 78%
rename from examples/affinity/cookie/README/index.html
rename to examples/affinity/cookie/index.html
index 74885a66f..ba2824126 100644
--- a/examples/affinity/cookie/README/index.html
+++ b/examples/affinity/cookie/index.html
@@ -31,18 +31,18 @@
-
-
+
+
- Sticky Session - NGINX Ingress Controller
+ Sticky Sessions - NGINX Ingress Controller
-
+
-
+
@@ -51,18 +51,18 @@
-
+
-
+
-
+
-
+
@@ -100,7 +100,7 @@
-
+
Skip to content
@@ -109,7 +109,7 @@
-
+
public
@@ -126,7 +126,7 @@
NGINX Ingress Controller
- Sticky Session
+ Sticky Sessions
@@ -205,13 +205,16 @@
- -
-
-
- Welcome
-
-
-
+
+
+ -
+
+
+ Welcome
+
+
+
+
@@ -219,7 +222,7 @@
-
-
+
Deployment
@@ -236,7 +239,7 @@
-
-
+
User guide
@@ -251,7 +254,7 @@
-
-
+
Examples
@@ -259,12 +262,6 @@
-
-
-
-
-
-
@@ -278,7 +275,7 @@
-
+
public
@@ -315,12 +312,72 @@
+
+
+
+
+
+ Welcome
+
+
+
+ Welcome
+
+
+
+
+
+
+
+
+
-
-
+
Welcome
+
+
+
+
+
+
+ -
+
+ How it works
+
+
+
+
+
+
+
+
+
+ -
+
+ Troubleshooting
+
+
+
+
+
+
+
+
+
+ -
+
+ Development
+
+
+
+
+
+
+
+
@@ -347,7 +404,7 @@
-
+
Installation Guide
@@ -359,7 +416,7 @@
-
+
Bare-metal considerations
@@ -371,7 +428,7 @@
-
+
Role Based Access Control (RBAC)
@@ -383,8 +440,8 @@
-
- Upgrading
+
+ Upgrade
@@ -438,8 +495,8 @@
-
- NGINX Configuration
+
+ Introduction
@@ -450,7 +507,7 @@
-
+
Annotations
@@ -462,8 +519,8 @@
-
- ConfigMaps
+
+ ConfigMap
@@ -474,7 +531,7 @@
-
+
Custom NGINX template
@@ -486,7 +543,7 @@
-
+
Log format
@@ -503,7 +560,7 @@
-
+
Command line arguments
@@ -515,7 +572,7 @@
-
+
Custom errors
@@ -527,7 +584,7 @@
-
+
Default backend
@@ -539,7 +596,7 @@
-
+
Exposing TCP and UDP services
@@ -551,7 +608,7 @@
-
+
External Articles
@@ -563,7 +620,7 @@
-
+
Miscellaneous
@@ -575,7 +632,7 @@
-
+
Prometheus and Grafana installation
@@ -587,7 +644,7 @@
-
+
Multiple Ingress controllers
@@ -599,7 +656,7 @@
-
+
TLS/HTTPS
@@ -630,7 +687,7 @@
-
+
ModSecurity Web Application Firewall
@@ -642,7 +699,7 @@
-
+
OpenTracing
@@ -685,8 +742,8 @@
-
- Ingress examples
+
+ Introduction
@@ -697,7 +754,7 @@
-
+
Prerequisites
@@ -718,11 +775,11 @@
- Sticky Session
+ Sticky Sessions
-
- Sticky Session
+
+ Sticky Sessions
@@ -785,7 +842,7 @@
-
+
Basic Authentication
@@ -797,7 +854,7 @@
-
+
Client Certificate Authentication
@@ -809,7 +866,7 @@
-
+
External Basic Authentication
@@ -821,7 +878,7 @@
-
+
External OAUTH Authentication
@@ -857,7 +914,7 @@
-
+
Configuration Snippets
@@ -869,7 +926,7 @@
-
+
Custom Configuration
@@ -881,7 +938,7 @@
-
+
Custom Errors
@@ -893,7 +950,7 @@
-
+
Custom Headers
@@ -905,7 +962,7 @@
-
+
Custom Upstream server checks
@@ -917,8 +974,8 @@
-
- External authentication, authentication service response headers propagation
+
+ External authentication
@@ -929,7 +986,7 @@
-
+
Custom DH parameters for perfect forward secrecy
@@ -941,7 +998,7 @@
-
+
Sysctl tuning
@@ -958,7 +1015,7 @@
-
+
Docker registry
@@ -970,7 +1027,7 @@
-
+
gRPC
@@ -982,7 +1039,7 @@
-
+
Multi TLS certificate termination
@@ -994,7 +1051,7 @@
-
+
Rewrite
@@ -1006,7 +1063,7 @@
-
+
Static IPs
@@ -1018,7 +1075,7 @@
-
+
TLS termination
@@ -1029,42 +1086,6 @@
-
-
-
-
-
-
-
- Developing for NGINX Ingress Controller
-
-
-
-
-
-
-
-
-
-
-
- How it works
-
-
-
-
-
-
-
-
-
-
-
- Troubleshooting
-
-
-
-
@@ -1121,7 +1142,7 @@
Sticky Session¶
This example demonstrates how to achieve session affinity using cookies
Deployment¶
-Session stickiness is achieved through 3 annotations on the Ingress, as shown in the example.
+Session stickiness is achieved through 3 annotations on the Ingress, as shown in the example.