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.

Sign up for GitHub

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: Escape Markdown pipes #3332

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Escape Markdown pipes #3332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/en/docs/reference/helm-chart.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions install/kubernetes/tetragon/README.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions install/kubernetes/tetragon/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,15 @@ tetragon:
# For example, to exclude the "parent" field from all events and include the "process"
# field in PROCESS_KPROBE events while excluding all others:
#
# fieldFilters: |
# fieldFilters: \|
# {"fields": "parent", "action": "EXCLUDE"}
# {"event_set": ["PROCESS_KPROBE"], "fields": "process", "action": "INCLUDE"}
#
fieldFilters: ""
# -- Filters to redact secrets from the args fields in Tetragon events. To perform
# redactions, redaction filters define RE2 regular expressions in the `redact`
# field. Any capture groups in these RE2 regular expressions are redacted and
# replaced with "*****".
# replaced with "\*\*\*\*\*".
#
# For more control, you can select which binary or binaries should have their
# arguments redacted with the `binary_regex` field.
Expand All @@ -124,15 +124,15 @@ tetragon:
# As a concrete example, the following will redact all passwords passed to
# processes with the "--password" argument:
#
# {"redact": ["--password(?:\\s+|=)(\\S*)"]}
# {"redact": ["--password(?:\\s+\|=)(\\S*)"]}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well this is not ideal since it eventually modify these regex (binary_regex) so that docs looks better but the direct docs on values isn't exact anymore. I'm afraid you'll have to fix the thing we use for the generation, it seems the issue already exists :/. This is a complete different task than just fixing this docs so don't feel like you have to fix this!

See:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! You are right.
Should I add this to the Issue?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as you wish! if you don't consider fixing this other project's issue I might take a look eventually, tell me

#
# Now, an event which contains the string "--password=foo" would have that
# string replaced with "--password=*****".
#
# Suppose we also see some passwords passed via the -p shorthand for a specific binary, foo.
# We can also redact these as follows:
#
# {"binary_regex": ["(?:^|/)foo$"], "redact": ["-p(?:\\s+|=)(\\S*)"]}
# {"binary_regex": ["(?:^\|/)foo$"], "redact": ["-p(?:\\s+\|=)(\\S*)"]}
#
# With both of the above redaction filters in place, we are now redacting all
# password arguments.
Expand Down
Loading