Skip to content

Commit 6a8f7be

Browse files
committed
update ref links and version values
1 parent 3b7acb9 commit 6a8f7be

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

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

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,35 @@ 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.0, 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.
1111

1212
---
1313

1414
### Upgrade from v1.x to v2.0
1515

16-
To upgrade NGINX Gateway Fabric from version 1.6.2 to the latest version 2.0.0, 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.
16+
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.
1717

1818
{{<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>}}
1919

20-
#### Uninstalling previous NGINX Gateway Fabric v1.6.x
20+
#### Uninstalling previous NGINX Gateway Fabric v1.x
2121

22-
To remove the previous version 1.6.x of NGINX Gateway Fabric, follow these steps:
22+
To remove the previous version 1.x of NGINX Gateway Fabric, follow these steps:
2323

2424
1. Run the following command to uninstall NGINX Gateway Fabric from the `nginx-gateway` namespace, updating `ngf` to your release name if different:
2525

2626
```shell
2727
helm uninstall ngf -n nginx-gateway
2828
```
2929

30-
1. To remove the CRDs associated with NGINX Gateway Fabric version 1.6.x, run the following command:
30+
1. To remove the CRDs associated with NGINX Gateway Fabric version 1.x, run the following command:
3131

3232
```shell
33-
kubectl delete -k "github.com/nginxinc/nginx-gateway-fabric/config/crd?ref=< ngf-version >"
33+
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< version-ngf >}}/deploy/crds.yaml
3434
```
3535

36-
#### Install using Helm
36+
{{<tabs name="install-helm">}}
3737

38-
Follow these steps to install NGINX Gateway Fabric v2.0.0 using helm:
38+
Follow these steps to install NGINX Gateway Fabric v2.x using helm:
3939

4040
1. First, apply the new CRDs with the following command:
4141

@@ -49,11 +49,11 @@ kubectl apply -k "github.com/nginxinc/nginx-gateway-fabric/config/crd?ref=< ngf-
4949
helm install ngf oci://ghcr.io/nginx/charts/nginx-gateway-fabric --create-namespace -n nginx-gateway
5050
```
5151

52-
For additional customization options during the helm installation process, take a look at [Installation with Helm](../../installation/installing-ngf/helm.md).
52+
For additional customization options during the helm installation process, take a look at [Installation with Helm]({{< ref "../../installation/installing-ngf/helm.md" >}}).
5353

54-
#### Install using Manifests
54+
{{<tabs name="install-manifests">}}
5555

56-
Follow these steps to install NGINX Gateway Fabric v2.0.0 using manifests:
56+
Follow these steps to install NGINX Gateway Fabric v2.x using manifests:
5757

5858
1. First, apply the new CRDs with the following command:
5959

@@ -67,30 +67,28 @@ kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{
6767
kubectl apply -f https://raw.githubusercontent.com/nginx/nginx-gateway-fabric/v{{< ngf-version >}}/deploy/default/deploy.yaml
6868
```
6969

70-
For additional customization options during the installation process using manifests, take a look at [Installation with Manifests](../../installation/installing-ngf/manifests.md)
70+
For additional customization options during the installation process using manifests, take a look at [Installation with Manifests]({{< ref "../../installation/installing-ngf/manifests.md" >}})
7171

7272
---
7373

7474
### Architecture changes
7575

7676
With this release, NGINX Gateway Fabric adopts a new architecture that separates the control plane and data plane into independent deployments. This separation improves scalability, security, and operational clarity.
7777

78-
The control plane is a Kubernetes controller built with `controller-runtime`. It watches Gateway API and Kubernetes resources (e.g., Services, Endpoints, Secrets) and dynamically provisions NGINX data plane deployments for each Gateway.
78+
The control plane is a Kubernetes controller that watches Gateway API and Kubernetes resources (e.g., Services, Endpoints, Secrets) and dynamically provisions NGINX data plane deployments for each Gateway.
7979

8080
NGINX configurations are generated by the control plane and securely delivered to the data planes via gRPC, using the NGINX Agent. TLS is enabled by default, with optional integration with `cert-manager`.
8181

8282
Each data plane pod runs NGINX alongside the Agent, which applies config updates and handles reloads without shared volumes or signals. This design ensures dynamic, per-Gateway traffic management and operational isolation.
8383

8484
New fields have been added to the `NginxProxy` resource to configure infrastructure-related settings for data plane deployments. You can modify the `NginxProxy` resource at either the Gateway or GatewayClass level. These new fields provide the flexibility to customize deployment and service configurations.
8585

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

8888
---
8989

90-
### Key links for the version 2.0.0 update
90+
### Key links for the version 2.x update
9191

92-
- To read more on [modifying data plane configuration](../../how-to/data-plane-configuration.md)
93-
- To read more on [modifying control plane configuration](../../how-to/control-plane-configuration.md)
94-
- To adding secure [authentication to control plane and data planes](./control-plane-certs.md)
95-
- For detailed information on [architecture changes](../../overview//gateway-architecture.md)
96-
- For detailed [API reference](../../reference/api.md)
92+
- To read more on [modifying data plane configuration]({{< ref "../../how-to/data-plane-configuration.md" >}})
93+
- To adding secure [authentication to control plane and data planes]({{< ref "./control-plane-certs.md" >}})
94+
- For detailed [API reference]({{< ref "../../reference/api.md" >}})

0 commit comments

Comments
 (0)