Skip to content

Add upgrade instructions #1089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 21, 2023
Merged

Add upgrade instructions #1089

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99f0f7e
Add upgrade instructions
Sep 20, 2023
eeb8633
Remove colon and warning
Sep 20, 2023
ad5a59e
Add note about gateway api release notes
Sep 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/installation.md
View file
Open in desktop
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