1
0
mirror of https://github.com/nttgin/BGPalerter.git synced 2024-05-19 06:50:08 +00:00

improved documentation about connectorRISdump

This commit is contained in:
Massimo Candela
2021-06-04 00:53:48 +02:00
parent 12fbca9a14
commit 2faadc3458
4 changed files with 28 additions and 7 deletions

View File

@@ -12,8 +12,8 @@ connectors:
socketOptions:
includeRaw: false
- file: connectorRISDump
name: dmp
# - file: connectorRISDump
# name: dmp
monitors:
- file: monitorHijack

View File

@@ -135,6 +135,13 @@ Parameters for this connector module:
#### connectorRISDump
It connects to the RIPEstat's BGPlay API and retrieves a RIS dump about the monitored resources. The retrieved dump is 2 hours old, due to limitations on the API side.
Without this connector, when you start BGPalerter the monitoring will start based on new BGP updates. This means that you will not receive alerts before a new BGP update is propagated; e.g., if one of your prefixes is already hijacked when you start BGPalerter, you will not get notified immediately.
This connector runs only in the two following conditions:
- you enable it in the config.yml (commented out by default);
- you didn't start BGPalerter in the last two hours.
#### connectorTest
Connector used for testing purposes, it provokes all types of alerting. Needed to run the tests (`npm run test`) .

View File

@@ -116,3 +116,17 @@ You can use any of the RPKI validator that support JSON as output format to gene
```
> Please, help with other examples
### Staging/testing ROAs
You can use BGPalerter to test ROAs before deploying them for real.
How:
- enable [connectorRISDump](configuration.md#connectorrisdump) (optional but useful);
- add the "ROA" in the VRP file using the JSON format described above;
- be sure there is a prefix rule in config.yml covering the prefix of the ROA;
- leave BGPalerter on for some time.
You will get notified if your new staged roa conflicts with what announced at the BGP level.
If you are starting BGPalerter after you already created the VRP file, by enabling connectorRISDump you would be able to get an immediate feedback based on a BGP dump. In any case, new BGP updates are going to be processed in real-time and compared with the VRP file provided.

View File

@@ -24,10 +24,10 @@ export default class Config {
}
}
},
{
file: "connectorRISDump",
name: "dmp"
}
// {
// file: "connectorRISDump",
// name: "dmp"
// }
],
monitors: [
{