Commit Graph

16 Commits (fix/issue-6939)

Author SHA1 Message Date
Jason Stirnaman a609a3f900
docs(influxdb3): document how to disable Processing Engine (#6860)
* docs(influxdb3): document how to disable Processing Engine

Add documentation for disabling the Processing Engine in Docker and
systemd deployments. Key points:

- Processing Engine is enabled by default in Docker images and DEB/RPM
- Empty string does not disable — must unset or remove config
- Enterprise: use INFLUXDB3_UNSET_VARS feature
- Core Docker: requires custom entrypoint workaround
- systemd: comment out or remove plugin-dir from TOML config

closes influxdata/DAR#590

* docs(influxdb3): add cross-references for Processing Engine defaults

Add notes and cross-references explaining that the Processing Engine
is enabled by default in Docker and DEB/RPM installations:

- plugins/_index.md: Add deployment behavior table and link to disable docs
- get-started/processing-engine.md: Add note with cross-reference

* docs(influxdb3): clarify Processing Engine vs process mode distinction

Add notes explaining that --plugin-dir (Processing Engine activation) and
--mode=process (cluster node specialization) are independent configurations.

* docs(influxdb3): document --plugin-dir auto-enables process mode

- Update clustering, get-started, plugins, and reference pages
- Add example for enabling Processing Engine without --mode=process
- Clarify --mode=process is only needed for dedicated process-only nodes
- Synthesize notes into inline content for better flow in guides

* Update content/shared/influxdb3-reference/influxdb3-processing-engine.md

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

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

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

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-25 10:47:03 -06:00
Copilot 57ad83ba1c
Mark disabled field as required in processing engine trigger API specs (#6790)
* fix(influxdb3): Mark disabled field as required in processing engine trigger API specs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Add HTTP API examples to Processing Engine plugin documentation (#6789)

- Add disabled field and api-ref to API examples per review feedback
- Add api-ref to upload plugin endpoint and remove duplicate link sentence
- Convert {{% code-placeholders %}} shortcode to placeholders code block
  attribute for cleaner syntax
- Add second argument to token-link shortcodes for admin tokens to
  ensure consistent linking to /admin/tokens/admin/ path
- Follows PR 6789 review feedback for processing engine documentation

fix(influxdb3): update placeholder and token-link syntax in get-started

- Convert code-placeholders wrapper shortcodes to code block attributes

* fix(influxdb3): Fix broken trigger anchor links in plugin documentation

Rename "Set up a trigger" heading to "Create a trigger" and update
all internal anchor references to match.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2026-02-09 15:46:37 -06:00
Jason Stirnaman bd6f7481b0
Dar 588 plugins (#6718)
* fix(influxdb3): source comments

* docs(influxdb3): fix plugin path handling and improve Get Started clarity

Fixes issues with plugin filename resolution and improves progressive
disclosure in the processing engine Get Started guide.

- Update `--plugin` flag to `--path` (current CLI syntax)
- Clarify plugin filename must be provided without relative/absolute paths
- Add note explaining path resolution relative to `--plugin-dir`
- Document single-file vs multi-file plugin path requirements
- Link to detailed multi-file plugin structure documentation

- Add "Before you begin" section listing required setup steps
- Add prerequisites to table of contents
- Improve progressive disclosure by front-loading essentials

- Update trigger type from "Data write" to "WAL rows" (consistent with `influxdb3 create trigger --help`) with WAL link
- Replace `--plugin` with `--path` in trigger creation example
- Fix syntax error in enable trigger example (missing backslash)
- Clarify plugin example as "data write (WAL) plugin"
- Update code comments for clarity and remove outdated notes
- Specify "wal_rows trigger specification" terminology

- Specify testing "process_writes (WAL) plugin" for clarity
- Reference multiple test commands, not just wal_plugin
- Add link to schedule_plugin test command
- Clarify that PLUGIN_FILENAME should be filename only

- Prevents path resolution errors users encountered
- Aligns documentation with current CLI behavior
- Improves Get Started guide readability and flow
- Reduces confusion about plugin file handling

Closes #588

* docs(influxdb3): Docker Compose optional plugin directory
- Added inline comments to Docker Compose examples: `# Optional: only
  needed for processing engine plugins`
- Appears for both `--plugin-dir` flag and volume mount
- Helps users understand they can skip this if not using plugins
- Better progressive disclosure - users see it's optional without
  needing separate explanation

* docs(influxdb3): Replace --plugin-filename with --path
- Uses `--path` for plugins, replacing deprecated `--plugin-filename`
- Replaces "Data write" with "WAL rows" to be consistent with CLI help
  docs

* Update content/shared/influxdb3-get-started/processing-engine.md

* fix(deps): add missing yarn.lock updates for puppeteer

The puppeteer dependency was added to package.json in commit 784956a31
but yarn.lock was not updated, causing CI failures with --frozen-lockfile.

* chore(deps): upgrade puppeteer to 24.35.0

- Upgrade puppeteer from 23.11.1 to 24.35.0
- Fix deprecated page.waitForTimeout() - replaced with Promise/setTimeout
- Fix deprecated headless: 'new' - now just uses headless boolean

The 'new' headless mode is now the default in Puppeteer 24.
2026-01-14 18:17:14 -06:00
Jameelah Mercer f1dc112f43
Update content/shared/influxdb3-get-started/processing-engine.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-10-17 10:40:45 -07:00
meelahme eef29546d7 fix(influxdb3): add python directory requirement note to plugins setup 2025-10-16 12:02:37 -07: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 feea4b8df2 fix(plugins): Missing descriptor. Cleanup. 2025-06-30 13:54:30 -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 29a81be296 fix(influxdb3): Get started fixes 2025-06-24 10:21:32 -05:00
Jason Stirnaman 9ddc14a06b fix(influxdb3): Case 2025-06-23 16:27:25 -05:00
Jason Stirnaman 7df48daeda fix(influxdb3): links 2025-06-23 16:27:25 -05:00
Jason Stirnaman c3fe264766 chore(influxdb3): Add next steps, cleanup 2025-06-23 16:27:24 -05:00
Scott Anderson 5611da76e6 WIP monolith get started, enterprise multi-node, file index docs 2025-06-23 15:45:11 -05:00
Scott Anderson c3b5458314 WIP monolith getting started restructure 2025-06-23 15:34:14 -05:00
Scott Anderson 4d22388bd9 WIP monolith get started, enterprise multi-node, file index docs 2025-06-17 17:12:42 -06:00
Scott Anderson 5ca0391a5e WIP monolith getting started restructure 2025-06-05 16:11:42 -06:00