From 99f0f7ec20a0684f4bd9d740064b4d198bac373a Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Wed, 20 Sep 2023 11:19:51 -0600 Subject: [PATCH 1/3] Add upgrade instructions --- docs/installation.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/docs/installation.md b/docs/installation.md index 3eb7899da2..d8c5edaa7b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -122,6 +122,48 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you nslookup ``` +## Upgrading NGINX Gateway Fabric + +### Upgrade NGINX Gateway Fabric from Manifests + +1. Upgrade the Gateway Resources + + Before you upgrade, ensure the Gateway API resources are the correct version as supported by the + NGINX Gateway Fabric - [see the Technical Specifications](/README.md#technical-specifications).: + + To upgrade the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run: + + ```shell + kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.0/standard-install.yaml + ``` + +1. Upgrade the NGINX Gateway Fabric CRDs + + Run the following command to upgrade the NGINX Gateway Fabric CRDs: + + ```shell + kubectl apply -f deploy/manifests/crds + ``` + + The following warning is expected and can be ignored: + + ```text + Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply. + ``` + +1. Upgrade NGINX Gateway Fabric Deployment + + Run the following command to upgrade NGINX Gateway Fabric: + + ```shell + kubectl apply -f deploy/manifests/nginx-gateway.yaml + ``` + +### Upgrade NGINX Gateway Fabric using Helm + +To upgrade NGINX Gateway Fabric when the deployment method is Helm, please follow the instructions +[here](/deploy/helm-chart/README.md#upgrading-the-chart). + ## Uninstalling NGINX Gateway Fabric ### Uninstall NGINX Gateway Fabric from Manifests From eeb8633dd487d02e14231adcdfe6f7693818d11c Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Wed, 20 Sep 2023 11:38:10 -0600 Subject: [PATCH 2/3] Remove colon and warning --- docs/installation.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index d8c5edaa7b..bdfc8e3af5 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -129,7 +129,7 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you 1. Upgrade the Gateway Resources Before you upgrade, ensure the Gateway API resources are the correct version as supported by the - NGINX Gateway Fabric - [see the Technical Specifications](/README.md#technical-specifications).: + NGINX Gateway Fabric - [see the Technical Specifications](/README.md#technical-specifications). To upgrade the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run: @@ -145,12 +145,6 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you kubectl apply -f deploy/manifests/crds ``` - The following warning is expected and can be ignored: - - ```text - Warning: kubectl apply should be used on resource created by either kubectl create --save-config or kubectl apply. - ``` - 1. Upgrade NGINX Gateway Fabric Deployment Run the following command to upgrade NGINX Gateway Fabric: From ad5a59eebbf0b56bbdc135ecb7e276dbf3a0252f Mon Sep 17 00:00:00 2001 From: Kate Osborn Date: Thu, 21 Sep 2023 14:31:19 -0600 Subject: [PATCH 3/3] Add note about gateway api release notes --- docs/installation.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index bdfc8e3af5..b3bfacf14c 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -128,8 +128,11 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you 1. Upgrade the Gateway Resources - Before you upgrade, ensure the Gateway API resources are the correct version as supported by the - NGINX Gateway Fabric - [see the Technical Specifications](/README.md#technical-specifications). + Before you upgrade, ensure the Gateway API resources are the correct version as supported by the NGINX Gateway + Fabric - [see the Technical Specifications](/README.md#technical-specifications). + The [release notes](https://github.com/kubernetes-sigs/gateway-api/releases/tag/v0.8.0) of the new version of the + Gateway API might include important upgrade-specific notes and instructions. We advise to check the release notes of + all versions between the one you're using and the new one. To upgrade the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run: