Documenting selective override #1254
Merged
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
Andreagit97
reviewed
Jan 25, 2024
LucaGuerra
reviewed
Jan 26, 2024
LucaGuerra
reviewed
Jan 26, 2024
LucaGuerra
reviewed
Jan 26, 2024
LucaGuerra
reviewed
Jan 26, 2024
Signed-off-by: Mike Coleman <[email protected]>
mikegcoleman
force-pushed
the
add-selective-override
branch
from
4e99687 to
f3a0055
Compare
Co-authored-by: Luca Guerra <[email protected]> Signed-off-by: Mike Coleman <[email protected]>
Co-authored-by: Luca Guerra <[email protected]> Signed-off-by: Mike Coleman <[email protected]>
Signed-off-by: Mike Coleman <[email protected]>
Signed-off-by: Mike Coleman <[email protected]>
Signed-off-by: Mike Coleman <[email protected]>
Signed-off-by: Mike Coleman <[email protected]>
Signed-off-by: Mike Coleman <[email protected]>
incertum
reviewed
Jan 30, 2024
content/en/docs/rules/overriding.md
Outdated
| ## Overview | ||
| There may be cases where you need to adjust the behavior of the Falco-supplied {{< glossary_tooltip text="list" term_id="lists" >}}, {{< glossary_tooltip text="macro" term_id="macros" >}}, and {{< glossary_tooltip text="rule" term_id="rules" >}}. | ||
|
|
||
| You can override (modify) rules in falco two different ways: |
There was a problem hiding this comment.
Falco (upper case throughout?)
|
|
||
| You can override (modify) rules in falco two different ways: | ||
|
|
||
| 1) Define multiple rules files. The additional rules files can be used to add new lists, macros and rules or to override existing ones. |
There was a problem hiding this comment.
It doesn't fit in here but maybe you have an idea @mikegcoleman how to give a more concrete example. Somehow stating that a typical use case is to fetch the upstream Falco rules hosted in the rules repo and then customize them using the override feature.
There was a problem hiding this comment.
this is a good suggestion, maybe we can find a way to improve this part of the doc in a follow-up PR, i would start to merge this one
content/en/docs/rules/overriding.md
Outdated
| ```yaml | ||
| - rule: program_accesses_file | ||
| desc: track whenever a set of programs opens a file | ||
| condition: proc.name in (cat, ls) and evt.type=open |
content/en/docs/rules/overriding.md
Outdated
|
|
||
| ### Enabling a disabled rule | ||
|
|
||
| Using `enabled: true` is deprecated, and should be avoided. Falco 0.37.0 and later will display a warning If `enabled: true` is used. |
Co-authored-by: Melissa Kilby <[email protected]> Signed-off-by: Mike Coleman <[email protected]>
Co-authored-by: Melissa Kilby <[email protected]> Signed-off-by: Mike Coleman <[email protected]>
Co-authored-by: Melissa Kilby <[email protected]> Signed-off-by: Mike Coleman <[email protected]>
Co-authored-by: Melissa Kilby <[email protected]> Signed-off-by: Mike Coleman <[email protected]>
mikegcoleman
commented
Jan 30, 2024
content/en/docs/rules/overriding.md
Outdated
| ```yaml | ||
| - rule: program_accesses_file | ||
| desc: track whenever a set of programs opens a file | ||
| condition: proc.name in (cat, ls) and evt.type=open |
content/en/docs/rules/overriding.md
Outdated
| ## Overview | ||
| There may be cases where you need to adjust the behavior of the Falco-supplied {{< glossary_tooltip text="list" term_id="lists" >}}, {{< glossary_tooltip text="macro" term_id="macros" >}}, and {{< glossary_tooltip text="rule" term_id="rules" >}}. | ||
|
|
||
| You can override (modify) rules in falco two different ways: |
content/en/docs/rules/overriding.md
Outdated
|
|
||
| ### Enabling a disabled rule | ||
|
|
||
| Using `enabled: true` is deprecated, and should be avoided. Falco 0.37.0 and later will display a warning If `enabled: true` is used. |
Signed-off-by: Mike Coleman <[email protected]>
LucaGuerra
changed the title
Andreagit97
reviewed
Jan 30, 2024
Co-authored-by: Andrea Terzolo <[email protected]> Signed-off-by: Luca Guerra <[email protected]>
leogr
approved these changes
Jan 30, 2024
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: leogr, mikegcoleman The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
LGTM label has been added. Git tree hash: c75557a3bb5ed20657f6dc6579e9f70458a9cce1
|
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.
What type of PR is this?
/kind cleanup
/kind content
Any specific area of the project related to this PR?**
/area documentation
What this PR does / why we need it:
Adds documentation for the new selective override feature
Which issue(s) this PR fixes:
Fixes #1226
Special notes for your reviewer: