Skip to content

Commit

Permalink
Add upgrade instructions (#1089)
Browse files Browse the repository at this point in the history
Problem: There are no instructions on how to upgrade 
NGF using manifests.

Solution: Add a section to the installation doc that 
describes how to upgrade NGF with manifests.
  • Loading branch information
kate-osborn authored Sep 21, 2023
1 parent c98b2fa commit 16ab0ee
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,45 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you
nslookup <dns-name>
```

## 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).
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:

```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
```

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
Expand Down

0 comments on commit 16ab0ee

Please sign in to comment.