feat: add Falco runtime security rules JSON schema#5861
Open
Goutham-Annem wants to merge 2 commits into
Open
Conversation
Add a JSON Schema for Falco security rules files, enabling IDE autocompletion and validation for falco_rules.yaml and falco_rules.local.yaml files. The schema covers all Falco rule constructs including rules, macros, lists, required_engine_version, required_plugin_versions, exceptions, and the override syntax for extending existing rules. Relates to: falcosecurity/falco#3432
Goutham-Annem
requested review from
hyperupcall and
madskristensen
as code owners
Contributor
|
Thanks for the PR! This section of the codebase is owned by @madskristensen and |
for more information, see https://pre-commit.ci
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a JSON Schema for Falco runtime security rules files, enabling IDE autocompletion and validation.
Schema file:
src/schemas/json/falco-rules.jsonCatalog entry added with
fileMatchforfalco_rules.yamlandfalco_rules.local.yamlWhat is Falco?
Falco is a CNCF Incubating cloud-native runtime security tool. Users write rules in YAML files that are loaded by Falco to detect suspicious behavior at runtime.
Schema Coverage
The schema covers all Falco rule file constructs:
rule,desc,condition,output,priority,tags,source,enabled,exceptionsmacro,condition,appendlist,items,appendrequired_engine_version,required_plugin_versions(withalternatives)overridefield withappend/replacesemantics for extending built-in rulesThe schema was derived from the official Falco engine schema (accessible via
falco --rule-schema) with added descriptions for each property.Related