diff --git a/docs/configuration.md b/docs/configuration.md index 16a7674..aebd380 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -314,6 +314,8 @@ Examples of alerts: > The route 1.2.3.4/24 announced by AS1234 is not covered by a ROA > The route 1.2.3.4/24 announced by AS1234 is no longer covered by a ROA +You need to configure your RPKI data source as described [here](rpki.md). + Parameters for this monitor module: |Parameter| Description| @@ -324,6 +326,35 @@ Parameters for this monitor module: |cacheValidPrefixesSeconds| Amount of seconds ROAs get cached in order to identify RPKI repository malfunctions (e.g. disappearing ROAs). Default to 7 days. | +#### monitorROAS + +This monitor will periodically check and report diffs in ROAs repos involving any of your ASes or prefixes. +You need to configure your RPKI data source as described [here](rpki.md). +Note, while BGPalerter will perform the check near real time, many RIRs have delayed ROAs publication times. + + +> Example: +> The prefixes list of BGPalerter has the following entries: +> ```yaml +> 1.2.3.4/24: +> asn: 1234 +> description: an example +> ignoreMorespecifics: false +> +> options: +> monitorASns: +> 2914: +> group: default +> ``` +> If in config.yml monitorROAS is enabled, you will receive alerts every time: +> * A ROA that is, or was, involving 1.2.3.4/24 is added/edited/removed. +> * A ROA that is, or was, involving AS2914 is added/edited/removed. + + +Example of alerts: +> ROAs change detected: removed <1.2.3.4/24, 1234, 25, apnic> + + ### Reports