Skip to content

Commit db6201f

Browse files
committed
More review feedback
1 parent 4b0e789 commit db6201f

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

deploy/helm-chart/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ helm upgrade my-release . -n nginx-gateway
127127
### Configure Delayed Termination for Zero Downtime Upgrades
128128

129129
To achieve zero downtime upgrades (meaning clients will not see any interruption in traffic while a rolling upgrade is
130-
being performed on NGF), you may need to configure delayed termination on the NGF pod, depending on your environment.
130+
being performed on NGF), you may need to configure delayed termination on the NGF Pod, depending on your environment.
131131

132132
> **Note**
133133
> When proxying Websocket or any long-lived connections, NGINX will not terminate until that connection is closed
@@ -160,7 +160,7 @@ being performed on NGF), you may need to configure delayed termination on the NG
160160
```
161161
162162
2. Ensure the `terminationGracePeriodSeconds` matches or exceeds the `sleep` value from the `preStopHook` (the default
163-
is 30). This is to ensure Kubernetes does not terminate the pod before the `preStopHook` is complete. To do so,
163+
is 30). This is to ensure Kubernetes does not terminate the Pod before the `preStopHook` is complete. To do so,
164164
update your `values.yaml` file to include the following (update the value to what is required in your environment):
165165

166166
```yaml
@@ -171,7 +171,7 @@ being performed on NGF), you may need to configure delayed termination on the NG
171171
> More information on container lifecycle hooks can be found
172172
> [here](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks) and a detailed
173173
> description of Pod termination behavior can be found in
174-
> [Termination of Pods](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination).
174+
> [Termination of Pods](https://kubernetes.io/docs/concepts/workloads/Pods/Pod-lifecycle/#Pod-termination).
175175

176176
## Uninstalling the Chart
177177

docs/installation.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,10 @@ Create a Service with type `LoadBalancer` using the appropriate manifest for you
148148

149149
## Upgrading NGINX Gateway Fabric
150150

151+
> **Note**
152+
> See [below](#configure-delayed-termination-for-zero-downtime-upgrades) for instructions on how to configure delayed
153+
> termination if required for zero downtime upgrades in your environment.
154+
151155
### Upgrade NGINX Gateway Fabric from Manifests
152156

153157
1. Upgrade the Gateway Resources
@@ -188,7 +192,7 @@ To upgrade NGINX Gateway Fabric when the deployment method is Helm, please follo
188192
### Configure Delayed Termination for Zero Downtime Upgrades
189193

190194
To achieve zero downtime upgrades (meaning clients will not see any interruption in traffic while a rolling upgrade is
191-
being performed on NGF), you may need to configure delayed termination on the NGF pod, depending on your environment.
195+
being performed on NGF), you may need to configure delayed termination on the NGF Pod, depending on your environment.
192196

193197
> **Note**
194198
> When proxying Websocket or any long-lived connections, NGINX will not terminate until that connection is closed
@@ -226,17 +230,17 @@ Edit the `deploy/manifests/nginx-gateway.yaml` to include the following:
226230
```
227231

228232
2. Ensure the `terminationGracePeriodSeconds` matches or exceeds the `sleep` value from the `preStopHook` (the default
229-
is 30). This is to ensure Kubernetes does not terminate the pod before the `preStopHook` is complete.
233+
is 30). This is to ensure Kubernetes does not terminate the Pod before the `preStopHook` is complete.
230234

231235
> **Note**
232236
> More information on container lifecycle hooks can be found
233237
> [here](https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks) and a detailed
234238
> description of Pod termination behavior can be found in
235-
> [Termination of Pods](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination).
239+
> [Termination of Pods](https://kubernetes.io/docs/concepts/workloads/Pods/Pod-lifecycle/#Pod-termination).
236240

237241
#### Configure Delayed Termination Using Helm
238242

239-
To configure delayed termination on the NGF pod when the deployment method is Helm, please follow the instructions
243+
To configure delayed termination on the NGF Pod when the deployment method is Helm, please follow the instructions
240244
[here](/deploy/helm-chart/README.md#configure-delayed-termination-for-zero-downtime-upgrades).
241245

242246
## Uninstalling NGINX Gateway Fabric

0 commit comments

Comments
 (0)