Skip to content

Commit 8897471

Browse files
committed
docs(enterprise): scope distributed cluster guidance to Enterprise-only deployments
1 parent 50ba67a commit 8897471

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

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

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -522,11 +522,12 @@ influxdb3 create trigger \
522522

523523
### Install Python dependencies
524524

525-
If your plugin needs additional Python packages, use the `influxdb3 install` command:
525+
If your plugin requires additional Python packages, install them using the CLI:
526526

527527
```bash
528528
# Install a package directly
529529
influxdb3 install package pandas
530+
530531
```
531532

532533
```bash
@@ -538,11 +539,38 @@ This creates a Python virtual environment in your plugins directory with the spe
538539

539540
{{% show-in "enterprise" %}}
540541

541-
### Connect Grafana to your InfluxDB instance
542+
## Distributed cluster considerations
543+
544+
When you deploy {{% product-name %}} in a multi-node environment, configure each node based on its role and the plugins it runs.
545+
546+
### Match plugin types to the correct node
547+
548+
Each plugin must run on a node that supports its trigger type:
549+
550+
| Plugin type | Trigger spec | Runs on |
551+
|--------------------|--------------------------|-----------------------------|
552+
| Data write | `table:` or `all_tables` | Ingester nodes |
553+
| Scheduled | `every:` or `cron:` | Any node with scheduler |
554+
| HTTP request | `path:` | Nodes that serve API traffic|
555+
556+
For example:
557+
- Run write-ahead log (WAL) plugins on ingester nodes.
558+
- Run scheduled plugins on any node configured to execute them.
559+
- Run HTTP-triggered plugins on querier nodes or any node that handles HTTP endpoints.
560+
561+
Place all plugin files in the `--plugin-dir` directory configured for each node.
562+
563+
> [!Note]
564+
> Triggers fail if the plugin file isn’t available on the node where it runs.
565+
566+
### Route third-party clients to querier nodes
567+
568+
External tools—such as Grafana, custom dashboards, or REST clients—must connect to querier nodes in your InfluxDB Enterprise deployment.
542569

543-
When configuring Grafana to connect to an InfluxDB 3 Enterprise instance:
570+
#### Examples:
544571

545-
- **URL**: Use a querier URL or any node that serves queries
572+
- **Grafana**: When adding InfluxDB 3 as a Grafana data source, use a querier node URL, such as:
573+
https://querier.example.com:8086
574+
- **REST clients**: Applications using POST /api/v3/query/sql or similar endpoints must target a querier node.
546575

547-
Example URL format: `https://querier.your-influxdb.com:8086`
548576
{{% /show-in %}}

0 commit comments

Comments
 (0)