Skip to content

Commit

Permalink
Use correct indentation in lifecyce examples (nginx#2588)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
miledxz committed Sep 24, 2024
1 parent d8a440c commit b1f622a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 30 deletions.
30 changes: 15 additions & 15 deletions charts/nginx-gateway-fabric/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,23 +191,23 @@ being performed on NGF), you may need to configure delayed termination on the NG

```yaml
nginxGateway:
<...>
lifecycle:
preStop:
exec:
command:
- /usr/bin/gateway
- sleep
- --duration=40s # This flag is optional, the default is 30s
<...>
lifecycle:
preStop:
exec:
command:
- /usr/bin/gateway
- sleep
- --duration=40s # This flag is optional, the default is 30s

nginx:
<...>
lifecycle:
preStop:
exec:
command:
- /bin/sleep
- "40"
<...>
lifecycle:
preStop:
exec:
command:
- /bin/sleep
- "40"
```
2. Ensure the `terminationGracePeriodSeconds` matches or exceeds the `sleep` value from the `preStopHook` (the default
Expand Down
30 changes: 15 additions & 15 deletions charts/nginx-gateway-fabric/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -189,23 +189,23 @@ being performed on NGF), you may need to configure delayed termination on the NG

```yaml
nginxGateway:
<...>
lifecycle:
preStop:
exec:
command:
- /usr/bin/gateway
- sleep
- --duration=40s # This flag is optional, the default is 30s
<...>
lifecycle:
preStop:
exec:
command:
- /usr/bin/gateway
- sleep
- --duration=40s # This flag is optional, the default is 30s

nginx:
<...>
lifecycle:
preStop:
exec:
command:
- /bin/sleep
- "40"
<...>
lifecycle:
preStop:
exec:
command:
- /bin/sleep
- "40"
```

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

0 comments on commit b1f622a

Please sign in to comment.