Commit Graph

200 Commits (feature/cloud-dedicated-user-management-docs)

Author SHA1 Message Date
Jason Stirnaman 55017154fb feat(influxdb3): add install package command documentation
- Create shared CLI documentation for install package command
- Add Enterprise and Core frontmatter files referencing shared content
- Add --node-spec option to create trigger command for Enterprise
- Update code-placeholders to use new fenced code block syntax

Closes influxdata/DAR#6301
2025-09-11 16:23:39 -05:00
Scott Anderson 8f729f9500
chore(sql): Update SQL reference with additional functions (#6359)
* feat(sql): WIP added struct and map functions

* chore(sql): update sql reference with new functions

* chore(sql): migrate sql reference function updates to other projects

* chore(sql): readd deleted cache functions pages

* Update content/shared/sql-reference/functions/array.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix(sql): fixed broken anchor links

* fix(sql): fixed typos

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-09-05 08:26:38 -06:00
Scott Anderson ebe1ec9750
InfluxDB 3 Explorer 1.2 (#6350)
* feat(explorer): WIP cache management docs

* feat(explorer): add cache management guides, fix js bugs

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-29 08:44:59 -06:00
Scott Anderson deb6307093 hotfix: add related links to offline token guides 2025-08-28 07:14:37 -06:00
Scott Anderson 3222c7a9fb
InfluxDB 3.4 offline tokens (#6346)
* update: add 3.4 notes

* update: 3.4 notes

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/shared/v3-core-enterprise-release-notes/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* feat(influxdb-3.4): added cli updates for influxdb 3.4

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: add whitespace to influxdb3 write doc

* feat(offline-tokens): add offline tokens to config options page

* feat(offline-tokens): add task-based offline token docs

* fix(links): fixed broken links and added TOC to offline tokens guide

* Apply suggestions from code review

Co-authored-by: マルコメ <akio.muto@bnt.benextgroup.jp>

* chore(offline-tokens): add token string security standards

* chore(offline-tokens): add note about token string prefix

---------

Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: マルコメ <akio.muto@bnt.benextgroup.jp>
2025-08-28 07:03:03 -06:00
peterbarnett03 3df82f362e
fix: remove buffer-mem-limit-mb (#6341) 2025-08-27 08:32:06 -06:00
Peter Barnett 7fcd338b2e update: fix some wording and call out restore process 2025-08-25 09:32:48 -04:00
Jason Stirnaman 73c224c0f4
Merge branch 'master' into 6291-influxdb3-backup-and-restore 2025-08-23 11:41:00 -05:00
Jason Stirnaman 081952249b hotfix(influxdb3): processing engine source and description (closes #6335) 2025-08-22 17:50:19 -05:00
Jason Stirnaman f975f164fd chore(influxdb3): adjust Admin weights for the sidebar nav 2025-08-22 16:58:29 -05:00
Jason Stirnaman 0ddd5a2257 feat(influxdb3): Back up and restore Core and Enterprise:- Recommends a process for back up and recovery of files in object storage.- Provides examples for Core and Enterprise'- Prescribes the order to stop, back up, and restart nodes. 2025-08-22 16:50:11 -05:00
Jason Stirnaman e10340b6ec chore(ci): Add config for new link validation tool (docs-tooling/link-checker)
chore(ci): Replaced PR link validation workflow with new workflow from docs-tooling/link-checker/.github-workflows-link-check.yml

chore: organize .gitignore

test: add content to trigger link-checker workflow

This small change tests the pr-link-check.yml workflow

feat: update link-checker workflow and documentation

- Add production config with corrected User-Agent placement
- Remove old link validation actions (replaced by link-checker)

fix: update link-checker workflow configuration

- Update Node.js version to 20 for dependency compatibility

feat: use pre-built link-checker binary from docs-tooling releases

- Replace building from source with downloading from releases
- Use GitHub API to get latest release and binary
- Maintain same artifact structure for downstream job

fix: improve change detection in pr-link-check workflow

- Use GitHub API for reliable PR file detection
- Add debug output to show all changed files
- Fix conditional logic for when jobs should run

docs: update TESTING.md with binary distribution and automated GitHub Actions integration

- Document pre-built binary download as recommended installation method
- Explain automated PR link checking workflow for docs-v2
- Replace manual GitHub Actions example with automated integration details
- Remove exaggerated language and specify actual exclusion types

fix(ci): download link-checker binary from docs-v2 releases

- Change binary source from private docs-tooling to public docs-v2 releases
- Fixes GitHub Actions permission issues accessing private repos
- Binary is now stored as a release asset on docs-v2 itself

test: add test file with valid links to verify workflow passes

test: remove temporary test file for link checker workflow

The test file was only needed to verify the workflow functionality
and should not be part of the documentation.

docs: update TESTING.md to document docs-v2 binary distribution

- Change primary installation method to download from docs-v2 releases
- Explain that binary distribution enables reliable GitHub Actions access
- Update automated workflow description to reflect docs-v2 release usage
- Maintain build-from-source as alternative option

refactor(ci): combine workflow into single job for cleaner PR display

- Merge detect-changes, build-site, and download-link-checker into single job
- All setup steps now run conditionally within one job
- Cleaner PR display shows only 'Check links in affected files'
- Maintains all functionality with improved UX

fix(ci): exclude problematic URLs from link checking

- Add reddit.com exclusions (blocks bots)
- Add support.influxdata.com exclusion (SSL certificate issues in CI)
- Prevents false positive failures in automated link checking
2025-08-16 22:14:27 -05:00
Jason Stirnaman f23026982b chore(monolith): Move telemetry reference to shared/influxdb3-reference. Revise description, disable, and product names. 2025-08-14 14:41:05 -05:00
Peter Barnett 5492ba9eef fix: remember the 3 2025-08-14 11:52:59 -04:00
Peter Barnett 963d0a8d21 docs: add usage telemetry documentation 2025-08-14 11:29:44 -04:00
Jason Stirnaman 407a5e6de6 1. Updated Core serve.md Options Section
- Updated /content/influxdb3/core/reference/cli/influxdb3/serve.md with 84 Core-compatible options
  - Excluded 21 Enterprise-only options (like cluster-id, license-email, license-file, mode, compaction options, clustering options, etc.)
  - All options now link to the Core configuration documentation
  - Fixed the environment variables link to point to Core instead of Enterprise

2. Updated Enterprise serve.md Options Section

  - Updated /content/influxdb3/enterprise/reference/cli/influxdb3/serve.md with all 105 configuration options
  - Includes both Core and Enterprise-only options
  - Maintains proper required option markers for node-id and cluster-id
  - All options link to the Enterprise configuration documentation

3. Verified Content Consistency

  - Core serve.md: Contains examples without cluster-id parameter (appropriate for Core)
  - Enterprise serve.md: Contains examples with both node-id and cluster-id parameters, plus Enterprise-specific mode examples
  - Both maintain consistent structure and troubleshooting sections appropriate to their respective products
  - Environment variables sections correctly reference their respective configuration documentation

4. Allow Vale to accept "parquet" in lowercase when it appears in:
  - Command-line options (e.g., --parquet-mem-cache-size)
  - Hyphenated configuration names (e.g., parquet-mem-cache-prune-interval)
  - Code blocks or inline code (e.g., `parquet`)

  Key Changes Made:

  - Core: Now includes 84 options (was 69), excluding Enterprise-only features
  - Enterprise: Now includes all 105 options (was 78), comprehensive coverage
  - Alphabetical ordering: Both option tables are now properly alphabetized
  - New options added: Many previously missing options like buffer-mem-limit-mb, tcp-listener-file-path, telemetry-*, wal-replay-*, etc.
  - Proper segregation: Core users no longer see Enterprise-only configuration options
  - Vale allows Parquet or parquet in the appropriate context
2025-08-06 12:54:56 -05:00
Jason Stirnaman bfe842dfdb Update content/influxdb3/core/plugins/library/official/system-metrics.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-07-30 10:16:23 -05:00
Jason Stirnaman 55e128cb78 chore(influxdb3): Promote system metrics plugin from examples to official plugins:- Updated with latest configuration arguments 2025-07-30 10:16:23 -05:00
Jason Stirnaman 2b8e769697 feat(influxdb3): add plugin library with comprehensive plugin documentation:
- Add plugin library structure for Core and
Enterprise products
- Create shared content directory for plugin
documentation
- Port 12 plugin documentation files from
influxdb3_plugins repository
- Add GitHub repository links in related frontmatter
for all plugins
- Remove emoji metadata tags and clean up content
structure
- Implement standardized support sections with
product-specific links
- Reorganize plugins navigation with dedicated
library section
- Include 2 example plugins and 10 official
InfluxData plugins
2025-07-30 10:16:23 -05:00
Jason Stirnaman 06608aea6c feat(influxdb3): add v3.3.0 release notes and admin token recovery documentation
- Add v3.3.0 release notes with grouped categories for Core and Enterprise features/fixes
- Document admin token recovery server feature (--admin-token-recovery-http-bind)
- Add recovery server option to CLI serve command reference (alphabetically sorted)
- Add configuration details for admin token recovery in config options
- Update regenerate token documentation with lost token recovery instructions
- Include security warnings about unauthenticated recovery endpoint
- Fix Vale linting issues (Parquet capitalization, remove exclamation point)

Related to influxdb PR #26594
2025-07-30 07:59:13 -05:00
Jason Stirnaman be2c6ac503 fix(write_lp): Update titles with actual endpoint name, add related link in API ref. 2025-07-25 16:35:57 -05:00
Jason Stirnaman b8598c7007
Merge branch 'master' into jts-dar-515-naming 2025-07-17 15:23:31 -05:00
Scott Anderson 81c9d0ba76
feat(monolith): use minio for object storage (#6228)
* feat(monolith): use minio for object storage

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-07-17 15:14:17 -05:00
Jason Stirnaman cd21fbcd22
Merge branch 'master' into jts-dar-515-naming 2025-07-11 08:36:35 -05:00
Jason Stirnaman 3f8b84e4e1
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-07-11 08:12:40 -05:00
Jason Stirnaman a4549ad5ef feat(influxdb3): add admin/tables guides for list and delete:
- Add Core and Ent. guides for using the CLI and API to list and delete tables.
- Closes #6215
2025-07-10 18:05:30 -05:00
Jason Stirnaman 1c8a7b8606 feat(influxdb3): create table guides for core and ent
Part of #6215
2025-07-10 17:07:57 -05:00
Jason Stirnaman beeb428470 feat(v3): Add naming restrictions reference and guidelines:
- Fixes influxdata/DAR#515: discourages the use of a leading underscore in database and table names in all InfluxDB 3 versions, but doesn't disallow it
- Add detailed naming restrictions reference for all InfluxDB 3 versions
- Add basic guidelines in table and database creation guides.
- Core and Ent table guides are forthcoming in a separate PR
2025-07-10 16:10:27 -05:00
Scott Anderson a730bb4b69
Merge branch 'master' into feat-influxdb3-cli-updates 2025-07-09 14:36:05 -06:00
Scott Anderson ec6e28d0e2
Add MCP server documentation to Core, Enterprise, and Cloud Dedicated (#6200)
* add mcp server documentation for core, enterprise, and cloud-dedicated

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* updated mcp server npm/docker package names, updated environment variables

* updated the mcp server instructions to be correct

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-07-09 15:23:48 -05:00
Jason Stirnaman 7674012aed feat(influxdb3): Add missing precision CLI option, fix and enhance write documentation.\
- Verified precision behavior in source code. Added auto-detection note for all APIs: Added a note
  explaining that InfluxDB 3 uses timestamp magnitude to
  auto-detect precision by default, and users can specify
   precision to avoid ambiguity.
- Fix allowed precision values\
- Add examples
2025-07-08 19:38:44 -05:00
Jason Stirnaman 3ceabeed4a Add missing CLI options\
Fix `create token --admin` name in frontmatter
Improve schedule trigger docs with more detail:

  1. Core API documentation
  (/api-docs/influxdb3/core/v3/ref.yml):
    - Added missing duration units (weeks, months, years)
    - Added "Maximum interval: 1 year"
  2. Enterprise API documentation
  (/api-docs/influxdb3/enterprise/v3/ref.yml):
    - Added missing duration units (weeks, months, years)
    - Added "Maximum interval: 1 year"
  3. CLI reference documentation
  (/content/shared/influxdb3-cli/create/trigger.md):
    - Added complete list of supported duration units
    - Added "Maximum interval is 1 year" note

  All documentation now consistently reflects:
  - The complete set of supported duration units for
  every triggers
  - The 1-year maximum limit for interval-based
  scheduling
  - Clear examples showing the syntax
2025-07-08 15:37:09 -05:00
Jason Stirnaman c9e04946f8
Merge branch 'master' into feat-influxdb3-cli-updates 2025-07-08 15:30:43 -05:00
Jason Stirnaman aacef0a06a Add missing CLI options\
Fix `create token --admin` name in frontmatter
Improve schedule trigger docs with more detail:

  1. Core API documentation
  (/api-docs/influxdb3/core/v3/ref.yml):
    - Added missing duration units (weeks, months, years)
    - Added "Maximum interval: 1 year"
  2. Enterprise API documentation
  (/api-docs/influxdb3/enterprise/v3/ref.yml):
    - Added missing duration units (weeks, months, years)
    - Added "Maximum interval: 1 year"
  3. CLI reference documentation
  (/content/shared/influxdb3-cli/create/trigger.md):
    - Added complete list of supported duration units
    - Added "Maximum interval is 1 year" note

  All documentation now consistently reflects:
  - The complete set of supported duration units for
  every triggers
  - The 1-year maximum limit for interval-based
  scheduling
  - Clear examples showing the syntax
2025-07-08 13:24:52 -05:00
Jason Stirnaman 48380fd168 fix(influxdb3): Auth schemes in 3core, 3ent, cloud-dedicated, and clustered:Explains compatibility for different schemasProvides more auth examplesFills missing schemes in API refFixes placeholdersShows that username is optional 2025-07-07 23:10:37 -05:00
jonasnoki b01816c2dd fix: use correct port in example compose.yaml in install.md 2025-07-07 14:10:21 -05:00
Jason Stirnaman b5f511f9e4 Merge remote-tracking branch 'origin/explorer-ga' into core-ent-3.2 2025-06-30 14:11:24 -05:00
Scott Anderson 51e75e2ad6 Merge branch 'master' into explorer-ga 2025-06-27 23:08:23 -06:00
Jason Stirnaman 16f79c9549
Merge branch 'master' into jts-6160-3-2-cli 2025-06-27 18:30:41 -05:00
Jason Stirnaman cf8fab9802 fix(core): broken link 2025-06-27 14:50:19 -05:00
Jason Stirnaman 8e040c8eb3 fix(core,ent3): and related params are required (closes #6166) 2025-06-27 14:44:28 -05:00
Jason Stirnaman 6dac142127 feat(influxdb3): Core and Ent: CLI reference for update database, update table (Ent3 only)- Add CLI reference for influxdb3 update database command and retention period option in Core and Ent
- Add CLI ref for influxdb3 update table and ret. period option in Ent- Change volume source to /test for core and ent3 in compose.yaml
- Add alt_links instructions in CONTRIBUTING.md
2025-06-27 12:49:39 -05:00
Scott Anderson d176eea4e7
Manage databases and tokens in InfluxDB 3 Explorer (#6162)
* Manage databases and tokens in Explorer

* Update content/influxdb3/explorer/manage-tokens.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-06-26 16:35:31 -05:00
Jason Stirnaman eb90b04a35 fix(influxdb3): link, rename get-started/processing-engine to get-started/process 2025-06-23 16:27:25 -05:00
Scott Anderson f64a8670b7 resolved merge conflicts 2025-06-23 09:53:49 -06:00
Scott Anderson 4d22388bd9 WIP monolith get started, enterprise multi-node, file index docs 2025-06-17 17:12:42 -06:00
Jason Stirnaman 7d6ae51183 chore(enterprise3): Strongly recommend to provide the email address when using Docker, especially Docker Compose, in order for license generation to complete:
- Install Enterprise
- Admin license
- If only one pagination button (prev or next), allow it to fill the width.
- Combines core and enterprise install into a shared page.
2025-06-17 16:50:55 -05:00
Scott Anderson 9dc847bf47 restructured write guides, start on gs query guide 2025-06-12 15:32:44 -06:00
Scott Anderson ef166677f1 Merge branch 'master' into monolith-gs-restructure 2025-06-10 16:04:21 -06:00
Scott Anderson 09b83dd1f8 WIP gs write data 2025-06-10 11:47:57 -06:00