Skip to content

Commit 304a563

Browse files
authored
Add installation with operator docs
1 parent 5643a07 commit 304a563

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

docs-web/installation/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ Installation
77
building-ingress-controller-image
88
installation-with-manifests
99
installation-with-helm
10+
installation-with-operator
1011
running-multiple-ingress-controllers
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Installation with the NGINX Ingress Operator
2+
3+
This document describes how to install the NGINX Ingress Controller in your Kubernetes cluster using the NGINX Ingress Operator.
4+
5+
## Prerequisites
6+
7+
1. Make sure you have access to the Ingress Controller image:
8+
* For NGINX Ingress Controller, use the image `nginx/nginx-ingress` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress).
9+
* For NGINX Plus Ingress Controller, build your own image and push it to your private Docker registry by following the instructions from [here](/nginx-ingress-controller/installation/building-ingress-controller-image).
10+
1. Install the NGINX Ingress Operator following the [instructions](https://github.com/nginxinc/nginx-ingress-operator/blob/master/docs/installation.md).
11+
12+
## 1. Create the NginxIngressController manifest
13+
14+
Create a manifest `nginx-ingress-controller.yaml` with the following content:
15+
16+
```yaml
17+
apiVersion: k8s.nginx.org/v1alpha1
18+
kind: NginxIngressController
19+
metadata:
20+
name: my-nginx-ingress-controller
21+
namespace: default
22+
spec:
23+
type: deployment
24+
image:
25+
repository: nginx/nginx-ingress
26+
tag: edge
27+
pullPolicy: Always
28+
serviceType: NodePort
29+
nginxPlus: False
30+
```
31+
32+
**Note:** For NGINX Plus, change the `image.repository` and `image.tag` values and change `nginxPlus` to `True`.
33+
34+
## 2. Create the NginxIngressController
35+
36+
```
37+
$ kubectl apply -f nginx-ingress-controller.yaml
38+
```
39+
40+
A new instance of the NGINX Ingress Controller will be deployed by the NGINX Ingress Operator in the `default` namespace with default parameters.
41+
42+
To configure other parameters of the NginxIngressController resource, check the [documentation](https://github.com/nginxinc/nginx-ingress-operator/blob/master/docs/nginx-ingress-controller.md).

0 commit comments

Comments
 (0)