Skip to content

Commit 54a66dc

Browse files
committed
update ingressClass in Operator page
1 parent 1c75665 commit 54a66dc

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

docs/content/installation/installation-with-operator.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,22 @@ toc: true
88
docs: "DOCS-604"
99
---
1010

11-
This document describes how to install the F5 NGINX Ingress Controller in your Kubernetes cluster using the NGINX Ingress Operator.
11+
This document describes how to install the F5 NGINX Ingress Controller in your Kubernetes cluster using the
12+
NGINX Ingress Operator.
1213

1314
## Prerequisites
1415

15-
{{<note>}} All documentation should only be used with the latest stable release, indicated on [the releases page](https://github.com/nginxinc/kubernetes-ingress/releases) of the GitHub repository. {{</note>}}
16+
**Note** All documentation should only be used with the latest stable release, indicated on
17+
[the releases page](https://github.com/nginxinc/kubernetes-ingress/releases) of the GitHub repository.
1618

1719
1. Make sure you have access to the Ingress Controller image:
1820
- For NGINX Ingress Controller, use the image `nginx/nginx-ingress` from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress).
19-
- For NGINX Plus Ingress Controller, see [here](/nginx-ingress-controller/installation/pulling-ingress-controller-image) for details on how to pull the image from the F5 Docker registry.
20-
- To pull from the F5 Container registry, configure a docker registry secret using your JWT token from the MyF5 portal by following the instructions from [here](/nginx-ingress-controller/installation/using-the-jwt-token-docker-secret).
21-
- It is also possible to 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).
21+
- For NGINX Plus Ingress Controller, see [here](/nginx-ingress-controller/installation/pulling-ingress-controller-image)
22+
for details on how to pull the image from the F5 Docker registry.
23+
- To pull from the F5 Container registry, configure a docker registry secret using your JWT token from the MyF5 portal
24+
by following the instructions from [here](/nginx-ingress-controller/installation/using-the-jwt-token-docker-secret).
25+
- It is also possible to build your own image and push it to your private Docker registry by following the instructions
26+
from [here](/nginx-ingress-controller/installation/building-ingress-controller-image).
2227
2. Install the NGINX Ingress Operator following the [instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v2.0.0/docs/installation.md).
2328
3. Create the SecurityContextConstraint as outlined in the ["Getting Started" instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v2.0.0/README.md#getting-started).
2429

@@ -38,24 +43,32 @@ spec:
3843
pullPolicy: IfNotPresent
3944
repository: nginx/nginx-ingress
4045
tag: 3.3.0-ubi
41-
ingressClass: nginx
46+
ingressClass:
47+
name: nginx
4248
kind: deployment
4349
nginxplus: false
4450
replicaCount: 1
4551
serviceAccount:
4652
imagePullSecretName: ""
4753
```
4854
49-
**Note:** For NGINX Plus, change the `image.repository` and `image.tag` values and change `nginxPlus` to `True`. If required, set the `serviceAccount.imagePullSecretName` to the name of the pre-created docker config secret that should be associated with the ServiceAccount.
55+
**Note:** For NGINX Plus, change the `image.repository` and `image.tag` values and change `nginxPlus` to `True`.
56+
If required, set the `serviceAccount.imagePullSecretName` to the name of the pre-created docker config secret that
57+
should be associated with the ServiceAccount.
5058

5159
## 2. Create the NginxIngressController
5260

5361
```console
5462
kubectl apply -f nginx-ingress-controller.yaml
5563
```
5664

57-
A new instance of the NGINX Ingress Controller will be deployed by the NGINX Ingress Operator in the `default` namespace with default parameters.
65+
A new instance of the NGINX Ingress Controller will be deployed by the NGINX Ingress Operator in the `default`
66+
namespace with default parameters.
5867

5968
To configure other parameters of the NginxIngressController resource, check the [documentation](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v2.0.0/docs/nginx-ingress-controller.md).
6069

61-
**Note:** Some users reported an `OOMkilled` error when they deployed the NGINX Ingress Operator in a large cluster with multiple namespaces and Kubernetes objects. This is due to the helm operator caching every Kubernetes object in the cluster, and thus consuming too much system memory. If you encounter this issue, consider setting the operator to only watch one namespace. If watching multiple namespaces is required in your use case, try manually increasing the memory limit for the operator. Note that the value might be overwritten after a release update. We are working with the OpenShift team to resolve this issue.
70+
**Note:** Some users reported an `OOMkilled` error when they deployed the NGINX Ingress Operator in a large cluster with
71+
multiple namespaces and Kubernetes objects. This is due to the helm operator caching every Kubernetes object in the cluster,
72+
and thus consuming too much system memory. If you encounter this issue, consider setting the operator to only watch one namespace.
73+
If watching multiple namespaces is required in your use case, try manually increasing the memory limit for the operator.
74+
Note that the value might be overwritten after a release update. We are working with the OpenShift team to resolve this issue.

0 commit comments

Comments
 (0)