docs: document wyrelogd config keyfile and wyctl boundary#322
Merged
Conversation
wyrelogd has supported --config PATH (GLib keyfile / INI format) since
the daemon's option parser landed, but the operator runbook only ever
mentioned /etc/wyrelog/wyrelogd.env (the systemd EnvironmentFile). The
14-key [daemon] section that load_config_defaults() in
wyrelog/daemon/options.c actually reads was operator-discoverable only
by reading source.
Adds a new "wyrelogd Configuration File" section that:
* shows the canonical [daemon] section layout,
* tabulates every supported key with its type, equivalent CLI flag,
and operator-facing purpose,
* clarifies the CLI > config-file precedence rule (no second-level
merging),
* separates wyrelogd.env (systemd-level environment) from
wyrelogd.conf (daemon-level config) so operators stop confusing
the two,
* sketches the systemd ExecStart wiring,
* explains why the daemon deliberately does NOT use GSettings:
no session bus on system services, daemon config is a deployment
concern, and the dconf store is operator-writable in a way that
breaks the threat model.
Adds a cross-reference note in the wyctl Configuration section so
operators know the same value (e.g. tenant) appearing in two places
is intentional: the daemon config decides which tenants the daemon
services, the wyctl defaults decide which tenant the CLI on this
workstation routes to.
Docs-only commit; no source or test changes. meson test wyctl-* — 4/4 OK.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #321 (now merged). The wyctl GSettings docs landed there, but the existing wyrelogd
--config PATH(GLib keyfile / INI) support was still undocumented in the operator runbook — operators had to readwyrelog/daemon/options.cto discover the supported[daemon]section keys.Adds a new "wyrelogd Configuration File" section to
docs/operator-runbook.mdcovering:[daemon]section layout with all 14 supported keys.wyrelogd.env(systemdEnvironmentFile=) vswyrelogd.conf(daemon config) distinction.ExecStartwiring sketch./etc, and the dconf store is operator-writable in a way that breaks the threat model.Adds a cross-reference in the wyctl Configuration section noting the wyctl/wyrelogd separation is intentional (each surface answers a different operator question).
Docs-only diff (+114 lines, 0 source/test changes).
Test plan
meson test -C builddir wyctl-token-file wyctl-config wyctl-gschema wyctl-basic --no-rebuild— 4/4 OK (sanity check that the docs-only change doesn't break anything).load_config_defaults()atwyrelog/daemon/options.c:145— 14 keys match (12 strings viakeyfile_take_*+ 2 booleans viag_key_file_get_boolean).