Skip to content

Commit c4690b7

Browse files
Apply suggestions from code review
Co-authored-by: Alan Dooley <[email protected]>
1 parent 93f159b commit c4690b7

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

content/ngf/installation/installing-ngf/upgrading-ngf.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,26 @@ product: NGF
77
docs: DOCS-0000
88
---
99

10-
This guide provides step-by-step instructions for upgrading NGINX Gateway Fabric from version 1.x to 2.x, highlighting key architectural changes, expected downtime, and important considerations for custom resource definitions.
10+
This guide provides step-by-step instructions for upgrading NGINX Gateway Fabric from version 1.x to 2.x, highlighting key architectural changes, expected downtime, and important considerations for custom resource definitions (CRDs).
1111

12-
---
1312

1413
### Upgrade from v1.x to v2.x
1514

1615
To upgrade NGINX Gateway Fabric from version 1.x to the new architecture in version 2.x, you must uninstall the existing NGINX Gateway Fabric CRDs and deployment, and perform a fresh installation. This will cause brief downtime during the upgrade process.
1716

1817
{{<note>}} You do not need to uninstall the Gateway API CRDs during the upgrade. These resources are compatible with the new NGINX Gateway Fabric version. {{</note>}}
1918

20-
#### Uninstalling previous NGINX Gateway Fabric v1.x
19+
#### Uninstall NGINX Gateway Fabric v1.x
2120

2221
To remove the previous version 1.x of NGINX Gateway Fabric, follow these steps:
2322

24-
1. Run the following command to uninstall NGINX Gateway Fabric from the `nginx-gateway` namespace, updating `ngf` to your release name if different:
23+
First, run the following command to uninstall NGINX Gateway Fabric from the `nginx-gateway` namespace, and update the release name to `ngf` to your release name if it is different:
2524

2625
```shell
2726
helm uninstall ngf -n nginx-gateway
2827
```
2928

30-
2. To remove the CRDs associated with NGINX Gateway Fabric version 1.x, run the following command:
29+
Afterwards, remove CRDs associated with NGINX Gateway Fabric version 1.x with the following command:
3130

3231
```shell
3332
kubectl delete -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
@@ -37,15 +36,15 @@ kubectl delete -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v
3736

3837
{{%tab name="Helm"%}}
3938

40-
Follow these steps to install NGINX Gateway Fabric v2.x using helm:
39+
Follow these steps to install NGINX Gateway Fabric v2.x using Helm:
4140

42-
1. First, apply the new CRDs with the following command:
41+
Apply the new CRDs with the following command:
4342

4443
```shell
4544
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
4645
```
4746

48-
2. Next, to install the latest stable release of NGINX Gateway Fabric in the `nginx-gateway` namespace, run the following command:
47+
Next, install the latest stable release of NGINX Gateway Fabric in the `nginx-gateway` namespace with the following command:
4948

5049
```shell
5150
helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway
@@ -57,16 +56,15 @@ For additional customization options during the helm installation process, take
5756

5857
{{%tab name="Manifests"%}}
5958

59+
Follow these steps to install NGINX Gateway Fabric v2.x using Manifests:
6060

61-
Follow these steps to install NGINX Gateway Fabric v2.x using manifests:
62-
63-
1. First, apply the new CRDs with the following command:
61+
Apply the new CRDs with the following command:
6462

6563
```shell
6664
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
6765
```
6866

69-
1. Next, to install the latest stable release of NGINX Gateway Fabric in the `nginx-gateway` namespace, run the following command:
67+
Next, install the latest stable release of NGINX Gateway Fabric in the `nginx-gateway` namespace with the following command:
7068

7169
```shell
7270
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/default/deploy.yaml
@@ -78,7 +76,6 @@ For additional customization options during the installation process using manif
7876

7977
{{</tabs>}}
8078

81-
---
8279

8380
### Architecture changes
8481

@@ -94,7 +91,6 @@ New fields have been added to the `NginxProxy` resource to configure infrastruct
9491

9592
For detailed instructions on how to modify these settings, refer to the [Configure infrastructure-related settings]({{< ref "/ngf/how-to/data-plane-configuration.md#configure-infrastructure-related-settings" >}}) guide.
9693

97-
---
9894

9995
### Key links for the version 2.x update
10096

0 commit comments

Comments
 (0)