Enterprise multi-node recommendations and Python libraries update #6107
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…data/docs-v2 into docs/generalize-grafana-multinode
MeelahMe
requested review from
Copilot,
peterbarnett03 and
jstirnaman
and removed request for
peterbarnett03
There was a problem hiding this comment.
Pull Request Overview
This PR refines documentation for plugin development and deployment and updates the JS config for module resolution.
- Overhauls Python dependency installation instructions with embedded environment guidance and CLI/Docker examples.
- Introduces distributed cluster considerations, mapping plugin triggers to node roles and routing client traffic.
- Simplifies
jsconfig.jsonby removingnode_modulesfrom thepathsmapping.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| content/shared/v3-core-plugins/_index.md | Expanded and clarified docs for Python package installation and multi-node deployment |
| assets/jsconfig.json | Removed ../node_modules/* from paths to streamline module resolution |
Comments suppressed due to low confidence (2)
content/shared/v3-core-plugins/_index.md:564
- This description refers to creating a Python virtual environment, but the embedded environment is managed by the Processing Engine. Update this line to clarify that
influxdb3 install packageplaces dependencies into the engine’s embedded environment.
This creates a Python virtual environment in your plugins directory with the specified packages installed.
assets/jsconfig.json:6
- Removing
"../node_modules/*"from thepathsmay prevent the IDE or build from resolving modules innode_modules. Verify this change doesn’t break local development or consider documenting the new resolution behavior.
*
| | HTTP request | `path:` | Nodes that serve API traffic| | ||
|
|
||
| For example: | ||
| - Run write-ahead log (WAL) plugins on ingester nodes. |
There was a problem hiding this comment.
[nitpick] The example mentions WAL plugins but the trigger types table lists only data write, scheduled, and HTTP request triggers. Consider aligning the example with the table or explaining how WAL plugins map to the data write category.
Copilot uses AI. Check for mistakes.
jstirnaman
requested changes
May 29, 2025
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
…data/docs-v2 into docs/generalize-grafana-multinode
jstirnaman
requested changes
Jun 2, 2025
| - Use the Docker variant if you're running InfluxDB in a containerized environment. | ||
|
|
||
| > [!Note] | ||
| > If you create a custom virtual environment, use the Python interpreter bundled with InfluxDB 3—not system Python. |
There was a problem hiding this comment.
Suggested change
| > If you create a custom virtual environment, use the Python interpreter bundled with InfluxDB 3—not system Python. | |
| > #### Use bundled Python for plugins | |
| > When you start the server with the `--plugin-dir` option, InfluxDB 3 creates a Python virtual environment (`<PLUGIN_DIR>/venv`) for your plugins. | |
| > If you need to create a custom virtual environment, use the Python interpreter bundled with InfluxDB 3—not the system Python. |
| > If you create a custom virtual environment, use the Python interpreter bundled with InfluxDB 3—not system Python. | ||
| > Creating a virtual environment with system Python (for example, using `python -m venv`) can lead to runtime errors and plugin failures. | ||
| > | ||
| >F or details, see the [Process Engine README](https://github.com/influxdata/influxdb/blob/main/README_processing_engine.md#official-builds) |
There was a problem hiding this comment.
Suggested change
| >F or details, see the [Process Engine README](https://github.com/influxdata/influxdb/blob/main/README_processing_engine.md#official-builds) | |
| >For more information, see the [processing engine README](https://github.com/influxdata/influxdb/blob/main/README_processing_engine.md#official-builds). |
| > Creating a virtual environment with system Python (for example, using `python -m venv`) can lead to runtime errors and plugin failures. | ||
| > | ||
| >F or details, see the [Process Engine README](https://github.com/influxdata/influxdb/blob/main/README_processing_engine.md#official-builds) | ||
| > for advanced setup instructions. |
There was a problem hiding this comment.
Suggested change
| > for advanced setup instructions. |
| - Use the CLI command when running InfluxDB directly on your system. | ||
| - Use the Docker variant if you're running InfluxDB in a containerized environment. | ||
|
|
||
| > [!Note] |
There was a problem hiding this comment.
Suggested change
| > [!Note] | |
| > [!Important] |
|
|
||
| > [!Note] | ||
| > If you create a custom virtual environment, use the Python interpreter bundled with InfluxDB 3—not system Python. | ||
| > Creating a virtual environment with system Python (for example, using `python -m venv`) can lead to runtime errors and plugin failures. |
There was a problem hiding this comment.
Suggested change
| > Creating a virtual environment with system Python (for example, using `python -m venv`) can lead to runtime errors and plugin failures. | |
| > Creating a virtual environment with the system Python (for example, using `python -m venv`) can lead to runtime errors and plugin failures. |
| > for advanced setup instructions. | ||
|
|
||
| {{% /code-placeholders %}} | ||
|
|
||
| This creates a Python virtual environment in your plugins directory with the specified packages installed. |
There was a problem hiding this comment.
Suggested change
| This creates a Python virtual environment in your plugins directory with the specified packages installed. | |
| InfluxDB creates a Python virtual environment in your plugins directory with the specified packages installed. |
|
|
||
| When configuring Grafana to connect to an InfluxDB 3 Enterprise instance: | ||
| #### Examples: |
There was a problem hiding this comment.
Suggested change
| #### Examples: | |
| #### Examples |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…ly deployments
Closes #6053