diff --git a/docs/content/installation/installation-with-operator.md b/docs/content/installation/installation-with-operator.md index 6b91adede2..fd862fdf60 100644 --- a/docs/content/installation/installation-with-operator.md +++ b/docs/content/installation/installation-with-operator.md @@ -8,11 +8,6 @@ toc: true docs: "DOCS-604" --- -{{< note >}} -An NGINX Ingress Operator version compatible with the 3.1.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. -{{< /note >}} - - This document describes how to install the F5 NGINX Ingress Controller in your Kubernetes cluster using the NGINX Ingress Operator. ## Prerequisites @@ -22,8 +17,8 @@ This document describes how to install the F5 NGINX Ingress Controller in your K * 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. * 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). * 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). -2. Install the NGINX Ingress Operator following the [instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/main/docs/installation.md). -3. Create the SecurityContextConstraint as outlined in the ["Getting Started" instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/main/README.md#getting-started). +2. Install the NGINX Ingress Operator following the [instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.4.1/docs/installation.md). +3. Create the SecurityContextConstraint as outlined in the ["Getting Started" instructions](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.4.1/README.md#getting-started). ## 1. Create the NginxIngressController manifest @@ -37,8 +32,6 @@ metadata: namespace: nginx-ingress spec: controller: - defaultTLS: - secret: "" image: pullPolicy: IfNotPresent repository: nginx/nginx-ingress @@ -51,7 +44,7 @@ spec: imagePullSecretName: "" ``` -**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 precreated docker config secret that should be associated with the ServiceAccount. +**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. ## 2. Create the NginxIngressController @@ -61,6 +54,6 @@ $ 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.3.0/docs/nginx-ingress-controller.md). +To configure other parameters of the NginxIngressController resource, check the [documentation](https://github.com/nginxinc/nginx-ingress-helm-operator/blob/v1.4.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. diff --git a/docs/content/technical-specifications.md b/docs/content/technical-specifications.md index e1539d92fb..afc418f6d6 100644 --- a/docs/content/technical-specifications.md +++ b/docs/content/technical-specifications.md @@ -23,9 +23,8 @@ We explicitly test the NGINX Ingress Controller (NIC) on a range of Kubernetes p {{% table %}} | NIC Version | Supported Kubernetes Version | NIC Helm Chart Version | NIC Operator Version | NGINX / NGINX Plus version | | --- | --- | --- | --- | --- | -| 3.1.1 | 1.26 - 1.22 | 0.17.1 | 1.3.0 | 1.23.4 / R29 | -| 3.1.0 | 1.26 - 1.22 | 0.17.0 | 1.3.0 | 1.23.3 / R28 | -| 3.0.2 | 1.26 - 1.21 | 0.16.2 | 1.3.0 | 1.23.3 / R28 | +| 3.1.1 | 1.26 - 1.22 | 0.17.1 | 1.4.1 | 1.23.4 / R29 | +| 3.0.2 | 1.26 - 1.21 | 0.16.2 | 1.3.1 | 1.23.3 / R28 | | 2.4.2 | 1.25 - 1.19 | 0.15.2 | 1.2.1 | 1.23.2 / R28 | | 2.3.1 | 1.24 - 1.19 | 0.14.1 | 1.1.0 | 1.23.1 / R27 | | 2.2.2 | 1.23 - 1.19 | 0.13.2 | 1.0.0 | 1.21.6 / R26 | @@ -78,10 +77,10 @@ NGINX Plus images are available through the F5 Container registry `private-regis We also provide NGINX Plus images through the AWS Marketplace. Please see [Using the AWS Marketplace Ingress Controller Image](/nginx-ingress-controller/installation/using-aws-marketplace-image/) for details on how to set up the required IAM resources in your EKS cluster. {{% table %}} -|Name | Base image | Third-party modules | AWS Marketplace Link | -| ---| ---| --- | --- | -|Debian-based image | ``debian:11-slim`` | NGINX Plus JavaScript and OpenTracing modules, OpenTracing tracers for Jaeger, Zipkin and Datadog | [NGINX Ingress Controller](https://aws.amazon.com/marketplace/pp/prodview-fx3faxl7zqeau) | -|Debian-based image with App Protect | ``debian:11-slim`` | NGINX Plus App Protect, JavaScript and OpenTracing modules, OpenTracing tracers for Jaeger, Zipkin and Datadog | [NGINX Ingress Controller with NGINX App Protect](https://aws.amazon.com/marketplace/pp/prodview-vnrnxbf6u3nra) | +|Name | Base image | Third-party modules | AWS Marketplace Link | Architectures | +| ---| ---| --- | --- | --- | +|Debian-based image | ``debian:11-slim`` | NGINX Plus JavaScript and OpenTracing modules, OpenTracing tracers for Jaeger, Zipkin and Datadog | [NGINX Ingress Controller](https://aws.amazon.com/marketplace/pp/prodview-fx3faxl7zqeau) | amd64 | +|Debian-based image with App Protect | ``debian:11-slim`` | NGINX Plus App Protect, JavaScript and OpenTracing modules, OpenTracing tracers for Jaeger, Zipkin and Datadog | [NGINX Ingress Controller with NGINX App Protect](https://aws.amazon.com/marketplace/pp/prodview-vnrnxbf6u3nra) | amd64 | {{% /table %}} ### Custom Images