Skip to content

docs(influxdb3-cloud): add influxdb3 CLI reference for Cloud#7511

Merged
jstirnaman merged 4 commits into
ritwika/cloud3_initfrom
jts/cloud3-content-sharing
Jul 20, 2026
Merged

docs(influxdb3-cloud): add influxdb3 CLI reference for Cloud#7511
jstirnaman merged 4 commits into
ritwika/cloud3_initfrom
jts/cloud3-content-sharing

Conversation

@jstirnaman

Copy link
Copy Markdown
Contributor

What changed

Adds the influxdb3 CLI reference for InfluxDB 3 Cloud, restricted to the features in #7338: write, query, databases, tables, named admin tokens, database tokens.

  • Shared stubs (source:) for leaf commands whose content is identical to Enterprise: create/delete database & table, create token (admin, permission), delete token, show databases/tokens, query, write.
  • 4 shared leaf files gated enterpriseenterprise,cloud so Cloud renders the Enterprise content variant, plus one hardcoded link fixed to the version placeholder.
  • Inline product pages (no stub) where Cloud content is unique: the create/delete/show index pages (Cloud lists fewer subcommands) and the database-token page (omits self-managed content — offline token file for server startup, self-signed cert options).

Why

Cloud runs the same influxdb3 binary as Enterprise, so identical command pages are shared to stay in sync automatically. Where Cloud genuinely differs (restricted subcommand set, no self-managed operations), the content is written inline rather than forced into shared files with show-in/hide-in.

Excluded (not in this release / not applicable to a hosted service): Processing Engine (trigger, plugins, enable/disable, test), caches, file index, system tables, retention, update, and operator commands (serve, install, stop, show license/nodes, debug).

Impact

  • Adding cloud to the 4 leaf gates is additive — Core and Enterprise output is unchanged.
  • Enterprise create/token/permission.md is left untouched (Cloud got its own trimmed inline page).
  • Stacked on ritwika/cloud3_init (Added initial cloud files #7338); retargets to master when it merges.
  • Follow-up filed for the matching Cloud OpenAPI spec (endpoints limited to this same feature set).

Verification

  • npx hugo --quiet builds clean.
  • Rendered checks: Cloud create lists database/table/token (no trigger/caches); Cloud show lists databases/tokens (no plugins/system/nodes/license); Enterprise still lists trigger (unchanged).
  • All 16 Cloud CLI pages render and every internal CLI link resolves.
  • Vale + source-path lint pass (0 errors).

@jstirnaman
jstirnaman requested a review from a team as a code owner July 16, 2026 15:19
@jstirnaman
jstirnaman requested review from sanderson and removed request for a team July 16, 2026 15:19
@github-actions

github-actions Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 0
Warnings 4
Warnings (4)
File Line Rule Message
content/influxdb3/cloud/reference/cli/influxdb3/create/token/_index.md 4 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/reference/cli/influxdb3/create/token/admin.md 2 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/reference/cli/influxdb3/create/token/admin.md 4 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/enterprise/reference/cli/influxdb3/create/token/_index.md 4 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.

Check passed

@github-actions github-actions Bot added product:shared Shared content across products product:v3-distributed InfluxDB 3 Cloud Serverless, Cloud Dedicated, Clustered product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable) labels Jul 16, 2026
@github-actions

github-actions Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Check Results — Link Check Bot

All links are valid

Metric Value
Files Checked 28
Total Links 4375
Errors 0
Warnings 18
Success Rate 98.76572%
⚠️ 18 warning(s) (do not fail CI)
Source File URL Issue
content/influxdb3/cloud/reference/cli/influxdb3/create/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud/reference/cli/influxdb3/create/token/admin/_index.md https://support.influxdata.com/ Error (cached): Error (cached)
content/influxdb3/cloud/reference/cli/influxdb3/create/token/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud/reference/cli/influxdb3/create/token/permission/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud/reference/cli/influxdb3/delete/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud/reference/cli/influxdb3/delete/token/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud/reference/cli/influxdb3/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud/reference/cli/influxdb3/show/_index.md https://support.influxdata.com/ Error (cached): Error (cached)
content/influxdb3/cloud/reference/cli/influxdb3/show/tokens/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud/reference/cli/influxdb3/write/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/core/reference/cli/influxdb3/create/table/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/core/reference/cli/influxdb3/create/token/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/core/reference/cli/influxdb3/delete/database/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/core/reference/cli/influxdb3/delete/table/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/enterprise/reference/cli/influxdb3/create/table/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/enterprise/reference/cli/influxdb3/create/token/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/enterprise/reference/cli/influxdb3/delete/database/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/enterprise/reference/cli/influxdb3/delete/table/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…

Full details: workflow run summary and artifact. Last updated: 2026-07-17 03:52:36 UTC

@github-actions

github-actions Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://influxdata.github.io/docs-v2/pr-preview/pr-7511/

Built to branch gh-pages at 2026-07-17 03:52 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@jstirnaman
jstirnaman requested a review from ritwika314 July 16, 2026 15:46
@jstirnaman
jstirnaman force-pushed the ritwika/cloud3_init branch from 1bb3cfd to 792a918 Compare July 16, 2026 21:31
The exclusion used the bare substring `enterprise_influxdb/v1/api`, which
could mask genuine breakage on any /v1/api-* path. Anchor it to
`/enterprise_influxdb/v1/api/` so it only excludes the pipeline-generated
API reference pages. Update the comment: the shared query-guide link that
originally motivated it was replaced in this PR.
Add the influxdb3 CLI reference for InfluxDB 3 Cloud, restricted to the
features included in PR #7338: write, query, databases, tables, named admin
tokens, and database tokens.

- Reuse the existing shared CLI content (source: stubs) for leaf commands
  whose content is identical to Enterprise: create/delete database & table,
  create token (admin, permission), delete token, show databases/tokens,
  query, write.
- Extend the enterprise show-in/hide-in gates in 4 shared leaf files to
  include cloud so Cloud renders the Enterprise content variant (additive;
  Core and Enterprise output unchanged).
- Write inline product pages (no shared stub) for create/delete/show index
  pages and the database-token page, where Cloud's content is unique — the
  subcommand lists differ and the database-token page omits self-managed
  content (offline token file for server startup, self-signed cert options).

Excludes commands that don't apply to a managed, hosted service or aren't in
this release: Processing Engine (trigger, plugins, enable/disable, test),
caches, file index, system tables, retention, update, and operator commands
(serve, install, stop, show license/nodes, debug).
The Cloud influxdb3 CLI reference now publishes its own command pages, so
the pointer to the Enterprise reference and its resolved TODO are obsolete.
Keep the Cloud-specific engine and serve note.
@jstirnaman
jstirnaman force-pushed the jts/cloud3-content-sharing branch from 3b436fd to 76d72af Compare July 17, 2026 03:26

@ritwika314 ritwika314 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@jstirnaman
jstirnaman force-pushed the jts/cloud3-content-sharing branch from d5bf518 to 76d72af Compare July 17, 2026 03:50
@jstirnaman jstirnaman mentioned this pull request Jul 17, 2026
3 tasks
@jstirnaman
jstirnaman merged commit 83ce740 into ritwika/cloud3_init Jul 20, 2026
42 checks passed
@jstirnaman
jstirnaman deleted the jts/cloud3-content-sharing branch July 20, 2026 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:shared Shared content across products product:v3-distributed InfluxDB 3 Cloud Serverless, Cloud Dedicated, Clustered product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants