docs(influxdb3 install): expand systemd runbook with day-2 commands#7177
Merged
Conversation
Augment the existing systemd subsection in the Linux DEB/RPM install
guide with operationally-useful commands beyond start/status/logs:
stop, restart, is-enabled, is-active, follow-mode logs, packaged-unit
inspection (systemctl cat, systemctl show), and the edit-config-and-
restart workflow.
Verified service paths and behaviors against the v3.9.1 packaged
systemd unit (`influxdb3-enterprise.service`). Uses the existing
`influxdb3-{{< product-key >}}` convention so both Core and
Enterprise pages render with the correct unit name.
Closes influxdata/DAR#650
Contributor
Vale Style Check Results
✅ Check passed |
github-actions
Bot
added
product:shared
Contributor
|
Add a new "TOML configuration files (DEB/RPM installs)" subsection to the config-options reference. The InfluxDB 3 systemd launcher reads /etc/influxdb3/influxdb3-<product-key>.conf and converts each setting to an INFLUXDB3_* environment variable before invoking `influxdb3 serve` — the binary itself does not natively read TOML. This means CLI flags still override TOML values, because they override the env vars the file becomes. Cross-reference the new section from the install page's "Apply configuration changes" workflow. Source: behavior described in influxdb3/src/commands/serve/cli_params/ tests.rs (test_config_file_cli_option_drift), confirming the launcher-mediated TOML→env conversion at v3.9.1.
PR review feedback: `systemctl status` was inconsistently sudo'd (missing in "Check status and logs", present in "Apply configuration changes"). Adding `sudo` also guarantees full journal output for users not in the systemd-journal group. Apply the same fix to all three `journalctl` invocations for the same journal-access reason. Leave `is-enabled`, `is-active`, `cat`, and `show` as-is — these are pure metadata reads and don't touch journald.
- TOML configuration files anchor: simplify heading to drop the "(DEB/RPM installs)" qualifier so the generated anchor matches the cross-reference link. Hugo strips the slash, so the qualifier produced "debrpm-installs" rather than "deb-rpm-installs". - "Upgrade from Core" link path: drop the spurious /license/ segment; the actual page is at /admin/upgrade-from-core/. Note block is already gated to enterprise via show-in. - "Download InfluxDB 3 binaries" link: was self-referential to the same section the reader is on. The actual download links are in the expand-wrapper directly below. Remove the redundant link, keep the prose.
jstirnaman
requested review from
dburton-influxdata and
jdstrand
and removed request for
sanderson
sanderson
approved these changes
May 1, 2026
jdstrand
approved these changes
May 5, 2026
jstirnaman
commented
May 5, 2026
jstirnaman
commented
May 5, 2026
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
3 participants
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
Augments the existing systemd subsection of the Linux DEB/RPM install guide with operationally-useful day-2 commands beyond start/status/logs:
Uses the existing `influxdb3-{{< product-key >}}` convention so both Core and Enterprise pages render with the correct unit name.
Verified against the v3.9.1 packaged systemd unit at `.circleci/packages/influxdb3/fs/lib/systemd/system/influxdb3-enterprise.service`.
Closes influxdata/DAR#650
Companion PR: #7171 — fixes service-name inconsistencies that the DAR reporter flagged.
Test plan