diff --git a/console/data/docs/00-intro.md b/console/data/docs/00-intro.md index d32d8ada..0ead3e1f 100644 --- a/console/data/docs/00-intro.md +++ b/console/data/docs/00-intro.md @@ -69,8 +69,7 @@ Once you are ready, you can run everything in the background with - The **inlet service** receives flows from exporters. It poll each exporter using SNMP to get the *system name*, the *interface names*, - *descriptions* and *speeds*. It query GeoIP databases to get the - *country* and the *AS number*. It applies rules to add attributes to + *descriptions* and *speeds*. It applies rules to add attributes to exporters. Interface rules attach to each interface a *boundary* (external or internal), a *network provider* and a *connectivity type* (PNI, IX, transit). Optionally, it may also receive BGP routes @@ -78,10 +77,10 @@ Once you are ready, you can run everything in the background with the communities. The flow is exported to *Kafka*, serialized using *Protobuf*. -- The **orchestrator service** configures the internal and external - components. It creates the *Kafka topic* and configures *ClickHouse* - to receive the flows from Kafka. It exposes configuration settings - for the other services to use. +- The **orchestrator service** configures the internal and external components. + It creates the *Kafka topic* and configures *ClickHouse* to receive the flows + from Kafka. It exposes configuration settings for the other services to use. + It provides to ClickHouse additional data, notably *GeoIP* data. - The **console service** exposes a web interface to look and manipulate the flows stored inside the ClickHouse database. diff --git a/console/data/docs/06-internals.md b/console/data/docs/06-internals.md index e41225da..130d05f5 100644 --- a/console/data/docs/06-internals.md +++ b/console/data/docs/06-internals.md @@ -98,11 +98,6 @@ network, this does not really matter as we cannot really block without losing messages. However, with file-backed modules, it may be more reliable to reduce buffers as data can be lost during shutdown. -## GeoIP - -The component is straightforward. It watches for the modification -of the databases in order to update a local cached copy. - ## Kafka The Kafka component relies on diff --git a/console/data/docs/design.svg b/console/data/docs/design.svg index c306ebd6..ff75abcf 100644 --- a/console/data/docs/design.svg +++ b/console/data/docs/design.svg @@ -1,4 +1,4 @@ - + -
Inlet service
Inlet service
Flow
collection
Flow...
SNMP
poller
SNMP...
GeoIP
databases
GeoIP...
Classifiers
Classifiers
Time 2022-03-22 11:55
Source 192.0.2.15
Destination 203.0.113.56
Protocol UDP
Port 23876 / 53
Bytes 7654
Packets 8
Exporter th2-ncs5k8-10
Interface Hu0/0/3 / Hu0/2/3
Country US / FR
ASN 64476 / 12322
AS path 25091 1299 174
Communities 1299:20000
Group th2
Provider Cogent
Connectivity Transit
Boundary external / internal

Time 2022-03-22 11:55...
Console service
Console service
Orchestrator
service
Orchestrator...ApacheKafkaClickHouse
BMP collector
BMP collect...Text is not SVG - cannot display \ No newline at end of file +
Inlet service
Inlet service
Flow
collection
Flow...
SNMP
poller
SNMP...
Classifiers
Classifiers
Time 2022-03-22 11:55
Source 192.0.2.15
Destination 203.0.113.56
Protocol UDP
Port 23876 / 53
Bytes 7654
Packets 8
Exporter th2-ncs5k8-10
Interface Hu0/0/3 / Hu0/2/3
ASN 64476 / 12322
AS path 25091 1299 174
Communities 1299:20000
Group th2
Provider Cogent
Connectivity Transit
Boundary external / internal

Time 2022-03-22 11:55...
Console service
Console service
Orchestrator
service
Orchestrator...ApacheKafkaClickHouse
BMP collector
BMP collect...Text is not SVG - cannot display \ No newline at end of file