Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 1 commit into from

Conversation

defrank
Copy link
Contributor

@defrank defrank commented Sep 21, 2024

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

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

NONE

@github-actions github-actions bot added documentation Improvements or additions to documentation helm-chart Relates to helm chart labels Sep 21, 2024
Copy link
Contributor

github-actions bot commented Sep 21, 2024

🎉 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
Copy link
Contributor Author

defrank commented Sep 21, 2024

Closing to update to branch naming convention

@defrank defrank closed this Sep 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation helm-chart Relates to helm chart
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant