Correct TLS and memory options in tenzir.yaml.example#404
Conversation
|
📦 Preview · View → · 🟢 Live Verified for |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: fab0666c35
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Mirror the corrected tenzir.yaml.example from tenzir/tenzir so the rendered configuration matches the options the node reads: rename the mTLS toggle to `require-client-cert`, document `password` for encrypted keyfiles, drop the dead `malloc-trim-interval` key, and trim the `plugins.platform` block to the options the platform connection honors. Assisted-by: Claude Opus 4.8 (1M context) (Claude Code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
fab0666 to
47a418a
Compare
The TLS guide and the configuration explanation documented keys the node does not read. Correct the node-level cipher and version keys to `tls-ciphers` and `tls-min-version`, rename the mTLS toggle to `require-client-cert`, document the `password` option, and trim the `plugins.platform` block to the TLS options the outbound platform connection honors. Assisted-by: Claude Opus 4.8 (1M context) (Claude Code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Match the node's actual defaults: `tenzir.retention.metrics` is 16d (not 7d) and `tenzir.start.disk-budget-check-interval` is 60 seconds (not 90). Assisted-by: Claude Opus 4.8 (1M context) (Claude Code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
We used to auto-mirror the .example file from tenzir/tenzir into the docs repo via CI. I couldn't find the workflow for this right off the bat, but it's worthwhile figuring this out to avoid any drift by design. |
Mirror the example fix from tenzir/tenzir: the publish-suricata pipeline used load_tcp, removed in v6. Use accept_tcp. Assisted-by: Claude Opus 4.8 (1M context) (Claude Code) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
I dug into this and couldn't find a
So nothing keeps the example in sync, which is exactly why the two copies diverged (and each had picked up different errors). Proposed fix — re-establish the mirror modeled on
|
|
I checked the git history: we did have this mirror before, but lost it on 2025-05-30 in cp tenzir/tenzir.yaml.example docs/tenzir.yaml.exampleand committed it to Recommendation: restore this as low-friction automation where
That avoids cross-repo push races and matches the current OpenAPI ownership model: |
Mirrors the corrected example configuration from the code repo and fixes the same documented-vs-actual mismatches in the docs, so docs.tenzir.com matches what the node reads. Verified against the source and a running node (v6.2.0).
Example configuration (
tenzir.yaml.example):tls-require-client-cert→require-client-cert(the prefixed key was ignored, so mTLS was never enforced).tenzir.tls.password(decrypts an encryptedkeyfile).tenzir.malloc-trim-interval— read only fromTENZIR_ALLOC_TRIM_INTERVAL(default1min), never the configuration file.plugins.platform: dropenable,tls-client-ca,tls-require-client-cert— not honored by the outbound platform connection.accept_tcp/to_tcpinstead of the removedload_tcp/save_tcp.retention.metrics(16d) anddisk-budget-check-interval(60).Guides / explanation:
⚙️ Code PR: tenzir/tenzir#6365configure-tls,configuration: correct node-level cipher/version keys totls-ciphers/tls-min-version, plus the samerequire-client-cert,password, andplugins.platformcorrections.transform-data-at-rest:disk-budget-check-intervaldefault60.🎫 References TNZ-728