Skip to content

Commit 23dece9

Browse files
committed
Improve main README
1 parent 2ac91ba commit 23dece9

File tree

1 file changed

+32
-48
lines changed

1 file changed

+32
-48
lines changed

README.md

Lines changed: 32 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,41 @@
33

44
# NGINX Ingress Controller
55

6-
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](https://github.com/kubernetes/ingress-nginx) repo. See [this doc](docs/nginx-ingress-controllers.md) to find out about the key differences.
6+
This repo provides an implementation of an Ingress controller for NGINX and NGINX Plus.
77

8-
## What is Ingress?
8+
**Note**: this project is different from the NGINX Ingress controller in [kubernetes/ingress-nginx](https://github.com/kubernetes/ingress-nginx) repo. See [this doc](docs/nginx-ingress-controllers.md) to find out about the key differences.
99

10-
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:
11-
* Exposing services:
12-
* Via custom URLs (for example, service A at the URL `/serviceA` and service B at the URL `/serviceB`).
13-
* Via multiple host names (for example, `foo.example.com` for one group of services and `bar.example.com` for another group).
14-
* Configuring SSL termination for each exposed host name.
10+
## What is the Ingress?
1511

16-
See the [Ingress User Guide](http://kubernetes.io/docs/user-guide/ingress/) to learn more.
12+
The Ingress is a Kubernetes resource that lets you configure an HTTP load balancer for applications running on Kubernetes, represented by one or more [Services](https://kubernetes.io/docs/concepts/services-networking/service/). Such a load balancer is necessary to deliver those applications to clients outside of the Kubernetes cluster.
1713

18-
## What is an Ingress Controller?
14+
The Ingress resource supports the following features:
15+
* **Content-based routing**:
16+
* *Host-based routing*. For example, routing requests with the host header `foo.example.com` to one group of services and the host header `bar.example.com` to another group.
17+
* *Path-based routing*. For example, routing requests with the URI that starts with `/serviceA` to service A and requests with the URI that starts with `/serviceB` to service B.
18+
* **TLS/SSL termination** for each hostname, such as `foo.example.com`.
1919

20-
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.
20+
See the [Ingress User Guide](http://kubernetes.io/docs/user-guide/ingress/) to learn more about the Ingress resource.
2121

22-
See https://github.com/kubernetes/contrib/tree/master/ingress/controllers/ to learn more about Ingress controllers and find out about different implementations.
22+
## What is the Ingress Controller?
23+
24+
The Ingress controller is an application that runs in a cluster and configures an HTTP load balancer according to Ingress resources. The load balancer can be a software load balancer running in the cluster or a hardware or cloud load balancer runnning externally. Different load balancers require different Ingress controller implementations.
25+
26+
In the case of NGINX, the Ingress controller is deployed in a pod along with the load balancer.
2327

2428
## NGINX Ingress Controller
2529

26-
We provide an Ingress controller for NGINX and NGINX Plus that supports the following Ingress features:
27-
* SSL termination
28-
* Path-based rules
29-
* Multiple host names
30+
NGINX Ingress controller works with both NGINX and NGINX Plus and supports the standard Ingress features - content-based routing and TLS/SSL termination.
31+
32+
Additionally, several NGINX and NGINX Plus features are available as extensions to the Ingress resource via annotations and the ConfigMap resource. In addition to HTTP, NGINX Ingress controller supports load balancing Websocket, gRPC, TCP and UDP applications. See [ConfigMap and Annotations doc](docs/configmap-and-annotations.md) to learn more about the supported features and customization options.
33+
34+
## Getting Started
3035

31-
We provide the following extensions to our Ingress controller:
32-
* [Websocket](examples/websocket), which allows you to load balance Websocket applications.
33-
* [SSL Services](examples/ssl-services), which allows you to load balance HTTPS applications.
34-
* [Rewrites](examples/rewrites), which allows you to rewrite the URI of a request before sending it to the application.
35-
* [Session Persistence](examples/session-persistence) (NGINX Plus only), which guarantees that all the requests from the same client are always passed to the same backend container.
36-
* [Support for JWTs](examples/jwt) (NGINX Plus only), which allows NGINX Plus to authenticate requests by validating JSON Web Tokens (JWTs).
36+
1. Install the NGINX Ingress controller using the Kubernetes [manifests](deployments) or the [helm chart](deployments/helm-chart).
37+
1. Run through the [Cafe example](examples/complete-example) to deploy and configure load balancing for a simple web application.
38+
1. See additional configuration [examples](examples).
39+
1. Learn more about all available configuration and customization in the [docs](docs).
3740

38-
Additional extensions as well as a mechanism to customize NGINX configuration are available. See [ConfigMap and Annotations doc](docs/configmap-and-annotations.md).
3941

4042
## NGINX Ingress Controller Releases
4143

@@ -57,34 +59,16 @@ The table below summarizes the options regarding the images, manifests, helm cha
5759
| Latest stable release | For production use | `nginx/nginx-ingress:1.3.2`, `nginx/nginx-ingress:1.3.2-alpine` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/) or [build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.2/nginx-controller). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.2/nginx-controller). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.2/install). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.2/helm-chart). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.2/docs). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/v1.3.2/examples). |
5860
| Edge | For testing and experimenting | `nginx/nginx-ingress:edge`, `nginx/nginx-ingress:edge-alpine` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/) or [build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/master/build). | [Build your own image](https://github.com/nginxinc/kubernetes-ingress/tree/master/build). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/master/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/master/deployments/helm-chart). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/master/docs). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/master/examples). |
5961

60-
## Benefits of Using the Ingress Controller with NGINX Plus
61-
62-
[NGINX Plus](https://www.nginx.com/products/) is a commercial version of NGINX that comes with advanced features and support.
63-
64-
The Ingress controller leverages the advanced features of NGINX Plus, which gives you the following additional benefits:
65-
66-
* **Improved system resources utilization for large-scale deployments**
67-
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](https://www.nginx.com/products/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.
68-
* **Real-time statistics**
69-
NGINX Plus provides you with [advanced statistics](https://www.nginx.com/products/live-activity-monitoring/), 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.
70-
* **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](examples/session-persistence) to find out how to configure it.
71-
* **JWTs** NGINX Plus can validate JSON Web Tokens (JWTs), providing a flexible authentication mechanism.
72-
* **Support** Support from NGINX Inc is available for NGINX Plus Ingress controller.
73-
74-
**Note**: Deployment of the Ingress controller for NGINX Plus requires you to do one extra step: build your own [Docker image](build) using the certificate and key for your subscription.
75-
The Docker image of the Ingress controller for NGINX is [available on Docker Hub](https://hub.docker.com/r/nginx/nginx-ingress/).
76-
77-
## Using Multiple Ingress Controllers
78-
79-
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](examples/multiple-ingress-controllers) to learn more.
62+
## Contacts
8063

81-
## Advanced Load Balancing/An Alternative Method of Configuration
64+
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.
65+
You can contact us directly via [[email protected]](mailto:[email protected]).
8266

83-
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.
67+
## Contributing
8468

85-
NGINX Plus comes with a [DNS-based dynamic reconfiguration feature](https://www.nginx.com/blog/dns-service-discovery-nginx-plus/), which lets you keep the list of the endpoints of your services in sync with NGINX Plus. Read more about how to setup NGINX Plus this way in [Load Balancing Kubernetes Services with NGINX Plus](https://www.nginx.com/blog/load-balancing-kubernetes-services-nginx-plus/).
69+
If you'd like to contribute to the project, please read our [Contributing guide](CONTRIBUTING.md).
8670

87-
## Contacts
71+
## Support
8872

89-
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.
90-
You can contact us directly via [[email protected]](mailto:[email protected]).
73+
For NGINX Plus customers NGINX Ingress controller (when used with NGINX Plus) is covered
74+
by the support contract.

0 commit comments

Comments
 (0)