Skip to content
NGINX and NGINX Plus OpenShift Routers
Branch: master
Clone or download
Pull request Compare This branch is even with nginxinc:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs
examples
src
.gitignore
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md

README.md

NGINX OpenShift Router

This repo includes an implementation of an OpenShift Router based on NGINX and NGINX Plus.

What is the Router?

The Router provides edge load balancing for applications on OpenShift, acting as an entry point for all external requests coming to applications running on OpenShift. The Router’s job is to identify which application a particular request is sent to and then route it to an instance (pod) of that application. OpenShift includes a special resource named Route for configuring the Router.

NGINX OpenShift Router

NGINX Router is built on top of OpenShift Template Router. Below are the key features of NGINX Router:

  • Full support of the Route specification. NGINX Router fully supports the features defined by the Route resource.
  • Customization options. Various customization options and extra features are available through environment variables and Route annotations – a common approach in other Router implementations.
  • Familiar operational experience. NGINX Router is integrated in OpenShift through the Template Router software, the same software that underpins the default Router implementation. As a result, you get the familiar operational experience, which makes it easier to migrate from the default Router implementation.
  • NGINX performance and stability. With NGINX Router you get the performance and reliability of NGINX software.
  • Latest NGINX features. We are also excited to bring our new features, such as native support for gRPC load balancing, into the OpenShift Router. As new features are made available in NGINX and NGINX Plus, they can be incorporated into the Router’s capabilities.
  • Support for TCP/UDP load balancing. NGINX Router brings support for load balancing TCP/UDP applications, including supporting edge TLS termination and re-encryption for TCP, via a TCP/UDP load balancing extension.
  • Support for Prometheus. NGINX Router can optionally expose metrics ready to be collected by Prometheus.
  • Advanced features of NGINX Plus. When NGINX Router is used with NGINX Plus, you get the additional benefits of NGINX Plus, such as its monitoring API, dashboard, extended number of metrics for Prometheus and more fine-tuned control over load balancing methods.

How To Get Started

  • Read the installation guide for NGINX or NGINX Plus installation instructions.
  • See how to use NGINX Router for edge load balancing of an example HTTP application in our Cafe Application example.
  • See how to use NGINX Router for edge load balancing of a TCP/UDP application in our TCP/UDP example.

Contacts

We’d like to hear your feedback! If you have any questions or suggestions for NGINX Router, please create an issue on GitHub.

You can’t perform that action at this time.