Skip to content

Commit eaf883f

Browse files
authored
feat: Fix instruction link for NGINX Ingress Helm Operator (#3596)
This commit makes a small change to the third prerequisite in the installation document to point at the correct instructions it is referencing. It also expands the link itself to make it clearer what precisely the reader is being referenced to, and prefixes F5 to the first instance of the product name (Ignoring the ephemeral note).
1 parent 97ef3c3 commit eaf883f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ docs: "DOCS-604"
1212
An NGINX Ingress Operator version compatible with the 3.0.1 NGINX Ingress Controller release is not available yet. We will update this document and remove this note once we publish a compatible Operator version.
1313
{{< /note >}}
1414

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

1717
## Prerequisites
1818

@@ -22,7 +22,7 @@ This document describes how to install the NGINX Ingress Controller in your Kube
2222
* 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).
2323
* 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).
2424
2. Install the NGINX Ingress Operator following the [instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.3.0/docs/installation.md).
25-
3. Create the default server secret and SecurityContextConstraint as outlined in the [instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.3.0/docs/installation.md).
25+
3. Create the default server secret and SecurityContextConstraint as outlined in the ["Getting Started" instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.3.0/README.md#getting-started).
2626

2727
## 1. Create the NginxIngressController manifest
2828

@@ -60,6 +60,6 @@ $ kubectl apply -f nginx-ingress-controller.yaml
6060
6161
A new instance of the NGINX Ingress Controller will be deployed by the NGINX Ingress Operator in the `default` namespace with default parameters.
6262
63-
To configure other parameters of the NginxIngressController resource, check the [documentation](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.2.1/docs/nginx-ingress-controller.md).
63+
To configure other parameters of the NginxIngressController resource, check the [documentation](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.3.0/docs/nginx-ingress-controller.md).
6464
6565
**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.

0 commit comments

Comments
 (0)