fix(systemctl): use product-key for service and container names in shared docs#7171
Open
jstirnaman wants to merge 3 commits into
Open
fix(systemctl): use product-key for service and container names in shared docs#7171jstirnaman wants to merge 3 commits into
jstirnaman wants to merge 3 commits into
Conversation
…ared docs
The packaged systemd unit names are influxdb3-core and influxdb3-enterprise
(verified against the v3.9.1 unit file at
.circleci/packages/influxdb3/fs/lib/systemd/system/influxdb3-enterprise.service).
Several systemctl commands in shared admin docs used the bare name
"influxdb3", which is not a valid unit on either product. The
file-system restore example in backup-restore.md also hard-coded
"influxdb3-core" as the Docker container name in fallbacks; on the
Enterprise rendering the conventional name is influxdb3-enterprise.
Replace the bare/hard-coded names with the {{< product-key >}}
shortcode so each rendered page emits the correct name. This is the
same convention already used in the install page's systemd section.
Refs influxdata/DAR#650
Contributor
Vale Style Check Results
Warnings (4)
✅ Check passed |
github-actions
Bot
added
product:shared
Contributor
|
Contributor
📦 PR Preview — Preview Bot
Pages included in this preview
Preview auto-deploys on push. Will be cleaned up when PR closes. |
3 tasks
jstirnaman
requested review from
dburton-influxdata and
jdstrand
and removed request for
sanderson
sanderson
approved these changes
May 1, 2026
jstirnaman
added
source:feedback
jdstrand
approved these changes
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
Six systemctl commands and two Docker container names in shared admin docs used hardcoded names that don't match either product:
Replace with `influxdb3-{{< product-key >}}` so each rendered page (Core / Enterprise) emits the correct name. This is the same convention already used by the install page's systemd section.
Verified against the packaged unit file at `.circleci/packages/influxdb3/fs/lib/systemd/system/influxdb3-enterprise.service` (v3.9.1).
Refs influxdata/DAR#650 (the reporter flagged this inconsistency in the issue body).
Test plan