docs: update documentation regarding flow protobuf definitions

This commit is contained in:
Vincent Bernat
2023-01-25 08:13:39 +01:00
parent 6099691d05
commit 3684d06f90
3 changed files with 17 additions and 21 deletions

View File

@@ -85,12 +85,11 @@ Once you are ready, you can run everything in the background with
## Serialized flow schemas
Flows sent to Kafka are encoded with a versioned schema, described in
the `flow-*.proto` files. For each version of the schema, a different
Kafka topic is used. For example, the `flows-v2` topic receive
serialized flows using the first version of the schema. The inlet
service exports the schemas as well as the current version with its
HTTP service, via the `/api/v0/inlet/schemas.json` endpoint.
Flows sent to Kafka are encoded with a versioned schema. When the schema
changes, a different Kafka topic is used. For example, the
`flows-ZUYGDTE3EBIXX352XPM3YEEFV4` topic receive serialized flows using a
specific version of the schema. The inlet service exports the schema with its
HTTP service, via the `/api/v0/inlet/flow.proto` endpoint.
## ClickHouse database schemas