Skip to content

Commit e9498d9

Browse files
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.md
1 parent f4376d8 commit e9498d9

2 files changed

Lines changed: 83 additions & 8 deletions

File tree

content/shared/influxdb3-cli/config-options.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,25 @@
88
Pass configuration options using either command options or environment variables.
99
Command options take precedence over environment variables.
1010

11+
### TOML configuration files
12+
13+
DEB and RPM installs include a TOML configuration file at
14+
`/etc/influxdb3/influxdb3-{{< product-key >}}.conf`.
15+
The systemd launcher reads this file and converts each entry to an
16+
`INFLUXDB3_*` environment variable (the pattern is `INFLUXDB3_<KEY>`
17+
with hyphens replaced by underscores and uppercased) before invoking
18+
`influxdb3 serve`.
19+
20+
`influxdb3 serve` does not yet natively read TOML; the file's effect is
21+
applied through the environment variables the launcher sets.
22+
CLI flags passed to `influxdb3 serve` still override values defined in
23+
the TOML file because they override the environment variables that
24+
file becomes.
25+
26+
For day-to-day systemd operation — including the edit-and-restart
27+
workflow for applying changes — see
28+
[Run as a system service (Linux)](/influxdb3/version/install/#run-as-a-system-service-linux).
29+
1130
### Global vs serve-specific options
1231

1332
Some options are **global** (specified before the command) while others are **serve-specific** (specified after `serve`):

content/shared/influxdb3/install.md

Lines changed: 64 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
> #### Upgrading from InfluxDB 3 Core?
2424
>
2525
> If you're currently running InfluxDB 3 Core and want to upgrade to {{% product-name %}},
26-
> see [Upgrade from Core](/influxdb3/version/admin/license/upgrade-from-core/)
26+
> see [Upgrade from Core](/influxdb3/version/admin/upgrade-from-core/)
2727
> for step-by-step instructions.
2828
2929
> [!Note]
@@ -90,7 +90,7 @@ curl -O https://www.influxdata.com/d/install_influxdb3.sh \
9090
9191
### Download and install the latest build artifacts
9292

93-
You can also download and install [{{% product-name %}} build artifacts](/influxdb3/version/install/#download-influxdb-3-{{< product-key >}}-binaries) directly:
93+
You can also download and install {{% product-name %}} build artifacts directly:
9494

9595
{{< expand-wrapper >}}
9696
{{% expand "Linux binaries" %}}
@@ -240,19 +240,75 @@ On `systemd` systems, the `influxdb3-{{< product-key >}}` unit file is
240240
`enabled` on install, but the unit is not started in order to allow
241241
configuration.
242242

243-
To start the database, enter the following commands:
243+
###### Start, stop, and restart
244+
245+
> [!Note]
246+
> The following examples use `sudo` for systems that require elevated privileges.
247+
> On some systems (such as Amazon Linux or other RHEL-based distributions where you may already be running as root), you can omit `sudo` from the commands.
244248
245249
```bash
246250
# Start the service
247-
systemctl start influxdb3-{{< product-key >}}
251+
sudo systemctl start influxdb3-{{< product-key >}}
248252

249-
# View status
250-
systemctl status influxdb3-{{< product-key >}}
253+
# Stop the service
254+
sudo systemctl stop influxdb3-{{< product-key >}}
251255

252-
# View logs
253-
journalctl --unit influxdb3-{{< product-key >}}
256+
# Restart the service (use after configuration changes)
257+
sudo systemctl restart influxdb3-{{< product-key >}}
254258
```
255259

260+
###### Check status and logs
261+
262+
```bash
263+
# Check status (sudo to ensure full journal output)
264+
sudo systemctl status influxdb3-{{< product-key >}}
265+
266+
# Quick state checks (no sudo needed)
267+
systemctl is-enabled influxdb3-{{< product-key >}}
268+
systemctl is-active influxdb3-{{< product-key >}}
269+
270+
# Recent logs
271+
sudo journalctl --unit influxdb3-{{< product-key >}} -n 200 --no-pager
272+
273+
# Follow logs
274+
sudo journalctl --unit influxdb3-{{< product-key >}} -f
275+
```
276+
277+
###### Inspect the packaged unit
278+
279+
The packaged unit configures security sandboxing for typical deployments
280+
(see [Manage security](/influxdb3/version/admin/security/)).
281+
To inspect the packaged unit and its resolved properties:
282+
283+
```bash
284+
# Show the unit file
285+
systemctl cat influxdb3-{{< product-key >}}
286+
287+
# Show all resolved properties (paths, environment, sandboxing options)
288+
systemctl show influxdb3-{{< product-key >}}
289+
```
290+
291+
###### Apply configuration changes
292+
293+
Edit the TOML configuration file and restart the service to apply
294+
changes:
295+
296+
```bash
297+
sudoedit /etc/influxdb3/influxdb3-{{< product-key >}}.conf
298+
sudo systemctl restart influxdb3-{{< product-key >}}
299+
sudo systemctl status influxdb3-{{< product-key >}}
300+
sudo journalctl --unit influxdb3-{{< product-key >}} -n 100 --no-pager
301+
```
302+
303+
`influxdb3 serve` does not support configuration reload; a restart is
304+
required after editing the TOML file or changing environment variables.
305+
306+
The TOML file is read by the systemd launcher and converted to
307+
`INFLUXDB3_*` environment variables before `influxdb3 serve` runs;
308+
CLI flags still override values from the TOML file.
309+
For details, see
310+
[TOML configuration files](/influxdb3/version/reference/config-options/#toml-configuration-files).
311+
256312
##### Run using SysV
257313

258314
On SysV init systems, `influxdb3-{{< product-key >}}` is disabled on install

0 commit comments

Comments
 (0)