From 3331560aa2e32504edde311599ecaa182e87270c Mon Sep 17 00:00:00 2001 From: Bruce McDougall Date: Fri, 29 Mar 2024 12:36:32 -0700 Subject: [PATCH] Update infrastructure.md (#79) --- docs/about/infrastructure.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/about/infrastructure.md b/docs/about/infrastructure.md index a47aec3d..52257277 100644 --- a/docs/about/infrastructure.md +++ b/docs/about/infrastructure.md @@ -10,11 +10,11 @@ Each Jalapeno infrastructure component defines its deployment in the respective Kafka is Jalapeno's message bus and core data handler. -Jalapeno's Kafka instance handles two main types of data: OpenBMP data (topology information) and telemetry data (network metrics). Jalapeno Processors are responsible for reading and restructuring the data, and for inferring relevant metrics from the data. +Jalapeno's Kafka instance handles two main types of data: BMP data (topology information) supplied by the GoBMP collector, and telemetry data (network metrics) supplied by Telegraf. Jalapeno Processors are responsible for reading and restructuring the data, and for inferring relevant metrics from the data. -OpenBMP data is organized into Kakfa topics such as `openbmp.parsed.peer` and `openbmp.parsed.ls_node`. These topics are further parsed to create representations of the network topology using the [Topology Processor](processors.md#topology-processor). +BMP data is organized into Kakfa topics such as `gobmp.parsed.peer` and `gobmp.parsed.ls_node`. These topics are further parsed to create representations of the network topology using the [Topology Processor](processors.md#topology-processor). -Telemetry data is collected in the `openbmp.telemetry` topic. Data in this topic is pushed into Telegraf (a telemetry consumer), and onwards into InfluxDB. +Telemetry data is collected in the `jalapeno.telemetry` topic. Data in this topic is pushed into Telegraf (a telemetry consumer), and onwards into InfluxDB. Kafka is deployed using `kubectl`, as seen in the `deploy_infrastructure.sh` script. The configurations for Kafka's deployment are in the YAML files in the `jalapeno/infra/kafka/` directory. @@ -22,7 +22,7 @@ Kafka is deployed using `kubectl`, as seen in the `deploy_infrastructure.sh` scr ArangoDB is Jalapeno's graph database. -Jalapeno [Processors](./processors.md) parse through data in Kafka, then create various collections in ArangoDB. These collections represent both the network's topology and its current state. For example, the [Topology Processor](./processors.md#topology-processor) parses OpenBMP messages that have been streamed to Kafka and builds out collections such as "LSNode" and "L3VPNPrefix" in Jalapeno's ArangoDB instance. These collections, in conjunction with ArangoDBs rapid graphical traversals and calculations, make it easy to determine the lowest-latency path, etc. +Jalapeno [Processors](./processors.md) parse through data in Kafka, then create various collections in ArangoDB. These collections represent both the network's topology and its current state. For example, the [Topology Processor](./processors.md#topology-processor) parses BMP messages that have been streamed to Kafka and builds out collections such as "ls_node" and "l3vpn_prefix_v4" in Jalapeno's ArangoDB instance. These collections, in conjunction with ArangoDBs rapid graphical traversals and calculations, make it easy to determine the lowest-latency path, etc. ArangoDB also houses the most interactive aspects of Jalapeno. Processors for Bandwidth and Latency upsert their scores here. Clients can run queries to generate label stacks for their desired network optimization attribute. @@ -61,6 +61,14 @@ Grafana is deployed using `kubectl`, as seen in the `deploy_infrastructure.sh` s To access Grafana's UI, log in at `:30300`, using credentials `root/jalapeno`. +A pair of example dashboard configurations can be found here: + +[Interface Egress Stats](https://github.com/cisco-open/jalapeno/blob/main/install/infra/grafana/egress-mdt.json) + +and here: + +[Interface Ingress Stats](https://github.com/cisco-open/jalapeno/blob/main/install/infra/grafana/ingress-mdt.json) + ## Telegraf-Egress Telegraf is a telemetry consumer and forwarder.