README.md

NGINX Ingress Controller

This repo provides an implementation of an Ingress controller for NGINX and NGINX Plus. This implementation is different from the NGINX Ingress controller in kubernetes/ingress-nginx repo. See this doc to find out about the key differences.

What is Ingress?

An Ingress is a Kubernetes resource that lets you configure an HTTP load balancer for your Kubernetes services. Such a load balancer usually exposes your services to clients outside of your Kubernetes cluster. An Ingress resource supports:

Exposing services:

Via custom URLs (for example, service A at the URL /serviceA and service B at the URL /serviceB).

Via multiple host names (for example, foo.example.com for one group of services and bar.example.com for another group).

What is an Ingress Controller?

An Ingress controller is an application that monitors Ingress resources via the Kubernetes API and updates the configuration of a load balancer in case of any changes. Different load balancers require different Ingress controller implementations. Typically, an Ingress controller is deployed as a pod in a cluster. In the case of software load balancers, such as NGINX, an Ingress controller is deployed in a pod along with a load balancer.

Additional extensions as well as a mechanism to customize NGINX configuration are available. See examples/customization.

Benefits of Using the Ingress Controller with NGINX Plus

NGINX Plus is a commercial version of NGINX that comes with advanced features and support.

The Ingress controller leverages the advanced features of NGINX Plus, which gives you the following additional benefits:

Improved system resources utilization for large-scale deployments
Every time the number of pods of services you expose via Ingress changes, the Ingress controller updates the configuration of NGINX to reflect those changes. For the open source NGINX software, the configuration file must be changed and the configuration reloaded. For NGINX Plus, the on-the-fly reconfiguration feature is utilized, which allows NGINX Plus to be updated on-the-fly without reloading the configuration. This prevents increase of memory usage during reloads, especially with a high volume of client requests, as well as increased memory usage when load balancing applications with long-lived connections (WebSocket, applications with file uploading/downloading or streaming). As a result, NGINX Plus Ingress controller is better suited for production-ready deployments.

Real-time statistics
NGINX Plus provides you with advanced statistics, which you can access either through the API or via the built-in dashboard. This can give you insights into how NGINX Plus and your applications are performing.

Session persistence When enabled, NGINX Plus makes sure that all the requests from the same client are always passed to the same backend container using the sticky cookie method. Refer to the session persistence examples to find out how to configure it.

Support Support from NGINX Inc is available for NGINX Plus Ingress controller.

Note: Deployment of the Ingress controller for NGINX Plus requires you to do one extra step: build your own Docker image using the certificate and key for your subscription.
The Docker image of the Ingress controller for NGINX is available on Docker Hub.

Using Multiple Ingress Controllers

You can run multiple Ingress controllers at the same time. For example, if your Kubernetes cluster is deployed in cloud, you can run the NGINX controller and the corresponding cloud HTTP load balancing controller. Refer to the example to learn more.

Advanced Load Balancing/An Alternative Method of Configuration

When your requirements go beyond what Ingress and Ingress extensions offer or if you are looking for an alternative method of configuring NGINX, it is possible to use NGINX or NGINX Plus without the Ingress Controller.

Contacts

We’d like to hear your feedback! If you have any suggestions or experience issues with our Ingress controller, please create an issue or send a pull request on Github.
You can contact us directly via kubernetes@nginx.com.