Skip to content

Commit 7c9bf23

Browse files
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 <[email protected]> --------- Co-authored-by: Alan Dooley <[email protected]>
1 parent 7e00ed3 commit 7c9bf23

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

site/content/installation/installing-ngf/helm.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ helm install ngf oci://ghcr.io/nginxinc/charts/nginx-gateway-fabric --create-nam
3737

3838
##### For NGINX Plus
3939

40-
{{< 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 >}}
40+
{{< 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 >}}
4141

4242
{{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) when installing.{{< /important >}}
4343

@@ -183,6 +183,20 @@ To upgrade the CRDs, take the following steps:
183183

184184
If needed, replace `ngf` with your chosen release name.
185185

186+
## How to upgrade from NGINX OSS to NGINX Plus
187+
188+
- To upgrade from NGINX OSS to NGINX Plus, update the Helm command to include the necessary values for Plus:
189+
190+
{{< 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 >}}
191+
192+
{{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) when installing.{{< /important >}}
193+
194+
```shell
195+
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
196+
```
197+
198+
If needed, replace `ngf` with your chosen release name.
199+
186200
## Delay pod termination for zero downtime upgrades {#configure-delayed-pod-termination-for-zero-downtime-upgrades}
187201

188202
{{< include "installation/delay-pod-termination/delay-pod-termination-overview.md" >}}

site/content/installation/installing-ngf/manifests.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -167,12 +167,26 @@ To upgrade NGINX Gateway Fabric and get the latest features and improvements, ta
167167

168168
1. **Upgrade NGINX Gateway Fabric deployment:**
169169

170-
- To upgrade the deployment, run:
170+
- To upgrade your OSS deployment, run:
171171

172172
```shell
173173
kubectl apply -f https://github.com./nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/nginx-gateway.yaml
174174
```
175175

176+
- To upgrade your Plus deployment:
177+
178+
Download the [deployment YAML](https://github.com./nginxinc/nginx-gateway-fabric/releases/download/v1.2.0/nginx-plus-gateway.yaml).
179+
180+
Update the `nginx-plus-gateway.yaml` file to include your chosen NGINX Plus image from the F5 Container registry or your custom image.
181+
182+
```shell
183+
kubectl apply -f nginx-plus-gateway.yaml
184+
```
185+
186+
- To upgrade the deployment from NGINX OSS to NGINX Plus, follow the above instructions for upgrading your Plus deployment.
187+
188+
{{< important >}}Ensure that you [Enable Usage Reporting]({{< relref "installation/usage-reporting.md" >}}) before applying.{{< /important >}}
189+
176190
## Delay pod termination for zero downtime upgrades {#configure-delayed-pod-termination-for-zero-downtime-upgrades}
177191

178192
{{< include "installation/delay-pod-termination/delay-pod-termination-overview.md" >}}

0 commit comments

Comments
 (0)