From 7c9bf23ed89861c9ce7b725f2c1686f4c24ef2f9 Mon Sep 17 00:00:00 2001 From: Ciara Stacke <18287516+ciarams87@users.noreply.github.com> Date: Fri, 7 Jun 2024 11:25:38 +0100 Subject: [PATCH] Add specific instruction for upgrading NGF from OSS to Plus (#2104) * Add specific instruction for upgrading OSS to Plus * Update site/content/installation/installing-ngf/manifests.md Co-authored-by: Alan Dooley --------- Co-authored-by: Alan Dooley --- site/content/installation/installing-ngf/helm.md | 16 +++++++++++++++- .../installation/installing-ngf/manifests.md | 16 +++++++++++++++- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/site/content/installation/installing-ngf/helm.md b/site/content/installation/installing-ngf/helm.md index 49f19084a5..4123826b17 100644 --- a/site/content/installation/installing-ngf/helm.md +++ b/site/content/installation/installing-ngf/helm.md @@ -37,7 +37,7 @@ helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-nam ##### For NGINX Plus -{{< note >}}Replace `private-registry.nginx.com` with the proper registry for your NGINX Plus image, and if applicable, replace `nginx-plus-registry-secret` with your Secret name containing the registry credentials.{{< /note >}} +{{< note >}}If applicable, replace the F5 Container registry `private-registry.nginx.com` with your internal registry for your NGINX Plus image, and replace `nginx-plus-registry-secret` with your Secret name containing the registry credentials.{{< /note >}} {{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) when installing.{{< /important >}} @@ -183,6 +183,20 @@ To upgrade the CRDs, take the following steps: If needed, replace `ngf` with your chosen release name. +## How to upgrade from NGINX OSS to NGINX Plus + +- To upgrade from NGINX OSS to NGINX Plus, update the Helm command to include the necessary values for Plus: + + {{< note >}}If applicable, replace the F5 Container registry `private-registry.nginx.com` with your internal registry for your NGINX Plus image, and replace `nginx-plus-registry-secret` with your Secret name containing the registry credentials.{{< /note >}} + + {{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) when installing.{{< /important >}} + + ```shell + helm upgrade ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --set nginx.image.repository=private-registry.nginx.com/nginx-gateway-fabric/nginx-plus --set nginx.plus=true --set serviceAccount.imagePullSecret=nginx-plus-registry-secret -n nginx-gateway + ``` + + If needed, replace `ngf` with your chosen release name. + ## Delay pod termination for zero downtime upgrades {#configure-delayed-pod-termination-for-zero-downtime-upgrades} {{< include "installation/delay-pod-termination/delay-pod-termination-overview.md" >}} diff --git a/site/content/installation/installing-ngf/manifests.md b/site/content/installation/installing-ngf/manifests.md index 07a6c4cb03..81977fc382 100644 --- a/site/content/installation/installing-ngf/manifests.md +++ b/site/content/installation/installing-ngf/manifests.md @@ -167,12 +167,26 @@ To upgrade NGINX Gateway Fabric and get the latest features and improvements, ta 1. **Upgrade NGINX Gateway Fabric deployment:** - - To upgrade the deployment, run: + - To upgrade your OSS deployment, run: ```shell kubectl apply -f https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/nginx-gateway.yaml ``` + - To upgrade your Plus deployment: + + Download the [deployment YAML](https://github.com/nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/nginx-plus-gateway.yaml). + + Update the `nginx-plus-gateway.yaml` file to include your chosen NGINX Plus image from the F5 Container registry or your custom image. + + ```shell + kubectl apply -f nginx-plus-gateway.yaml + ``` + + - To upgrade the deployment from NGINX OSS to NGINX Plus, follow the above instructions for upgrading your Plus deployment. + + {{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) before applying.{{< /important >}} + ## Delay pod termination for zero downtime upgrades {#configure-delayed-pod-termination-for-zero-downtime-upgrades} {{< include "installation/delay-pod-termination/delay-pod-termination-overview.md" >}}