Skip to content

Commit f48223c

Browse files
docs: update configuration-model.md for engine.custom field
1 parent 58b27ee commit f48223c

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

rust/otap-dataflow/docs/configuration-model.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,9 @@ Important behavior:
152152
- Graph topology is explicit via `connections`.
153153
- `kind` is inferred from node `type`.
154154
- For single-output nodes, you do not need `outputs` or `default_output`.
155-
- Parsing is strict: unknown fields are rejected (might be relaxed in the future
156-
if we find good use cases for extensibility, but for now this is intentional
157-
to catch typos and mistakes early).
155+
- Parsing is strict: unknown fields are rejected to catch typos and mistakes
156+
early. Applications that embed the engine can place their own engine-level
157+
configuration under `engine.custom` (see below).
158158

159159
## Engine Section
160160

@@ -165,6 +165,7 @@ Important behavior:
165165
- `telemetry`
166166
- `observed_state`
167167
- `observability`
168+
- `custom`
168169

169170
### Engine Topic Settings
170171

@@ -207,6 +208,23 @@ Optional observability policies are supported at:
207208

208209
`resources` is intentionally not supported for observability and is rejected.
209210

211+
### Custom Embedder Configuration
212+
213+
`engine.custom` is an optional map for applications that embed the dataflow
214+
engine as a library. The engine ignores this field entirely -- embedding
215+
binaries can read namespaced keys for their own engine-level concerns.
216+
217+
```yaml
218+
engine:
219+
custom:
220+
remote_management:
221+
server_url: "ws://mgmt.example.com/v1"
222+
heartbeat_interval_secs: 10
223+
custom_auth:
224+
provider: "oidc"
225+
token_endpoint: "https://auth.example.com/token"
226+
```
227+
210228
## Policy Hierarchy
211229

212230
Policies include channel capacity, health, runtime telemetry, resources

0 commit comments

Comments
 (0)