github/falco
1
0
Fork 0
mirror of https://github.com/falcosecurity/falco.git synced 2025-06-30 08:32:12 +00:00
Code Issues Projects Releases Wiki Activity

chore(docs): added falco.yaml section about config keys maturity.

Browse Source 
Also, rename `Experimental` -> `Incubating` and move `prometheus_metrics_enabled` to `Incubating`.

Signed-off-by: Federico Di Pierro <nierro92@gmail.com>
This commit is contained in:
Federico Di Pierro 2024-05-20 10:46:51 +02:00 committed by poiana
parent 0668c54485
commit c03ce122e7
1 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
falco.yaml
View File

@ -25,7 +25,7 @@
# #
# (Falco command-line arguments) # (Falco command-line arguments)
# (Falco environment variables) # (Falco environment variables)
# Falco config files # Falco configs files
# configs_files # configs_files
# Falco rules files # Falco rules files
# rules_files # rules_files
@ -70,6 +70,19 @@
# Falco libs # Falco libs
# falco_libs # falco_libs
########################
# Config maturity tags #
########################
# As per features adoption and deprecation proposal we support 4 levels of configuration keys maturity:
# * Sandbox -> Experimental/alpha features, not recommended for production use, can be removed at any time without further notice.
# * Incubating -> Beta features, long-term support is not guaranteed.
# * Stable -> General Availability (GA) features for which long-term support is expected.
# * Deprecated -> Deprecated keys, soon to be removed.
#
# For more info, please take a look at the proposal: https://github.com/falcosecurity/falco/blob/master/proposals/20231220-features-adoption-and-deprecation.md.
################################ ################################
# Falco command-line arguments # # Falco command-line arguments #
################################ ################################
@ -138,7 +151,7 @@ configs_files:
# [Stable] `rules_files` # [Stable] `rules_files`
NOTICE: Before Falco 0.38, this config key was `rules_file` (singular form), which is now deprecated in favor of `rules_files` (plural form). # NOTICE: Before Falco 0.38, this config key was `rules_file` (singular form), which is now deprecated in favor of `rules_files` (plural form).
# #
# Falco rules can be specified using files or directories, which are loaded at # Falco rules can be specified using files or directories, which are loaded at
# startup. # startup.
@ -525,7 +538,7 @@ json_include_tags_property: true
# output mechanism. By default, buffering is disabled (false). # output mechanism. By default, buffering is disabled (false).
buffered_outputs: false buffered_outputs: false
# [Experimental] `rule_matching` # [Incubating] `rule_matching`
# #
# The `rule_matching` configuration key's values are: # The `rule_matching` configuration key's values are:
# - `first`: Falco stops checking conditions of rules against upcoming event # - `first`: Falco stops checking conditions of rules against upcoming event
@ -749,6 +762,8 @@ webserver:
# Can be an IPV4 or IPV6 address, defaults to IPV4 # Can be an IPV4 or IPV6 address, defaults to IPV4
listen_address: 0.0.0.0 listen_address: 0.0.0.0
k8s_healthz_endpoint: /healthz k8s_healthz_endpoint: /healthz
# [Incubating] `prometheus_metrics_enabled`
#
# Enable the metrics endpoint providing Prometheus values # Enable the metrics endpoint providing Prometheus values
# It will only have an effect if metrics.enabled is set to true as well. # It will only have an effect if metrics.enabled is set to true as well.
prometheus_metrics_enabled: false prometheus_metrics_enabled: false
@ -1170,7 +1185,7 @@ base_syscalls:
# Falco libs # # Falco libs #
############## ##############
# [Experimental] `falco_libs` - Potentially subject to more frequent changes # [Incubating] `falco_libs` - Potentially subject to more frequent changes
# #
# `thread_table_size` # `thread_table_size`
# #