Skip to content

Commit 2a4781a

Browse files
authored
Merge pull request #5940 from influxdata/docs/v3/processing-engine
Clarifying usage of the Python Processing Engine across instances
2 parents 62bd81d + 0104827 commit 2a4781a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

content/shared/v3-core-plugins/_index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,28 @@ influxdb3 serve \
3636
--plugin-dir /path/to/plugins
3737
```
3838

39+
Replace `/path/to/plugins` with the directory where you want to store your Python plugin files. All plugin files must be located in this directory or its subdirectories.
40+
41+
42+
43+
### Configure distributed environments
44+
45+
If you're running multiple {{% product-name %}} instances (distributed deployment):
46+
47+
1. Decide where plugins should run
48+
- Data processing plugins, such as WAL plugins, run on ingester nodes
49+
- HTTP-triggered plugins run on nodes handling API requests
50+
- Scheduled plugins can run on any configured node
51+
2. Enable plugins on selected instances
52+
3. Maintain identical plugin files across all instances where plugins run
53+
- Use shared storage or file synchronization tools to keep plugins consistent
54+
55+
> [!Note]
56+
> #### Provide plugins to nodes that run them
57+
>
58+
> Configure your plugin directory on the same system as the nodes that run the triggers and plugins.
59+
60+
3961
## Add a Processing engine plugin
4062

4163
A plugin is a Python file that contains a specific function signature that corresponds to a trigger type.
@@ -630,3 +652,13 @@ docker exec -it CONTAINER_NAME influxdb3 install package pandas
630652
```
631653

632654
This creates a Python virtual environment in your plugins directory with the specified packages installed.
655+
656+
{{% show-in "enterprise" %}}
657+
### Connect Grafana to your InfluxDB instance
658+
659+
When configuring Grafana to connect to an InfluxDB 3 Enterprise instance:
660+
661+
- **URL**: Use a querier URL or any node that serves queries
662+
663+
Example URL format: `https://querier.your-influxdb.com:8086`
664+
{{% /show-in %}}

0 commit comments

Comments
 (0)