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 |
|---|---|
| 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.
- Install the NGINX Ingress Operator. See docs.
- Deploy a new NGINX Ingress Controller using the NginxIngressController Custom Resource:
- For an NGINX installation see the NGINX example.
- For an NGINX Plus installation see the NGINX Plus example.
We publish NGINX Ingress Operator releases on GitHub. See our releases page.
The latest stable release is 0.1.0. For production use, we recommend that you choose the latest stable release.
It is possible to run the operator in your local machine. This is useful for testing or during development.
- Have access to a Kubernetes/Openshift cluster.
- Apply the latest CRD:
kubectl apply -f deploy/crds/k8s.nginx.org_nginxingresscontrollers_crd.yaml - Apply the NGINX Ingress Controller CRDs:
kubectl apply -f build/kic_crds - Run
make run-local.
The operator will run in your local machine but will be communicating with the cluster. The operator will only watch the default namespace when deployed locally.
If any change is made in the CRD in the go code, run the following commands to update the changes in the CRD yaml:
make generate-crds- Apply the new CRD definition again in your cluster
kubectl apply -f deploy/crds/k8s.nginx.org_nginxingresscontrollers_crd.yaml.
Run make test to run unit tests locally.
If you'd like to contribute to the project, please read our Contributing guide.