Falco Alerts Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/falco/properties/alerts
Configure Falco alerts sent from Falco sidekick.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (Falco Alerts)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| enabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| type | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| hostPort | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| priority | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
enabled¶
enabled
-
is optional
-
Type:
boolean(Falco Alerts Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Falco Alerts Enabled)
type¶
Configure the notification channel for Falco alerts.
type
-
is optional
-
Type:
string(Falco Alerts Type) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Falco Alerts Type)
CONSTRAINTS:
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"alertmanager" |
|
"slack" |
DEFAULTS:
The default value is:
"alertmanager"
hostPort¶
Configure the notification channel for Falco alerts.
hostPort
-
is optional
-
Type:
string(Falco Alerts Host Port) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Falco Alerts Host Port)
CONSTRAINTS:
URI: the string must be a URI, according to RFC 3986
DEFAULTS:
The default value is:
"http://alertmanager-operated.monitoring:9093"
priority¶
Configure the notification priority for Falco alerts.
priority
-
is optional
-
Type:
string(Falco Alerts Priority) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Falco Alerts Priority)
DEFAULTS:
The default value is:
"notice"
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main