netobserv / flowlogs-pipeline

Transform flow logs into metrics
Apache License 2.0
73 stars 23 forks source link

Update README to align with the new pipeline structure #113

Closed eranra closed 2 years ago

eranra commented 2 years ago

@KalmanMeth Various sections of the README will not be accurate anymore. In particular the examples in https://github.com/netobserv/flowlogs-pipeline#syntax-of-portions-of-the-configuration-file but also https://github.com/netobserv/flowlogs-pipeline#configuration and various other places. This is mainly a gap post-merge of https://github.com/netobserv/flowlogs-pipeline/pull/83 but the changes that @mariomac introduces in https://github.com/netobserv/flowlogs-pipeline/pull/105 might also affect. We need to revisit the text and technical content to make sure it is accurate.

mariomac commented 2 years ago

@eranra in principle, PR #105 does not change the configuration file format . After Goflow-Kube is merged (a couple of PRs more are needed), I'd like to suggest few minor simplifications of the format, so once we discuss them we could update the documentation.