Skip to content

Correct TLS and memory options in tenzir.yaml.example#404

Draft
Zedoraps wants to merge 4 commits into
mainfrom
feat/verify-example-config-docs
Draft

Correct TLS and memory options in tenzir.yaml.example#404
Zedoraps wants to merge 4 commits into
mainfrom
feat/verify-example-config-docs

Conversation

@Zedoraps

@Zedoraps Zedoraps commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

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-certrequire-client-cert (the prefixed key was ignored, so mTLS was never enforced).
  • Document tenzir.tls.password (decrypts an encrypted keyfile).
  • Drop tenzir.malloc-trim-interval — read only from TENZIR_ALLOC_TRIM_INTERVAL (default 1min), never the configuration file.
  • plugins.platform: drop enable, tls-client-ca, tls-require-client-cert — not honored by the outbound platform connection.
  • Reference accept_tcp/to_tcp instead of the removed load_tcp/save_tcp.
  • Correct two defaults: retention.metrics (16d) and disk-budget-check-interval (60).

Guides / explanation:

  • configure-tls, configuration: correct node-level cipher/version keys to tls-ciphers/tls-min-version, plus the same require-client-cert, password, and plugins.platform corrections.
  • transform-data-at-rest: disk-budget-check-interval default 60.
⚙️ Code PR: tenzir/tenzir#6365
🎫 References TNZ-728

@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

📦 Preview  ·  View →  ·  🟢 Live

Verified for c7a93c6  ·  Auto-updates on push

@Zedoraps Zedoraps marked this pull request as draft June 18, 2026 06:57

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread tenzir.yaml.example
Comment thread tenzir.yaml.example
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>
@Zedoraps Zedoraps force-pushed the feat/verify-example-config-docs branch from fab0666 to 47a418a Compare June 18, 2026 07:00
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>
@github-actions github-actions Bot added guide How-to guides explanation Explanations labels Jun 18, 2026
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>
@mavam

mavam commented Jun 18, 2026

Copy link
Copy Markdown
Member

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>
@Zedoraps

Zedoraps commented Jun 18, 2026

Copy link
Copy Markdown
Contributor Author

I dug into this and couldn't find a tenzir.yaml.example mirror in either repo's CI — so the drift wasn't by design, the sync is simply missing:

  • tenzir/tenzir .github/workflows/tenzir.yaml only references tenzir.yaml.example as a build-trigger path (TENZIR_SOURCES), not a mirror, and has a sync-openapi-to-docs job — but that syncs the OpenAPI spec, not the example.
  • tenzir/docs generate-openapi-node.yaml pulls the OpenAPI spec by running the Tenzir Docker image (tenzir 'openapi | write_yaml') and committing it. Again OpenAPI only.

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 generate-openapi-node.yaml. Two options:

  1. Fetch the file from tenzir/tenzir (raw tenzir.yaml.example) on a schedule / repository-dispatch and commit it here.
  2. Extract from the Docker image (it's installed as tenzir.yaml), keeping it consistent with what actually ships.

@mavam

mavam commented Jun 18, 2026

Copy link
Copy Markdown
Member

I checked the git history: we did have this mirror before, but lost it on 2025-05-30 in tenzir/tenzir commit cc7bb38d3edafc19ec85fb4e4a02df8ca33baf93 (Fix OpenAPI spec sync). That commit deleted .github/workflows/documentation.yaml, whose job copied:

cp tenzir/tenzir.yaml.example docs/tenzir.yaml.example

and committed it to tenzir/docs. The replacement kept/fixed OpenAPI syncing, but dropped the tenzir.yaml.example part.

Recommendation: restore this as low-friction automation where tenzir/docs owns the write:

  • add a workflow in tenzir/docs, triggered by tenzir/tenzir with the source SHA/ref
  • serialize it with concurrency
  • have it copy tenzir.yaml.example and commit directly to docs main

That avoids cross-repo push races and matches the current OpenAPI ownership model: tenzir/tenzir triggers, tenzir/docs writes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

explanation Explanations guide How-to guides site Site infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants