Skip to content

Commit

Permalink
Add documentation for the Helm Operator OOM issue (#3470)
Browse files Browse the repository at this point in the history
Add documentation to advise users to watch single namespace or increase memory limit in case of an `OOMkill` event

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
haywoodsh and pre-commit-ci[bot] committed Jan 24, 2023
1 parent 7c117ec commit ae2e004
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/content/installation/installation-with-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,5 @@ $ kubectl apply -f nginx-ingress-controller.yaml
A new instance of the NGINX Ingress Controller will be deployed by the NGINX Ingress Operator in the `default` namespace with default parameters.

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

**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 comments on commit ae2e004

Please sign in to comment.