Commit Graph

136 Commits (1177825f6e415cfb6b0f498f2a808fc1afce567c)

Author SHA1 Message Date
Jason Stirnaman 7f2178afa5
fix(influxdb3): document exec-mem-pool-bytes usage for data persistence (#6394)
* fix(influxdb3): document exec-mem-pool-bytes usage for data persistence

Updates documentation to reflect that exec-mem-pool-bytes is used for both
query processing and parquet persistence operations, not just queries.

Based on source code analysis showing the memory pool is used by:
- Query executor for processing queries
- Persister for converting WAL data to Parquet format

Changes:
- Updated config description to include "data operations"
- Added memory usage info to durability docs for Parquet storage
- Added troubleshooting section for memory-related write performance
- Fixed capitalization of "object store" throughout

Addresses DAR #499

Source analysis: influxdb3/src/commands/serve.rs:772-798
Shows separate executors for queries and write path operations,
both using memory pools for data processing.

* fix(influxdb3): broken links to no-sync
2025-11-05 11:05:13 -06:00
Jason Stirnaman df06c64fb5
New Enterprise CLI commands: `show nodes` and `stop` (#6510)
* Closes #6509

  New Ent 3 CLI Commands

  1. influxdb3 stop - Parent command for node lifecycle management
  2. influxdb3 stop node - Stop a node in the Enterprise cluster and free up licensed cores
  3. influxdb3 show nodes - Display information about nodes in the cluster

  Files Created

  Shared Content Files (only used by Ent3 for now):
  - content/shared/influxdb3-cli/stop/_index.md - Stop command overview
  - content/shared/influxdb3-cli/stop/node.md - Stop node command details with examples
  - content/shared/influxdb3-cli/show/nodes.md - Show nodes command details with examples

  Enterprise-Specific Frontmatter Files:
  - content/influxdb3/enterprise/reference/cli/influxdb3/stop/_index.md
  - content/influxdb3/enterprise/reference/cli/influxdb3/stop/node.md
  - content/influxdb3/enterprise/reference/cli/influxdb3/show/nodes.md

  Updated Files:
  - Added stop command to the main influxdb3 CLI reference
  - Added nodes subcommand to the show command reference

* Apply suggestion from @jstirnaman

* Apply suggestion from @jstirnaman
2025-11-04 23:09:14 -06:00
Jason Stirnaman 089190dc60
fix(influxdb3): influxdb3 install package command syntax and details (#6512)
* fix(influxdb3): override PLUGIN_DIR env var in compose services to match --plugin-dir

- Set INFLUXDB3_PLUGIN_DIR=/var/lib/influxdb3/plugins in both influxdb3-core and influxdb3-enterprise services
- Overrides Docker image default (/plugins) to match --plugin-dir command argument
- Ensures package installation works correctly with bind-mounted plugin directory
- Update influxdb3 install package CLI documentation with complete options reference

* docs(influxdb3): add Docker disk space troubleshooting for package installation

Add troubleshooting section for 'No space left on device' errors when installing packages in Docker environments. Includes commands to check Docker disk usage and clean up unused images and build cache.

Also fix Vale linting errors by changing 'URL' to 'url'.

* Apply suggestion from @jstirnaman

* fix(ci): Vale rules for URL/-url-/WAL/-wal-/Parquet/-parquet-:

  1. Simplified the Parquet vocabulary entry from the regex to just Parquet
  2. Added separate regex patterns for hyphenated identifiers

* feat(influxdb3): describe use cases and effects of --package-manager disabled
2025-11-04 23:04:44 -06:00
Jason Stirnaman 1b57292191
feat: functional changes (#6500)
* feat: functional changes

* fix: remove serve inaccuracies

* fix: remove opining

---------

Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
2025-10-30 09:52:25 -05:00
peterbarnett03 5169477f52
fix: Add '--database' flag to update database commands (#6491)
Had user feedback and have validated the flag is needed.
2025-10-27 08:34:36 -07:00
epgif c248d9f588
fix: Update system_metrics path (#6481)
Move from 'examples' to 'influxdata' in influxdata/influxdb3_plugins#17
2025-10-23 15:03:26 -05:00
Jason Stirnaman a30345170c
Core and Ent3 performance tuning guide and configuration options (#6421)
* feat(influxdb3): Core and Ent performance tuning guide:Add an admin/performance-tuning/ page with specific workload and capacity configurations.Part of #6403.

* fix(influxdb3): product-specific link fragments for flags

* fix(influxdb3): enterprise-specific link fragments

* Apply suggestion from @jstirnaman

* fix(influxdb3): duplicate licensing and resource limits sections- Rem… (#6470)

* fix(influxdb3): duplicate licensing and resource limits sections- Remove duplicate licensing section- Resolve resource limits duplicates, merging details into the Resource limits section.

* fix(influxdb3): fix broken links and enterprise-only flags in config options

- Comment out TOC links to undocumented datafusion-runtime-* dev flags
- Wrap enterprise-only section references (#licensing, #resource-limits) in conditionals
- Fix num-datafusion-threads incorrectly marked as enterprise-only
- Move Resource Limits section heading outside enterprise wrapper

Resolves broken fragment links for both Core and Enterprise builds.

* feat(enterprise): add cluster management documentation (#6431)

Add comprehensive guide for managing InfluxDB 3 Enterprise clusters including:
- Node configuration and deployment
- Cluster initialization and scaling
- Node removal and replacement procedures
- Best practices for production deployments

* Fixes multiple influxdb3 config option issues:

-  Fixed option placement (global vs serve options) in performance-tuning.md
-  Fixed --datafusion-num-threads option name (was --num-datafusion-threads)
-  Fixed --parquet-mem-cache-size option name and defaults for Core
-  Commented out unreleased --compaction-row-limit option
-  Added v3.0.0 breaking changes to release notes
-  Updated config-options.md with correct defaults and value formats

All changes verified against InfluxDB v3.5.0 release binaries and git history.

* fix(influxdb3): config options in clustering.md

- Correctly place server options
- Comment out unreleased options
2025-10-21 13:14:31 -05:00
Jason Stirnaman ca24b3be54
Influxdb3 config options (#6419)
* docs(cli): fix global vs serve-specific flag documentation

- Remove --verbose from global flags (it's serve-specific)
- Document --num-io-threads as global-only flag
- Add clear examples showing correct flag positioning
- Update serve.md files with global flag usage notes
- Fix config-options.md to separate Core/Enterprise examples

Resolves incorrect CLI usage patterns that would cause errors.
Global flags must go before 'serve', serve-specific flags go after.

* docs(cli): remove Tokio runtime options from CLI index pages

- Remove detailed Tokio runtime options tables from CLI index pages
- Replace with simplified global options and link to config-options
- Add examples showing correct global flag positioning
- Fix --verbose usage to be serve-specific (after serve command)
- Add --num-io-threads example as global flag (before serve command)

These detailed options are now documented in config-options.md with
proper global vs serve-specific categorization.
2025-10-20 10:17:56 -05:00
Jason Stirnaman 7cda139851 docs(influxdb3): clarify retention period constraints and zero-duration behavior
- Add retention period constraints warning (minimum 1h, zero-duration behavior, infinite retention)
- Restructure databases/create.md and tables/create.md with retention examples in tool sections
- Add Explorer preface instructions to delete.md and list.md
- Distinguish Enterprise (table-level) vs Core (database-level) retention capabilities
- Update data-retention.md internals documentation with constraints
2025-10-10 17:53:47 -05:00
Jason Stirnaman d5866d1737 feat(influxdb3): Data retention in Core and Enterprise:
- Adds /reference/internals/data-retention/ for data retention behavior and retention period details
- admin/databases and admin/tables:
  - Adds examples for API and retention period
  - Adds cautions and behavior notes for Core retention
- reference/cli/influxdb3: Adds usage examples and details
- Closes /influxdata/DAR/issues/548
2025-10-10 15:00:52 -05:00
peterbarnett03 042978dd12
Update environment variable for package manager option 2025-10-07 20:32:12 -04:00
peterbarnett03 14276e516f
chore: add 3.5 release notes and config options (#6428)
* chore: add 3.5 release notes and config options

* docs(plugins): enhance --plugin-repo documentation with usage examples

- Add comprehensive plugin-repo configuration documentation
- Document custom repository setup with practical examples
- Add Option 3 for custom plugin repositories in usage guide
- Include use cases for private repos, air-gapped environments, and development
- Cross-reference between config options and usage guide
- Add note about custom repositories in setup section

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

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

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-09-30 09:20:07 -05:00
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
Jason Stirnaman 1f62fde793 chore(influxdb3): Update config-options from ent3 help output 2025-09-11 16:23:28 -05:00
Jason Stirnaman 62880c9834
Update content/shared/influxdb3-cli/config-options.md 2025-09-11 16:01:18 -05:00
jaal2001 903c16e50a
Update config-options.md
Removed ")" in --exec-mem-pool-bytes as typo.

Added format information for --wal-flush-interval and 100ms suggestion from @peterbarnett03 in discord chat.
2025-09-11 16:46:36 +02:00
Jason Stirnaman 3bc56cc36e
Merge branch 'master' into patch-2 2025-09-05 14:44:08 -05:00
Peter Barnett 3f9b54541b fix: remove link 2025-09-05 10:07:07 -04:00
peterbarnett03 99c515a1b8
Clean up config-options.md 2025-09-05 09:58:30 -04:00
jaal2001 a44a06051d
Update config-options.md
Provide both available options for "log-destination" to make it more obvious that no filesystem logs are supported.
2025-08-28 17:00:28 +02: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
Scott Anderson e5c6d1b015
InfluxDB Core and Enterprise 3.4 (#6344)
* 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

* fix(data): update patch versions for core and enterprise

* Apply suggestions from code review

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

---------

Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-27 11:42:41 -06:00
peterbarnett03 3df82f362e
fix: remove buffer-mem-limit-mb (#6341) 2025-08-27 08:32:06 -06:00
Scott Anderson 4d5d509234 fix(monolith): add configurable db, table, and column limits to enterprise 2025-08-14 10:44:58 -05:00
Jason Stirnaman cf8cd90871 Update content/shared/influxdb3-cli/config-options.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-08-06 12:54:56 -05:00
Jason Stirnaman df1069ba65 chore(3ent): Add --num-core config option (still missing from the CLI --help) 2025-08-06 12:54:56 -05: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 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
Jonathan Coates 288b1a395c
Add .no-shorthand to `create token --admin` options (#6189)
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-07-07 09:27:58 -05:00
Jason Stirnaman c457493fc4 chore(influxdb3): v3.2.1 fixes request trigger spec in 3Ent. Remove Core-Ent divergence notes. 2025-07-06 16:43:54 -05:00
Jason Stirnaman a40220091c Merge remote-tracking branch 'origin/jts-6161-3-2-api-ref' into core-ent-3.2 2025-06-30 14:40:24 -05:00
Jason Stirnaman 1db8550462 fix(influxdb3): Update API reference and fix processing engine documentation for 3.2 release
Resolves issue #6161 with InfluxDB 3.2 API reference updates.

## API Reference Updates
- Add `hard_delete_at` parameter to database and table deletion endpoints for scheduled hard deletion
- Add update database and update table endpoints with retention period configuration
- Add license endpoint response schema
- Fix request trigger specification format from `path:` to `request:` in Core API
- Fix OpenAPI schema validation error in Enterprise API by removing conflicting type declaration

## Processing Engine Documentation Fixes
- Standardize terminology across documentation:
  - "Data write" (not "WAL flush" or "On WAL flush")
  - "Scheduled" (not "On Schedule")
  - "HTTP request" (not "On Request")
- Fix placeholder inconsistencies: use REQUEST_PATH instead of ENDPOINT_PATH
- Add Enterprise-specific warnings about request trigger format differences
- Update trigger specification format in Enterprise API to use JSON object format
- Add proper table of contents with consistent structure
- Improve distributed cluster configuration documentation

## Enterprise Request Trigger Bug Documentation
Due to a bug in InfluxDB 3 Enterprise, the request trigger specification format differs between CLI and API:
- CLI: `request:<REQUEST_PATH>` (same as Core CLI and API)
- Enterprise API: `{"request_path": {"path": "<REQUEST_PATH>"}}`

This difference is now properly documented with warnings in all relevant sections.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-30 13:33:52 -05:00
Jason Stirnaman 429e3fc079
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-06-27 14:00:02 -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
Jason Stirnaman 566f7dcb56
Update content/shared/influxdb3-cli/delete/table.md 2025-06-26 17:04:32 -05:00
Jason Stirnaman 52e6eeca8a feat: Update InfluxDB 3 CLI documentation for v3.2.0 features
- Add influxdb3 show license command documentation for Enterprise
- Update create database command with --retention-period option
- Update create table command with Enterprise --retention-period option
- Update delete database/table commands with --hard-delete options
- Update CLI command index to include license command
- Update planning documentation for CLI sync process
- Closes #6160
2025-06-26 16:59:21 -05:00
Jason Stirnaman 0fa1a1d849 fix(influxdb3): links, remove delete-plugin references 2025-06-23 16:27:25 -05:00
Scott Anderson 4d22388bd9 WIP monolith get started, enterprise multi-node, file index docs 2025-06-17 17:12:42 -06:00
meelahme 8050d4ba58 minor updates 2025-06-09 12:10:30 -07:00
meelahme 2d380eabf9 docs: schedule_plugin test command docs with input args, cron syntax, and troubleshooting 2025-06-09 12:00:23 -07:00
meelahme 8f1359420f docs: update schedule_plugin command options and environment variables 2025-06-09 08:49:29 -07:00
Jameelah Mercer 0ee28e33a5
Merge branch 'master' into 6021-add-schedule-plugin-test-docs 2025-06-09 06:22:27 -07:00
Jameelah Mercer 26303fd1ec
Update content/shared/influxdb3-cli/test/schedule_plugin.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-06-09 06:22:18 -07:00
Jameelah Mercer e1ce7ddfcf
Update content/shared/influxdb3-cli/test/schedule_plugin.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-06-09 06:22:10 -07:00
Jameelah Mercer 16bb041898
Update content/shared/influxdb3-cli/test/schedule_plugin.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-06-09 06:22:02 -07:00
Jameelah Mercer b9272527e2
Update content/shared/influxdb3-cli/test/schedule_plugin.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-06-09 06:21:55 -07:00
Jameelah Mercer 029d14eece
Update content/shared/influxdb3-cli/test/schedule_plugin.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-06-09 06:21:49 -07:00
Jameelah Mercer f0fdb709fd
Update content/shared/influxdb3-cli/test/schedule_plugin.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-06-09 06:21:02 -07:00
meelahme fd1c9dcf1e docs: adding test schedule plugin example 2025-05-29 23:07:46 +09:00