mirror of
https://github.com/akvorado/akvorado.git
synced 2025-12-11 22:14:02 +01:00
docs: update documentation with respect to GeoIP
Some checks failed
CI / 🤖 Check dependabot status (push) Has been cancelled
CI / ⚖️ Check licenses (push) Has been cancelled
CI / 🐧 Build and test on Linux (push) Has been cancelled
CI / 🍏 Build and test on macOS (push) Has been cancelled
CI / 🔍 Upload code coverage (push) Has been cancelled
CI / 🔭 Build Go backend (1.24) (push) Has been cancelled
CI / 🔭 Build JS frontend (18) (push) Has been cancelled
CI / 🔭 Build JS frontend (20) (push) Has been cancelled
CI / 🔭 Build JS frontend (22) (push) Has been cancelled
CI / 🐋 Build Docker images (push) Has been cancelled
CI / 🚀 Publish release (push) Has been cancelled
Update Nix dependencies / Update Nix lockfile (asn2org) (push) Has been cancelled
Update Nix dependencies / Update Nix lockfile (nixpkgs) (push) Has been cancelled
Update Nix dependencies / Update dependency hashes (push) Has been cancelled
Some checks failed
CI / 🤖 Check dependabot status (push) Has been cancelled
CI / ⚖️ Check licenses (push) Has been cancelled
CI / 🐧 Build and test on Linux (push) Has been cancelled
CI / 🍏 Build and test on macOS (push) Has been cancelled
CI / 🔍 Upload code coverage (push) Has been cancelled
CI / 🔭 Build Go backend (1.24) (push) Has been cancelled
CI / 🔭 Build JS frontend (18) (push) Has been cancelled
CI / 🔭 Build JS frontend (20) (push) Has been cancelled
CI / 🔭 Build JS frontend (22) (push) Has been cancelled
CI / 🐋 Build Docker images (push) Has been cancelled
CI / 🚀 Publish release (push) Has been cancelled
Update Nix dependencies / Update Nix lockfile (asn2org) (push) Has been cancelled
Update Nix dependencies / Update Nix lockfile (nixpkgs) (push) Has been cancelled
Update Nix dependencies / Update dependency hashes (push) Has been cancelled
Fix #1804
This commit is contained in:
@@ -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
|
- The **inlet service** receives flows from exporters. It poll each
|
||||||
exporter using SNMP to get the *system name*, the *interface names*,
|
exporter using SNMP to get the *system name*, the *interface names*,
|
||||||
*descriptions* and *speeds*. It query GeoIP databases to get the
|
*descriptions* and *speeds*. It applies rules to add attributes to
|
||||||
*country* and the *AS number*. It applies rules to add attributes to
|
|
||||||
exporters. Interface rules attach to each interface a *boundary*
|
exporters. Interface rules attach to each interface a *boundary*
|
||||||
(external or internal), a *network provider* and a *connectivity
|
(external or internal), a *network provider* and a *connectivity
|
||||||
type* (PNI, IX, transit). Optionally, it may also receive BGP routes
|
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
|
the communities. The flow is exported to *Kafka*, serialized using
|
||||||
*Protobuf*.
|
*Protobuf*.
|
||||||
|
|
||||||
- The **orchestrator service** configures the internal and external
|
- The **orchestrator service** configures the internal and external components.
|
||||||
components. It creates the *Kafka topic* and configures *ClickHouse*
|
It creates the *Kafka topic* and configures *ClickHouse* to receive the flows
|
||||||
to receive the flows from Kafka. It exposes configuration settings
|
from Kafka. It exposes configuration settings for the other services to use.
|
||||||
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
|
- The **console service** exposes a web interface to look and
|
||||||
manipulate the flows stored inside the ClickHouse database.
|
manipulate the flows stored inside the ClickHouse database.
|
||||||
|
|||||||
@@ -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
|
losing messages. However, with file-backed modules, it may be more reliable
|
||||||
to reduce buffers as data can be lost during shutdown.
|
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
|
## Kafka
|
||||||
|
|
||||||
The Kafka component relies on
|
The Kafka component relies on
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 556 KiB After Width: | Height: | Size: 820 KiB |
Reference in New Issue
Block a user