nginxinc / nginx-gateway-fabric

NGINX Gateway Fabric provides an implementation for the Gateway API using NGINX as the data plane.
Apache License 2.0
501 stars 97 forks source link

fix(chart-readme): Use correct indentation in lifecyce.preStop examples #2587

Closed defrank closed 1 month ago

defrank commented 1 month ago

Proposed changes

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 to showcase the proper JSON paths of nginxGateway.lifecycle.preStop.exec.command and nginx.lifecycle.preStop.exec.command. The PreStop hook is described as having exec as 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, but still trying to figure out how to confirm they are set.

Checklist

Release notes

NONE
github-actions[bot] commented 1 month ago

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:


I have hereby read the F5 CLA and agree to its terms


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

defrank commented 1 month ago

Closing to update to branch naming convention