Skip to content

Commit 5e28ade

Browse files
authored
Update docs to include CRD upgrade (#224)
1 parent 1aef758 commit 5e28ade

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

docs/manual-installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,5 @@ Alternatively, to create an SCC for NIC daemonsets, please run this command:
3737
`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v2.1.0/resources/scc-daemonset.yaml`
3838

3939
You can now deploy the NGINX Ingress Controller instances.
40+
41+
**Note: If you're upgrading your operator installation to a later release, navigate [here](../helm-charts/nginx-ingress/) and run `kubectl apply -f crds/` or `oc apply -f crds/` as a prerequisite**

docs/openshift-installation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,17 @@ The NGINX Ingress Operator is a [RedHat certified Operator](https://connect.redh
88

99
1. In the OpenShift dashboard, click `Operators` > `Operator Hub` in the left menu and use the search box to type `nginx ingress`:
1010
![alt text](./images/openshift1.png "Operators")
11-
1. Click the `NGINX Ingress Operator` and click `Install`:
11+
2. Click the `NGINX Ingress Operator` and click `Install`:
1212
![alt text](./images/openshift2.png "NGINX Ingress Operator")
13-
1. Click `Subscribe`:
13+
3. Click `Subscribe`:
1414
![alt text](./images/openshift3.png "NGINX Ingress Operator Install")
1515

1616
OpenShift will install the NGINX Ingress Operator:
1717

1818
![alt text](./images/openshift4.png "NGINX Ingress Operator Subscribe")
1919

20+
**Note: If you're upgrading your operator installation to a later release, navigate [here](../helm-charts/nginx-ingress/) and run `kubectl apply -f crds/` or `oc apply -f crds/` as a prerequisite**
21+
2022
Additional steps:
2123

2224
In order to deploy NGINX Ingress Controller instances into OpenShift environments, a new SCC is required to be created on the cluster which will be used to bind the specific required capabilities to the NGINX Ingress service account(s). To do so for NIC deployments, please run the following command (assuming you are logged in with administrator access to the cluster):

docs/upgrades.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,23 @@ Release 1.0.0 includes a backward incompatible change from version 0.5.1 as we h
1414
**Note: Multiple NIC deployments: the RBAC resources should be deployed separately if deploying multiple ICs in same namespace. This is because only one of the ICs in a namespace will be assigned "ownership" of these resources. Similarly, the IngressClass resource needs to be created separately if deploying multiple NIC instances with a shared IngressClass. See the [README](../README.md) for more information**
1515
6. Re-create ingress controllers (note: multi IC rules) using the new Operator. Be sure to use the same configuration as the previous deployments (ingress class name, namespaces etc). They will pick up all deployed dependant resources.
1616

17-
### 0. Upgrade the existing NIC crds
17+
### 1. Upgrade the existing NIC crds
1818

1919
Navigate [here](../helm-charts/nginx-ingress/) and run `kubectl apply -f crds/`
2020

21-
### 1. Uninstall the existing 0.5.1 operator, the nginx ingress controller CRD, and the ingressClass
21+
### 2. Uninstall the existing 0.5.1 operator, the nginx ingress controller CRD, and the ingressClass
2222

2323
Uninstall the operator using the web console - see [the OCP documentation for details](https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/pdf/operators/OpenShift_Container_Platform-4.13-Operators-en-US.pdf).
2424

2525
Next uninstall the NIC CRD `nginxingresscontrollers.k8s.nginx.org`. This will remove any instances of the NginxIngressController, but not any dependent objects (ingresses, VSs, etc).
2626

2727
Finally, remove the nginx-ingress ingressClass `k delete ingressclass/nginx`.
2828

29-
### 2. Install the latest version of the operator
29+
### 3. Install the latest version of the operator
3030

3131
Install the latest version of the Operator following the steps outlined in [OpenShift installation doc](./openshift-installation.md).
3232

33-
### 3. Deploy new ingress controller deployments
33+
### 4. Deploy new ingress controller deployments
3434

3535
Use the new Nginx Ingress Operator installation to deploy Nginx Ingress Controller - see the release notes [here](https://docs.nginx.com/nginx-ingress-controller/releases/#nginx-ingress-controller-2-2-0) and a guide to the Helm configuration parameters [here](https://docs.nginx.com/nginx-ingress-controller/installation/installation-with-helm/#configuration)
3636

0 commit comments

Comments
 (0)