Skip to content

Commit 09d6c70

Browse files
committed
More docs fixes
1 parent 15d0655 commit 09d6c70

File tree

7 files changed

+35
-35
lines changed

7 files changed

+35
-35
lines changed

.github/release-drafter.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ template: |
6363
## Compatibility
6464
6565
- NGINX Ingress Controller NIC_VERSION_REPLACE_ME!
66-
- Openshift 4.5 or newer.
66+
- OpenShift 4.5 or newer.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ It is possible to run the operator in your local machine. This is useful for tes
6969

7070
### Run Operator locally
7171

72-
1. Have access to a Kubernetes/Openshift cluster.
72+
1. Have access to a Kubernetes/OpenShift cluster.
7373
1. Apply the IC CRD:
7474
```
7575
make install

docs/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Installation
22

33
We currently support 2 methods of installation:
4-
1. [Installation in an Openshift cluster](./openshift-installation.md) using the [OLM](https://github.com/operator-framework/operator-lifecycle-manager).
5-
1. [Manual installation](./manual-installation.md) in a Kubernetes or Openshift cluster by manually deploying the operator manifests.
6-
4+
1. [Installation in an OpenShift cluster](./openshift-installation.md) using the [OLM](https://github.com/operator-framework/operator-lifecycle-manager).
5+
1. [Manual installation](./manual-installation.md) in a Kubernetes or OpenShift cluster by manually deploying the operator manifests.
6+
77
After installation, use the [sample CR definition](../config/samples/charts_v1alpha1_nginxingress.yaml) to deploy the NGINX Ingress Controller using the operator.

docs/manual-installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This will deploy the operator in the `nginx-ingress-operator-system` namespace.
1111
git checkout v1.1.0
1212
```
1313
14-
2. `Openshift` To deploy the Operator and associated resources to an OpenShift environment, run:
14+
2. `OpenShift` To deploy the Operator and associated resources to an OpenShift environment, run:
1515
```
1616
make deploy IMG=nginx/nginx-ingress-operator:1.1.0
1717
```
@@ -29,8 +29,8 @@ This will deploy the operator in the `nginx-ingress-operator-system` namespace.
2929
nginx-ingress-operator-controller-manager 1/1 1 1 15s
3030
```
3131
32-
3. `Openshift` Additional steps:
32+
3. `OpenShift` Additional steps:
3333
3434
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, please run the following command (assuming you are logged in with administrator access to the cluster):
3535
36-
`kubectl -f https://github.com/nginxinc/nginx-ingress-helm-operator/v1.1.0/resources/scc.yaml`
36+
`kubectl -f https://raw.githubusercontent.com//nginxinc/nginx-ingress-helm-operator/v1.1.0/resources/scc.yaml`

docs/openshift-installation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# Installation in an Openshift cluster using the OLM
1+
# Installation in an OpenShift cluster using the OLM
22

3-
This installation method is the recommended way for Openshift users. **Note**: Openshift version must be 4.2 or higher.
3+
This installation method is the recommended way for OpenShift users. **Note**: OpenShift version must be 4.2 or higher.
44

55
**Note: The `nginx-ingress-operator` supports `Basic Install` only - we do not support auto-updates. When you are installing the Operator using the OLM, the auto-update feature should be disabled to avoid breaking changes being auto-applied. In OpenShift, this can be done by setting the `Approval Strategy` to `Manual`. Please see the [Operator SDK docs](https://sdk.operatorframework.io/docs/advanced-topics/operator-capabilities/operator-capabilities/) for more details on the Operator Capability Levels.**
66

77
The NGINX Ingress Operator is a [RedHat certified Operator](https://connect.redhat.com/en/partner-with-us/red-hat-openshift-operator-certification).
88

9-
1. In the Openshift dashboard, click `Operators` > `Operator Hub` in the left menu and use the search box to type `nginx ingress`:
9+
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")
1111
1. Click the `NGINX Ingress Operator` and click `Install`:
1212
![alt text](./images/openshift2.png "NGINX Ingress Operator")
1313
1. Click `Subscribe`:
1414
![alt text](./images/openshift3.png "NGINX Ingress Operator Install")
1515

16-
Openshift will install the NGINX Ingress Operator:
16+
OpenShift will install the NGINX Ingress Operator:
1717

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

2020
Additional steps:
2121

2222
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, please run the following command (assuming you are logged in with administrator access to the cluster):
2323

24-
`kubectl -f https://github.com/nginxinc/nginx-ingress-helm-operator/v1.1.0/resources/scc.yaml`
24+
`kubectl -f https://raw.githubusercontent.com/nginxinc/nginx-ingress-helm-operator/v1.1.0/resources/scc.yaml`
2525

2626
You can now deploy the NGINX Ingress Controller instances.

examples/deployment-oss-min/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,31 @@ If you would like to use TransportServers, refer to [this section](README.md#Tra
1212
1. Create a new namespace for our Ingress Controller instance:
1313
```
1414
kubectl create -f ns.yaml
15-
```
15+
```
1616
17-
2. Create a new NginxIngressController resource that defines our NGINX Ingress Controller instance (**Note**: If using Openshift, change the `image.tag` to `edge-ubi`):
17+
2. Create a new NginxIngressController resource that defines our NGINX Ingress Controller instance (**Note**: If using OpenShift, change the `image.tag` to `edge-ubi`):
1818
```
1919
kubectl create -f nginx-ingress-controller.yaml
2020
```
2121
22-
2322
24-
This will deploy an NGINX Ingress Controller instance using a [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) in the `my-nginx-controller` namespace.
23+
24+
This will deploy an NGINX Ingress Controller instance using a [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) in the `my-nginx-controller` namespace.
2525
2626
3. Check if all resources were deployed:
2727
2828
```
2929
kubectl -n my-nginx-ingress get all
30-
30+
3131
NAME READY STATUS RESTARTS AGE
3232
pod/my-nginx-ingress-controller-666854fb5f-f67fs 1/1 Running 0 3s
33-
33+
3434
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
3535
service/my-nginx-ingress-controller NodePort 10.103.105.52 <none> 80:30298/TCP,443:32576/TCP 3s
36-
36+
3737
NAME READY UP-TO-DATE AVAILABLE AGE
3838
deployment.apps/my-nginx-ingress-controller 1/1 1 1 4s
39-
39+
4040
NAME DESIRED CURRENT READY AGE
4141
replicaset.apps/my-nginx-ingress-controller-666854fb5f 1 1 1 4s
4242
```
@@ -48,17 +48,17 @@ For more information about how to configure the NGINX Ingress Controller, check
4848
1. Delete the NginxIngressController:
4949
```
5050
kubectl delete -f nginx-ingress-controller.yaml
51-
```
51+
```
5252
5353
1. Delete the namespace:
5454
```
5555
kubectl delete namespace my-nginx-ingress
5656
```
57-
57+
5858
## TransportServers
5959
60-
TransportServers provide support for TCP/UDP but are in active development and provided as a preview feature.
61-
A GlobalConfiguration resource is used to specify the TCP/UDP listeners and is required by TransportServers.
60+
TransportServers provide support for TCP/UDP but are in active development and provided as a preview feature.
61+
A GlobalConfiguration resource is used to specify the TCP/UDP listeners and is required by TransportServers.
6262
To use TransportServers, you must create a GlobalConfiguration resource *after* creating the namespace and *before* starting the Operator.
6363
6464

examples/deployment-plus-min/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ In this example we deploy the NGINX Ingress Controller (edge) as a [Deployment](
55
## Prerequisites
66

77
1. Have the NGINX Ingress Operator deployed in your cluster. Follow [installation](../../README.md#installation) steps.
8-
2. Build the NGINX Ingress Controller for Plus image and push it to a private repository following
9-
[these instructions](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/#building-the-image-and-pushing-it-to-the-private-registry)
10-
(**Note**: For the build process, if using Openshift, use the `openshift-image-plus` or `openshift-image-nap-plus` targets).
8+
2. Build the NGINX Ingress Controller for Plus image and push it to a private repository following
9+
[these instructions](https://docs.nginx.com/nginx-ingress-controller/installation/building-ingress-controller-image/#building-the-image-and-pushing-it-to-the-private-registry)
10+
(**Note**: For the build process, if using OpenShift, use the `openshift-image-plus` or `openshift-image-nap-plus` targets).
1111

1212
If you would like to use TransportServers, refer to [this section](README.md#TransportServers) for additional pre-requisites.
1313

@@ -16,29 +16,29 @@ If you would like to use TransportServers, refer to [this section](README.md#Tra
1616
1. Create a new namespace for our Ingress Controller instance:
1717
```
1818
kubectl create -f ns.yaml
19-
```
19+
```
2020
2121
2. Create a new NginxIngressController resource that defines our NGINX Ingress Controller instance (**Note:** Update the `image.repository` field in the `nginx-ingress-controller.yaml` with your previously built image for NGINX Plus):
2222
```
2323
kubectl create -f nginx-ingress-controller.yaml
2424
```
2525
26-
This will deploy an NGINX Ingress Controller instance using a [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) in the `my-nginx-controller` namespace.
26+
This will deploy an NGINX Ingress Controller instance using a [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) in the `my-nginx-controller` namespace.
2727
2828
3. Check if all resources were deployed:
2929
3030
```
3131
kubectl -n my-nginx-ingress get all
32-
32+
3333
NAME READY STATUS RESTARTS AGE
3434
pod/my-nginx-ingress-controller-666854fb5f-f67fs 1/1 Running 0 3s
35-
35+
3636
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
3737
service/my-nginx-ingress-controller NodePort 10.103.105.52 <none> 80:30298/TCP,443:32576/TCP 3s
38-
38+
3939
NAME READY UP-TO-DATE AVAILABLE AGE
4040
deployment.apps/my-nginx-ingress-controller 1/1 1 1 4s
41-
41+
4242
NAME DESIRED CURRENT READY AGE
4343
replicaset.apps/my-nginx-ingress-controller-666854fb5f 1 1 1 4s
4444
```
@@ -50,7 +50,7 @@ For more information about how to configure the NGINX Ingress Controller, check
5050
1. Delete the NginxIngressController:
5151
```
5252
kubectl delete -f nginx-ingress-controller.yaml
53-
```
53+
```
5454
5555
1. Delete the namespace:
5656
```

0 commit comments

Comments
 (0)