Commit Graph

10 Commits (api-docs-uplift)

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 e8d6d8b77a
Add Invocation metric to telemetry documentation (#6566)
* Initial plan

* Add Invocation metric to telemetry documentation

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

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
2025-11-24 13:17:46 -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
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 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
Jason Stirnaman 89f5f18137 chore(influxdb3): Reconcile shared glossary page with Serverless 2025-04-15 15:16:35 -05:00
Jason Stirnaman ab3d20f81f chore(influxdb3): Glossary: improve Processing engine definitions, merge improvements from Clustered 2025-04-15 14:41:43 -05:00
Jason Stirnaman a79e4cf02a
Update content/shared/influxdb3-reference/glossary.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-04-15 13:56:24 -05:00
Jason Stirnaman 4c7c19baaf chore(influxdb3): shared glossary suitable for all InfluxDB 3 versions. Currently, only using for Enterprise and Core 2025-04-15 12:07:18 -05:00
Jason Stirnaman 3e08da9d61 chore(reference): Initial commit of shared glossary copied from Cloud Dedicated 2025-04-15 10:17:26 -05:00