Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 3.28 KB

README.md

File metadata and controls

73 lines (48 loc) · 3.28 KB
Raw

Continuous Integration FOSSA Status

NGINX Ingress Operator

The NGINX Ingress Operator is a Kubernetes/OpenShift component which deploys and manages one or more NGINX/NGINX Plus Ingress Controllers which in turn handle Ingress traffic for applications running in a cluster.

Learn more about operators in the Kubernetes Documentation.

To install a specific version of the NGINX Ingress Controller with the operator, a specific version of the NGINX Ingress Operator is required.

The following table shows the relation between the versions of the two projects:

NGINX Ingress Controller NGINX Ingress Operator
2.1.x 0.5.0
2.0.x 0.4.0
1.12.x 0.3.0
1.11.x 0.2.0
1.10.x 0.1.0
1.9.x 0.0.7
1.8.x 0.0.6
1.7.x 0.0.4
< 1.7.0 N/A

Note: The NGINX Ingress Operator works only for NGINX Ingress Controller versions after 1.7.0.

Getting Started

  1. Install the NGINX Ingress Operator. See docs.
    NOTE: To use TransportServers as part of your NGINX Ingress Controller configuration, a GlobalConfiguration resource must be created before starting the Operator - see the notes
  2. Deploy a new NGINX Ingress Controller using the NginxIngressController Custom Resource:

Upgrades

See upgrade docs

NGINX Ingress Operator Releases

We publish NGINX Ingress Operator releases on GitHub. See our releases page.

The latest stable release is 0.5.0. For production use, we recommend that you choose the latest stable release.

Development

It is possible to run the operator in your local machine. This is useful for testing or during development.

Run Operator locally

  1. Have access to a Kubernetes/Openshift cluster.
  2. Apply the latest CRDs: 
     make install
 kubectl apply -f config/crd/kic/
  3. Run make run.

The operator will run in your local machine but will be communicating with the cluster.

Update CRD

If any change is made in the CRD in the go code, run the following commands to update the changes in the CRD yaml:

  1. make manifests
  2. Apply the new CRD definition again in your cluster make install.

Run tests

Run make test to run the full test suite including envtest, or make unit-test to run just the unit tests locally.

Contributing

If you'd like to contribute to the project, please read our Contributing guide.