Improve Helm values docs #2625
Merged
Improve Helm values docs #2625
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lambdanis
added
release-note/docs
✅ Deploy Preview for tetragon ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
This was referenced Jul 2, 2024
Closed
tixxdz
reviewed
Jul 8, 2024
| @@ -30,8 +30,6 @@ serviceLabelsOverride: {} | |||
| dnsPolicy: Default | |||
| # -- exportDirectory specifies directory to put Tetragon JSON export files. | |||
| exportDirectory: "/var/run/cilium/tetragon" | |||
| # -- exportFileRotationInterval specifies file creation interval for hubble-export-s3. | |||
| exportFileCreationInterval: "120s" | |||
There was a problem hiding this comment.
How it is not used when it is defined? what am I missing?
There was a problem hiding this comment.
huh, I haven't even noticed it's documented as rotation. It's not used anywhere in the templates - just a hanging value, some leftover I believe.
Add "-- " prefix to comments in values.yaml file that didn;t have it, so that the comments are included in the generated docs. Remove "-- " from comments not documenting individual values. Signed-off-by: Anna Kapuscinska <[email protected]>
The export container exports only to stdout, so recommendations about the DNS policy were irrelevant. Signed-off-by: Anna Kapuscinska <[email protected]>
It's not used. Signed-off-by: Anna Kapuscinska <[email protected]>
Signed-off-by: Anna Kapuscinska <[email protected]>
Signed-off-by: Anna Kapuscinska <[email protected]>
lambdanis
force-pushed
the
pr/lambdanis/export-perm-doc
branch
from
b699336 to
6fc37b0
Compare
tixxdz
approved these changes
Jul 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I wanted to improve doc comment for
exportFilePermvalue, but noticed other issues in Helm values docs, so fixed them too. See commits.