Skip to content

Commit b1f622a

Browse files
committed
Use correct indentation in lifecyce examples (nginx#2588)
Problem: The Helm chart example configuration for configuring lifecycle.preStop uses a misleading indentation that can confuse users. Solution: Updated the Helm chart's README by fixing the indentation of the example code block.
1 parent d8a440c commit b1f622a

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

charts/nginx-gateway-fabric/README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -191,23 +191,23 @@ being performed on NGF), you may need to configure delayed termination on the NG
191191

192192
```yaml
193193
nginxGateway:
194-
<...>
195-
lifecycle:
196-
preStop:
197-
exec:
198-
command:
199-
- /usr/bin/gateway
200-
- sleep
201-
- --duration=40s # This flag is optional, the default is 30s
194+
<...>
195+
lifecycle:
196+
preStop:
197+
exec:
198+
command:
199+
- /usr/bin/gateway
200+
- sleep
201+
- --duration=40s # This flag is optional, the default is 30s
202202

203203
nginx:
204-
<...>
205-
lifecycle:
206-
preStop:
207-
exec:
208-
command:
209-
- /bin/sleep
210-
- "40"
204+
<...>
205+
lifecycle:
206+
preStop:
207+
exec:
208+
command:
209+
- /bin/sleep
210+
- "40"
211211
```
212212
213213
2. Ensure the `terminationGracePeriodSeconds` matches or exceeds the `sleep` value from the `preStopHook` (the default

charts/nginx-gateway-fabric/README.md.gotmpl

+15-15
Original file line numberDiff line numberDiff line change
@@ -189,23 +189,23 @@ being performed on NGF), you may need to configure delayed termination on the NG
189189

190190
```yaml
191191
nginxGateway:
192-
<...>
193-
lifecycle:
194-
preStop:
195-
exec:
196-
command:
197-
- /usr/bin/gateway
198-
- sleep
199-
- --duration=40s # This flag is optional, the default is 30s
192+
<...>
193+
lifecycle:
194+
preStop:
195+
exec:
196+
command:
197+
- /usr/bin/gateway
198+
- sleep
199+
- --duration=40s # This flag is optional, the default is 30s
200200

201201
nginx:
202-
<...>
203-
lifecycle:
204-
preStop:
205-
exec:
206-
command:
207-
- /bin/sleep
208-
- "40"
202+
<...>
203+
lifecycle:
204+
preStop:
205+
exec:
206+
command:
207+
- /bin/sleep
208+
- "40"
209209
```
210210

211211
2. Ensure the `terminationGracePeriodSeconds` matches or exceeds the `sleep` value from the `preStopHook` (the default

0 commit comments

Comments
 (0)