Use correct indentation in lifecyce examples#2588
Conversation
f89105d to
bda9581
Compare
|
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
|
I have hereby read the F5 CLA and agree to its terms |
|
Hi @Defrank! Thanks for opening this pull request! Please make sure to include the issue number in the PR description to automatically close the issue when the PR is merged. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2588 +/- ##
==========================================
- Coverage 95.19% 89.29% -5.91%
==========================================
Files 1 100 +99
Lines 229 7633 +7404
Branches 50 50
==========================================
+ Hits 218 6816 +6598
- Misses 11 761 +750
- Partials 0 56 +56 ☔ View full report in Codecov by Sentry. |
|
I have hereby read the F5 CLA and agree to its terms |
|
recheck |
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.
Proposed changes
Problem: The Helm chart example configuration for configuring
lifecycle.preStopuses a misleading indentation that can confuse users.Solution: Updated the Helm chart's README by fixing the indentation of the example code block to showcase the proper JSON paths of
nginxGateway.lifecycle.preStop.exec.commandandnginx.lifecycle.preStop.exec.command. ThePreStophook is described as havingexecas a handler in https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#hook-handler-execution and https://kubernetes.io/docs/tasks/configure-pod-container/attach-handler-lifecycle-event/#define-poststart-and-prestop-handlers.Testing:
Successfully deployed this chart into my cluster with the updated paths:
make unit-testmake lintmake lint-helmmake generate-allkubectl -n nginx-gateway exec deployment/gateway-nginx-gateway-fabric -c nginx -- nginx -Tmake unit-testlooks like everything passed except this single failure at the end:Checklist
Release notes