Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to include CRD upgrade #224

Merged
merged 1 commit into from
Jan 2, 2024
Merged

Update docs to include CRD upgrade #224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/manual-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,5 @@ Alternatively, to create an SCC for NIC daemonsets, please run this command:
`kubectl apply -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v2.1.0/resources/scc-daemonset.yaml`

You can now deploy the NGINX Ingress Controller instances.

**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**
6 changes: 4 additions & 2 deletions docs/openshift-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ The NGINX Ingress Operator is a [RedHat certified Operator](https://connect.redh

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

OpenShift will install the NGINX Ingress Operator:

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

**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**

Additional steps:

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):
Expand Down
8 changes: 4 additions & 4 deletions docs/upgrades.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@ Release 1.0.0 includes a backward incompatible change from version 0.5.1 as we h
**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**
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.

### 0. Upgrade the existing NIC crds
### 1. Upgrade the existing NIC crds

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

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

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).

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).

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

### 2. Install the latest version of the operator
### 3. Install the latest version of the operator

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

### 3. Deploy new ingress controller deployments
### 4. Deploy new ingress controller deployments

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)

Expand Down