Skip to content

Added initial cloud files#7338

Open
ritwika314 wants to merge 14 commits into
masterfrom
ritwika/cloud3_init
Open

Added initial cloud files#7338
ritwika314 wants to merge 14 commits into
masterfrom
ritwika/cloud3_init

Conversation

@ritwika314

@ritwika314 ritwika314 commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

This pull request introduces documentation for InfluxDB 3 Cloud, including new sections on user, database, table, and token management. It adds guides for using the Admin UI and CLI/API for common administrative tasks, and updates the link checker configuration to accommodate generated API reference links.

Most of the content is reused from enterprise docs, hiding features where unavailable, and routing unimplemented docs/unavailable api references to influxdb3/cloud/request-information.md . According to Claude this PR is touching existing with broken references, which is the rationale for changing .ci/link-checker/production.lycherc.toml.

Major documentation additions:

  • InfluxDB 3 Cloud documentation landing page and structure:

    • Added content/influxdb3/cloud/_index.md to introduce InfluxDB 3 Cloud, its features, and early access status.
    • Added content/influxdb3/cloud/admin/_index.md to provide an overview of administrative tasks.
  • User and access management:

    • Added user management documentation, including user groups, roles, and permissions (content/influxdb3/cloud/admin/users/_index.md) and detailed Admin UI instructions (content/influxdb3/cloud/admin/users/admin-ui.md). [1] [2]
    • Added token management documentation, detailing token types and CLI/API usage (content/influxdb3/cloud/admin/tokens/_index.md).
  • Database and table administration:

    • Added guides for managing databases: overview, create, list, and delete operations (content/influxdb3/cloud/admin/databases/_index.md, create.md, list.md, delete.md). [1] [2] [3] [4]
    • Added guides for managing tables: overview, create, list, and delete operations (content/influxdb3/cloud/admin/tables/_index.md, create.md, list.md, delete.md). [1] [2] [3] [4]

Build and configuration updates:

  • Updated link checker configuration to exclude API reference links that are generated separately and not present during link checking (.ci/link-checker/production.lycherc.toml).

Checklist


Suggested reviewers (click to expand)

Based on files changed, consider requesting review from:

InfluxDB 3

Content Engineering Product
Core, Enterprise influxdata/monolith-team peterbarnett03, garylfowler
Clustered influxdata/platform-team ritwika314, sanderson
Cloud Dedicated influxdata/cloud-single-tenant ritwika314, sanderson
Cloud Serverless mavarius, garylfowler
Explorer mavarius, peterbarnett03

InfluxDB v2 / v1 / Enterprise v1

Content Engineering Product
v2, Cloud (TSM) influxdata/edge sanderson, jstirnaman
v1, Enterprise v1 influxdata/edge sanderson, jstirnaman

Other Products

Content Engineering Product
Telegraf influxdata/telegraf-team sanderson, caterryan
Kapacitor influxdata/bonitoo sanderson, jstirnaman
Chronograf influxdata/bonitoo mavarius, caterryan
Flux sanderson, jstirnaman

Shared / Cross-Product

Content Reviewers
/content/shared/ influxdata/product-managers
API docs Relevant product team above

@github-actions

github-actions Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 0
Warnings 16
Suggestions 10
Warnings (16)
File Line Rule Message
content/influxdb3/cloud/admin/_index.md 10 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/databases/_index.md 21 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/databases/create.md 25 Google.Quotes Commas and periods go inside quotation marks.
content/influxdb3/cloud/admin/databases/create.md 34 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/databases/delete.md 22 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/databases/list.md 21 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/tables/_index.md 18 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/tables/create.md 25 Google.Quotes Commas and periods go inside quotation marks.
content/influxdb3/cloud/admin/tables/create.md 26 Google.Quotes Commas and periods go inside quotation marks.
content/influxdb3/cloud/admin/tables/create.md 27 Google.Quotes Commas and periods go inside quotation marks.
content/influxdb3/cloud/admin/tables/create.md 27 Google.Quotes Commas and periods go inside quotation marks.
content/influxdb3/cloud/admin/tables/create.md 36 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/tables/delete.md 26 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/tables/list.md 28 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/users/admin-ui.md 25 InfluxDataDocs.Capitalization 'User roles and permissions' should be in sentence case
content/influxdb3/cloud/admin/users/admin-ui.md 92 InfluxDataDocs.Capitalization 'View invitation details' should be in sentence case

Check passed

ritwika314 and others added 2 commits June 16, 2026 10:42
Add get-started, write-data, query-data, visualize-data, admin, and
reference section landing pages for InfluxDB 3 Cloud, sourcing shared
content following the Enterprise pattern.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR introduces initial documentation scaffolding for the new InfluxDB 3 Cloud section, wires it into site navigation/title handling, and registers the product in the central products data so it can participate in shared templates and UI components.

Changes:

  • Add influxdb3_cloud product metadata to data/products.yml.
  • Add initial InfluxDB 3 Cloud content section stubs (landing page + key sub-sections), mostly sourcing shared content.
  • Update the product selector and HTML <title> logic to recognize /influxdb3/cloud/, and bump the Telegraf docs link in the platform reference.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
PLATFORM_REFERENCE.md Updates the Telegraf documentation link to v1.39.
layouts/partials/topnav/product-selector.html Adds InfluxDB 3 Cloud to the product selector data and UI list.
layouts/partials/header/title.html Sets a distinct site title for InfluxDB 3 Cloud pages.
data/products.yml Registers the new influxdb3_cloud product and associated metadata.
content/influxdb3/cloud/_index.md Adds the InfluxDB 3 Cloud landing page, cascade settings, and early access callout.
content/influxdb3/cloud/admin/_index.md Adds admin section stub sourcing shared admin content.
content/influxdb3/cloud/get-started/_index.md Adds get-started section stub sourcing shared get-started content.
content/influxdb3/cloud/query-data/_index.md Adds query section stub sourcing shared query-guide content.
content/influxdb3/cloud/reference/_index.md Adds reference section stub with children listing.
content/influxdb3/cloud/visualize-data/_index.md Adds visualize section index with children listing.
content/influxdb3/cloud/write-data/_index.md Adds write-data section stub sourcing shared write-guide content.

Comment thread content/influxdb3/cloud/_index.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@ritwika314

Copy link
Copy Markdown
Collaborator Author

@copilot resolve the merge conflicts in this pull request

Copilot AI commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts in this pull request

Resolved by merging origin/master and fixing conflicts in PLATFORM_REFERENCE.md and layouts/partials/topnav/product-selector.html in commit e88a955.

Go's `default` evaluates both arguments, so `.Description | default .Summary`
always computed .Summary, which can error on pages whose auto-summary
truncates mid-shortcode (leaving a malformed shortcode token). Use an
explicit conditional so .Summary is only accessed when .Description is unset.

Co-authored with Claude
… docs

- Add cloud-specific get-started setup (managed procurement, influxdb3 CLI
  token auth) and reuse shared write/query guides via 'cloud' conditionals
- Incorporate enterprise query-data, databases, and tables into cloud admin
- Add cloud manage-users section (adapted from Cloud Dedicated)
- Add write-data client-libraries, influxdb3 CLI, and HTTP API guides
- Add limits for influxdb3_cloud in products.yml (fixes influxdb3/limit crash)
- Hide Explorer, compatibility APIs, optimize-queries, write-responses, and
  visualize-data for cloud; render the instance host instead of localhost
- Scope the early-access callout to the landing and get-started pages

Co-authored with Claude

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 55 out of 55 changed files in this pull request and generated 3 comments.

Comment on lines 22 to 26
{{ $influxdbCloud := dict "influxdb/cloud" (slice $.Site.Data.products.influxdb_cloud.name "cloud") }}
{{ $influxdb3Core := dict "influxdb3/core" (slice $.Site.Data.products.influxdb3_core.name "core") }}
{{ $influxdb3Enterprise := dict "influxdb3/enterprise" (slice $.Site.Data.products.influxdb3_enterprise.name "enterprise") }}
{{ $influxdb3Cloud := dict "influxdb3/cloud" (slice $.Site.Data.products.influxdb3_cloud.name "cloud") }}
{{ $influxdb3Explorer := dict "influxdb3/explorer" (slice $.Site.Data.products.influxdb3_explorer.name "explorer") }}
…nformation page

Resolve CI broken links on InfluxDB 3 Cloud pages by routing all
not-yet-published cloud paths to a single request-information page that
directs readers to InfluxData support.

- Add content/influxdb3/cloud/request-information.md owning the 49 missing
  cloud paths as aliases (covers links from the token-link shortcode, raw
  HTML buttons, and shared markdown). Excluded from nav and child lists.
- Fix shared influxql/troubleshoot.md: /enterprise_influxdb/v1/api/query/
  -> /enterprise_influxdb/v1/api/ (the /query/ subpath is not a built page).
- Remove a dangling TOC entry in shared influxql/aggregate-select.md that
  pointed to a section only present in the SQL version.

Co-authored with Claude
… anchors

The link checker's fragment validator follows meta-refresh redirects but
ignores the lychee exclude config, so aliasing not-yet-published Cloud paths
left their #fragment deep links broken. Add the referenced anchors to the
redirect target so the checker resolves them there.

- request-information.md: alias all not-yet-published Cloud reference/API paths
  and add hidden anchors for every referenced #fragment. The checker follows
  each alias redirect to this page and finds the anchor. Remove an anchor when
  its target page is published for Cloud.
- production.lycherc.toml: exclude the v1 query API reference link (generated by
  a separate api-docs pipeline that does not run during the link-check job).

Co-authored with Claude

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 59 out of 59 changed files in this pull request and generated 1 comment.

Comment thread content/influxdb3/cloud/admin/databases/create.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@ritwika314 ritwika314 marked this pull request as ready for review June 25, 2026 11:19
@ritwika314 ritwika314 requested a review from a team as a code owner June 25, 2026 11:19
@ritwika314 ritwika314 removed the request for review from a team June 25, 2026 11:19
@ritwika314 ritwika314 requested a review from jstirnaman June 25, 2026 11:19
@github-actions

github-actions Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-7338/
on branch gh-pages at 2026-06-26 12:22 UTC

@github-actions

github-actions Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

📦 PR Preview — Preview Bot

Status Details
Result ✅ DEPLOYED
Preview View preview
Pages 50 page(s) deployed
Build time 56s
Last updated 2026-06-26 12:23:04 UTC
Pages included in this preview
  • /influxdb3/cloud/
  • /influxdb3/cloud/admin/
  • /influxdb3/cloud/admin/databases/
  • /influxdb3/cloud/admin/databases/create/
  • /influxdb3/cloud/admin/databases/delete/
  • /influxdb3/cloud/admin/databases/list/
  • /influxdb3/cloud/admin/tables/
  • /influxdb3/cloud/admin/tables/create/
  • /influxdb3/cloud/admin/tables/delete/
  • /influxdb3/cloud/admin/tables/list/
  • /influxdb3/cloud/admin/tokens/
  • /influxdb3/cloud/admin/users/
  • /influxdb3/cloud/admin/users/admin-ui/
  • /influxdb3/cloud/get-started/
  • /influxdb3/cloud/get-started/query/
  • /influxdb3/cloud/get-started/setup/
  • /influxdb3/cloud/get-started/write/
  • /influxdb3/cloud/query-data/
  • /influxdb3/cloud/query-data/execute-queries/
  • /influxdb3/cloud/query-data/execute-queries/influxdb-v1-api/
  • ... and 30 more

Preview auto-deploys on push. Will be cleaned up when PR closes.

@ritwika314 ritwika314 requested a review from sanderson June 25, 2026 11:28
Replace the admin-token-from-support flow with the self-service OAuth
device-code login (influxdb3 auth login --oauth), which is the customer
auth path for InfluxDB 3 Cloud. The initial admin token is an internal
operator flow and is removed from customer docs.

- Get your instance (host URL only) -> connect -> log in via auth login
  --oauth (credentials cached in ~/.influxdb3/credentials.json; do not set
  INFLUXDB3_AUTH_TOKEN for interactive use) -> verify with show databases.
- Keep database-token creation for applications; note that creating tokens
  requires admin privileges.
- Note that a new database can take a few seconds to appear in show databases.
- Preserve the #configure-the-influxdb3-cli and #set-your-token-for-authorization
  anchors for existing inbound links.

Co-authored with Claude
@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 Jun 25, 2026
@jstirnaman jstirnaman self-assigned this Jun 25, 2026
@jstirnaman

Copy link
Copy Markdown
Contributor

The Get started landing page (content/influxdb3/cloud/get-started/_index.md) currently ends after the Data model section with no in-body path into the guide — continuation only happens through the Related sidebar.

I opened #7388 against this branch (ritwika/cloud3_init) to fix it: it adds the {{< children type="ordered-list" >}} step roadmap (Set up → Write → Query) and a page-nav to the setup page. Core and Enterprise get both from the shared /shared/influxdb3-get-started/_index.md source; this page is standalone, so they're added directly.

Follow-up noted in that PR: the page also duplicates the shared Data model prose and drops the shared Tools table. Deduping by sourcing the shared file (with show-in "cloud" blocks) is left out for now since it touches a file outside this PR's diff.

@jstirnaman jstirnaman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall, looks great! Mostly style nits and a couple of small PRs for substantial changes. I'll start work soon on the InfluxDB 3 info. arch. redesign.

Enterprise. Built on InfluxDB 3, it delivers high write and query performance
with a diskless architecture that scales horizontally without the operational
overhead of managing your own infrastructure. InfluxDB 3 Cloud is the
recommended destination for InfluxDB Cloud Dedicated customers.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Add a when/why they're destined?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yikes,good catch i think i wrote this a while ago,that whole line needs to go.

Comment thread content/influxdb3/cloud/_index.md
Comment on lines +33 to +35
> Interested in trying InfluxDB 3 Cloud?
> Learn more and request access on the
> [InfluxDB 3 Cloud product page](https://www.influxdata.com/products/influxdb3-cloud/).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
> Interested in trying InfluxDB 3 Cloud?
> Learn more and request access on the
> [InfluxDB 3 Cloud product page](https://www.influxdata.com/products/influxdb3-cloud/).
> Interested in trying InfluxDB 3 Cloud?
> See the
> [InfluxDB 3 Cloud product page](https://www.influxdata.com/products/influxdb3-cloud/)
> to request access.

Comment thread content/influxdb3/cloud/admin/tokens/_index.md
Comment thread content/influxdb3/cloud/admin/tokens/_index.md Outdated
## Create a database

Use the
[`influxdb3 create database` command](/influxdb3/cloud/reference/cli/influxdb3/)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

TODO: update this URL when reference content is added

Comment on lines +176 to +180
The command returns the token string.
Store the token string in a safe place.
**This is the only time the token string is available in plain text.**
Applications can authenticate with the token by setting the
`INFLUXDB3_AUTH_TOKEN` environment variable or passing the `--token` option.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Use the standard "Store your token securely" callout, matching setup.md.

Suggested change
The command returns the token string.
Store the token string in a safe place.
**This is the only time the token string is available in plain text.**
Applications can authenticate with the token by setting the
`INFLUXDB3_AUTH_TOKEN` environment variable or passing the `--token` option.
The command returns the token string.
> [!Important]
> #### Store your token securely
>
> InfluxDB displays the token string only when you create it.
> Store your token securely—you cannot retrieve it from the database later.
Applications can authenticate with the token by setting the
`INFLUXDB3_AUTH_TOKEN` environment variable or passing the `--token` option.

- [Perform an ungrouped aggregation](#perform-an-ungrouped-aggregation)
- [Group and aggregate data](#group-and-aggregate-data)
- [Downsample data by applying interval-based aggregates](#downsample-data-by-applying-interval-based-aggregates)
- [Query rows based on aggregate values](#query-rows-based-on-aggregate-values)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Comment thread content/shared/influxdb3-query-guides/influxql/troubleshoot.md Outdated
present, and .Summary can error on pages whose auto-summary truncates
mid-shortcode (leaving a malformed shortcode token). */ -}}
{{- $description := .Description -}}
{{- if not $description -}}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@jstirnaman jstirnaman left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall, looks great! Mostly style nits and a couple of small PRs for substantial changes. I'll start work soon on the InfluxDB 3 info. arch. redesign.

Some of these suggestions

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
@ritwika314

Copy link
Copy Markdown
Collaborator Author

Overall, looks great! Mostly style nits and a couple of small PRs for substantial changes. I'll start work soon on the InfluxDB 3 info. arch. redesign.

Thanks for the review and the additional PRs @jstirnaman ! Some of your comments have inspired some more phrasing changes, i'll add a small PR against this branch today to make those. Also user groups will get a page under users with 3.11 for sure.

@jstirnaman jstirnaman removed their assignment Jun 29, 2026
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.

4 participants