Commit Graph

53 Commits

Author SHA1 Message Date
Vincent Bernat
06e3f334fd docs: proofread the whole documentation
Notably, more active voice and simplify a bit.
2025-08-26 08:25:57 +02:00
尤理衡 (Li-Heng Yu)
6ab52f2687 docs: Added BMP for Arista 2025-08-24 13:35:47 +02:00
Vincent Bernat
883e19922e build: add end-to-end testing 2025-08-20 13:41:54 +02:00
Vincent Bernat
255ab47898 docs: add documentation for ipfixprobe as well
It means there are two solutions available for Linux to get flows into
Akvorado.

Fix #156.
2025-08-17 12:04:34 +02:00
Vincent Bernat
2c3834c6fc docs: expand a bit on how to use pmacctd with Akvorado
An alternative would be ipfixprobe. See #156.
2025-08-17 09:06:42 +02:00
Vincent Bernat
b672c08c62 docs: tune allow_suspicious_low_cardinality_types 2025-08-16 21:48:29 +02:00
Vincent Bernat
5f1e9a49c7 docs: document schema update for installations before 1.10.0
Fix #1223
2025-08-16 21:36:14 +02:00
Vincent Bernat
b6eca2d721 docs: add a link to ClickHouse documentation to run with less memory 2025-08-13 22:33:13 +02:00
Vincent Bernat
a423ec44d6 docker: move TLS configuration into its own docker-compose file
This makes it easier to use.
2025-08-10 23:01:18 +02:00
Vincent Bernat
1a27bb1bc2 docker: add examples to enable authentication and TLS 2025-08-10 22:33:04 +02:00
Vincent Bernat
84b6f4584e docker: explain how to not expose Kafka-UI and Traefik dashboard 2025-08-10 15:58:37 +02:00
Vincent Bernat
1070e5b4f0 docker: document how to properly bind on port 80
Add more documentation around merging in Docker. The previous
documentation was incorrect.
2025-08-10 15:43:10 +02:00
Vincent Bernat
09a5a32375 docs: make the minimum configuration more prominent 2025-08-09 16:59:01 +02:00
Vincent Bernat
a74a41a6a0 docker: enable IPv6 networking, use a specific IPv4 subnet
And also add documentation on how to use IPv6. The proposed setup relies
on NAT66, which is not good, but it works on any host with IPv6
connectivity. The documentation explains how to configure routed IPv6.

By using an IPv4 subnet in class E, we ensure that it is very unlikely
users will have overlap between their Docker setup and their production
network. This way, no need to change the Docker daemon configuration.
2025-08-08 12:08:00 +02:00
Vincent Bernat
0bbe62b1d4 docs: remove advice on the active parts
The advice was not true. An active part is not one that should be
actively merged, it's one that is used (and not to be deleted).
ClickHouse is good with more than 10k parts.
2025-08-06 19:05:35 +02:00
Vincent Bernat
a862f302f2 docs: also mention tuning maximum-wait-time for ClickHouse 2025-08-06 07:44:03 +02:00
Vincent Bernat
f181171e9a docs: mention the problem with slow inserts because of too many parts
And as a temporary workaround, reduce the number of Kafka workers to 1.
This should be more dynamic to keep the number of inserted rows around
100k. Another strategy would be buffer tables or async inserts.
2025-08-05 14:24:57 +02:00
Vincent Bernat
6abce2a0b3 docs: minor spelling corrections 2025-08-03 12:03:14 +02:00
Vincent Bernat
890052815b docs: add more tips for space-related problems
Even put them first.
2025-08-03 11:55:10 +02:00
Vincent Bernat
332435d650 docs: Netflow → NetFlow 2025-07-31 09:13:37 +02:00
Vincent Bernat
fc1028bfcd doc: documentation update for inlet/outlet separation 2025-07-27 21:44:28 +02:00
Vincent Bernat
75ccb0b9e7 docs: for Juniper, enable nexthop-learning
See:
- https://github.com/akvorado/akvorado/issues/1703#issuecomment-2900537048
- https://www.juniper.net/documentation/us/en/software/junos/cli-reference/topics/ref/statement/nexthop-learning-edit-services-flow-monitoring.html
2025-05-22 11:59:33 +02:00
Vincent Bernat
c60b8669fd docs: add configuration to use subinterface index on Arista
Some checks failed
CI / 🤖 Check dependabot status (push) Has been cancelled
CI / ⚖️ Check licenses (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
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
Fix #1655
2025-03-08 17:52:09 +01:00
martinberg
3dae72dfe4 Add Cisco IOS-XE IPv6 example config (#1614) 2025-01-22 18:30:40 +01:00
zxyz
d5b440ac6a operations: add noka SROS information 2024-12-06 21:34:14 +01:00
Nikolay Kichukov
cd5354b543 Add GNU/Linux pmacctd exporter configuration example 2024-10-25 08:40:18 +02:00
Vincent Bernat
56285ae16b docs: add a note about Nokia SROS routers 2024-09-15 10:51:04 +02:00
Vincent Bernat
343db42c28 docs: add a paragraph to sample on ingress only 2024-08-15 19:38:57 +02:00
Vincent Bernat
ecff2f7d77 docs: add some system requirements 2024-06-11 04:19:27 +02:00
Vincent Bernat
e9a12fa2df docs: mention issue with sampling rate 2023-11-19 18:17:26 +01:00
Vincent Bernat
8509fa9ce9 docs: mention "docker compose" instead of "docker-compose"
The later has been deprecated.
2023-08-13 09:11:47 +02:00
Vincent Bernat
06a867616c orchestrator/clickhouse: set TTL for system logs using configuration 2023-01-09 11:47:04 +01:00
Vincent Bernat
3912b8bbb8 orchestrator/clickhouse: stop meddling with TTL of system tables
This does not seem to survive a restart. There is no indication in the
documentation this is the right way. One should modify settings
directly. I need to investigate how to do this properly with Docker.
2023-01-09 08:50:12 +01:00
Vincent Bernat
e196050911 docs: add another useful request for ClickHouse 2023-01-03 14:27:19 +01:00
Vincent Bernat
874d52f05f orchestrator/clickhouse: set TTL for system logs tables 2023-01-03 14:26:58 +01:00
Vincent Bernat
86810beb6e docs: mention other system tables that can be dropped 2023-01-02 23:42:05 +01:00
Vincent Bernat
23f7719506 inlet/flow: make UseSrcAddrForExporterAddr work for any input 2022-12-16 17:47:18 +01:00
Marvin Gaube
4050cca220 inlet/flow: allow ExporterAddress overwrite from flow source IP (#329)
* Add functionality for overwriting the exporter address with flow source ip

* Remove "agent-id-src-addr-overwrite" from default config

* Improve use-src-addr-for-exporter-addr documentation

* Rename to UseSrcAddrForExporterAddr

* Fix use-src-addr-for-exporter-addr key in example config

* Add UseSrcAddrForExporterAddr to configuration test

Co-authored-by: Marvin Gaube <marvin.gaube@exaring.de>
2022-12-16 14:57:59 +01:00
Vincent Bernat
95163bea64 docs: reduce the section about 4-byte ASNs 2022-12-07 08:10:06 +01:00
Nath
22ba586bd0 Match sample rate to default sample rate in example 2022-12-07 08:06:12 +01:00
Nath
019c6221ff Added IOS-XE example config to docs 2022-12-07 08:06:12 +01:00
Vincent Bernat
51080fb686 docs: use Netflow v9 on Juniper
It seems that on Juniper SRX, using IPFIX will send total counts for
bytes and packets instead of the delta and we cannot work with that.
See #191 and https://github.com/robcowart/elastiflow/issues/646. The
limitation seems to still be current. See:
https://docs.elastiflow.com/docs/device_juniper_junos_nf9/

Fix #191
2022-10-14 20:16:57 +02:00
Vincent Bernat
416afc8677 docs: mention Kentik's GitHub repository for router configurations 2022-10-14 20:11:23 +02:00
Vincent Bernat
c769bb5234 inlet/bmp: initial support for BMP protocol
At first, there was a tentative to use BMP collector implementation
from bio-rd. However, this current implementation is using GoBGP
instead:

- BMP is very simple from a protocol point of view. The hard work is
  mostly around decoding. Both bio-rd and GoBGP can decode, but for
  testing, GoBGP is able to generate messages as well (this is its
  primary purpose, I suppose parsing was done for testing purpose).
  Using only one library is always better. An alternative would be
  GoBMP, but it also only do parsing.
- Logging and metrics can be customized easily (but the work was done
  for bio-rd, so not a real argument).
- bio-rd is an application and there is no API stability (and I did
  that too)
- GoBGP supports FlowSpec, which may be useful in the future for the
  DDoS part. Again, one library for everything is better (but
  honestly, GoBGP as a lib is not the best part of it, maybe
  github.com/jwhited/corebgp would be a better fit while keeping GoBGP
  for decoding/encoding).

There was a huge effort around having a RIB which is efficient
memory-wise (data are interned to save memory), performant during
reads, while being decent during insertions. We rely on a patched
version of Kentik's Patricia trees to be able to apply mutations to
the tree.

There was several tentatives to implement some kind of graceful
restart, but ultimetaly, the design is kept simple: when a BMP
connection goes down, routes will be removed after a configurable
time. If the connection comes back up, then it is just considered new.
It would have been ideal to rely on EoR markers, but the RFC is
unclear about them, and they are likely to be per peer, making it
difficult to know what to do if one peer is back, but not the other.

Remaining tasks:

- [ ] Confirm support for LocRIB
- [ ] Import data in ClickHouse
- [ ] Make data available in the frontend

Fix #52
2022-09-27 00:34:41 +02:00
Vincent Bernat
625571fa92 docs: add a few tips for space usage 2022-08-23 10:43:43 +02:00
Vincent Bernat
8943c8b58f doc: enable sampling on subinterface for Juniper
And add description on the same interface to hint user to set
description.
2022-08-03 14:46:00 +02:00
Vincent Bernat
ab6de8da26 docs/troubleshooting: mention missing schemas problem with ClickHouse 2022-07-29 19:39:11 +02:00
Vincent Bernat
42c794cd97 doc: various updates 2022-07-20 07:49:00 +02:00
Tchadel Icard
0d5d07dec6 inet/flow: add sflow support (#23) 2022-07-19 18:18:06 +02:00
Vincent Bernat
89e7109bfa doc: add documentation on how to configure IPFIX/sFlow on Juniper
Even if sFlow is not supported yet.
2022-07-16 09:12:47 +02:00