Commit e9498d9
authored
docs(influxdb3 install): expand systemd runbook with day-2 commands (#7177)
* docs(influxdb3 install): expand systemd runbook with day-2 commands
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
* docs(influxdb3 config-options): clarify how TOML interacts with env vars
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.
* docs(influxdb3 install): add sudo to systemctl status and journalctl
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.
* fix(install): repair four broken anchors/links flagged by link-checker
- 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.
* Update content/shared/influxdb3-cli/config-options.md
* Update content/shared/influxdb3/install.md1 parent f4376d8 commit e9498d9
2 files changed
Lines changed: 83 additions & 8 deletions
File tree
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
11 | 30 | | |
12 | 31 | | |
13 | 32 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
26 | | - | |
| 26 | + | |
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| |||
90 | 90 | | |
91 | 91 | | |
92 | 92 | | |
93 | | - | |
| 93 | + | |
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
| |||
240 | 240 | | |
241 | 241 | | |
242 | 242 | | |
243 | | - | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
244 | 248 | | |
245 | 249 | | |
246 | 250 | | |
247 | | - | |
| 251 | + | |
248 | 252 | | |
249 | | - | |
250 | | - | |
| 253 | + | |
| 254 | + | |
251 | 255 | | |
252 | | - | |
253 | | - | |
| 256 | + | |
| 257 | + | |
254 | 258 | | |
255 | 259 | | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
256 | 312 | | |
257 | 313 | | |
258 | 314 | | |
| |||
0 commit comments