Skip to content

Commit 16ab0ee

Browse files
authored
Add upgrade instructions (#1089)
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.
1 parent c98b2fa commit 16ab0ee

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

docs/installation.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,45 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you
122122
nslookup <dns-name>
123123
```
124124

125+
## Upgrading NGINX Gateway Fabric
126+
127+
### Upgrade NGINX Gateway Fabric from Manifests
128+
129+
1. Upgrade the Gateway Resources
130+
131+
Before you upgrade, ensure the Gateway API resources are the correct version as supported by the NGINX Gateway
132+
Fabric - [see the Technical Specifications](/README.md#technical-specifications).
133+
The [release notes](https://github.com/kubernetes-sigs/gateway-api/releases/tag/v0.8.0) of the new version of the
134+
Gateway API might include important upgrade-specific notes and instructions. We advise to check the release notes of
135+
all versions between the one you're using and the new one.
136+
137+
To upgrade the Gateway resources from [the Gateway API repo](https://github.com/kubernetes-sigs/gateway-api), run:
138+
139+
```shell
140+
kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/download/v0.8.0/standard-install.yaml
141+
```
142+
143+
1. Upgrade the NGINX Gateway Fabric CRDs
144+
145+
Run the following command to upgrade the NGINX Gateway Fabric CRDs:
146+
147+
```shell
148+
kubectl apply -f deploy/manifests/crds
149+
```
150+
151+
1. Upgrade NGINX Gateway Fabric Deployment
152+
153+
Run the following command to upgrade NGINX Gateway Fabric:
154+
155+
```shell
156+
kubectl apply -f deploy/manifests/nginx-gateway.yaml
157+
```
158+
159+
### Upgrade NGINX Gateway Fabric using Helm
160+
161+
To upgrade NGINX Gateway Fabric when the deployment method is Helm, please follow the instructions
162+
[here](/deploy/helm-chart/README.md#upgrading-the-chart).
163+
125164
## Uninstalling NGINX Gateway Fabric
126165

127166
### Uninstall NGINX Gateway Fabric from Manifests

0 commit comments

Comments
 (0)