diff --git a/content/shared/influxdb3-get-started/processing-engine.md b/content/shared/influxdb3-get-started/processing-engine.md index 009b3d4ee..954a01050 100644 --- a/content/shared/influxdb3-get-started/processing-engine.md +++ b/content/shared/influxdb3-get-started/processing-engine.md @@ -48,6 +48,9 @@ when starting the {{% product-name %}} server. `PLUGIN_DIR` is your file system location for storing [plugin](#plugin) files for the processing engine to run. +> [!Note] +> If you manually installed {{% product-name %}} from a tar archive, ensure the `influxdb3` binary and `python/` directory remain in the same parent directory. The install script handles this automatically. + {{% code-placeholders "PLUGIN_DIR" %}} ```bash diff --git a/content/shared/influxdb3-plugins/_index.md b/content/shared/influxdb3-plugins/_index.md index 14dace282..145a34bfd 100644 --- a/content/shared/influxdb3-plugins/_index.md +++ b/content/shared/influxdb3-plugins/_index.md @@ -34,6 +34,19 @@ Once you have all the prerequisites in place, follow these steps to implement th To activate the Processing Engine, start your {{% product-name %}} server with the `--plugin-dir` flag. This flag tells InfluxDB where to load your plugin files. +> [!Important] +> #### Keep the influxdb3 binary with its python directory +> +> The influxdb3 binary requires the adjacent `python/` directory to function. +> If you manually extract from tar.gz, keep them in the same parent directory: +> ``` +> your-install-location/ +> ├── influxdb3 +> └── python/ +> ``` +> +> Add the parent directory to your PATH; do not move the binary out of this directory. + {{% code-placeholders "NODE_ID|OBJECT_STORE_TYPE|PLUGIN_DIR" %}} ```bash @@ -297,7 +310,7 @@ def process_request(influxdb3_local, query_parameters, request_headers, request_ After writing your plugin: - [Create a trigger](#use-the-create-trigger-command) to connect your plugin to database events -- [Install any Python dependencies](#install-python-dependencies) your plugin requires +- [Install any Python dependencies](#manage-plugin-dependencies) your plugin requires - Learn how to [extend plugins with the API](/influxdb3/version/extend-plugin/) ## Set up a trigger @@ -578,7 +591,7 @@ These examples install the specified Python package (for example, pandas) into t > If you need to create a custom virtual environment, use the Python interpreter bundled with InfluxDB 3. Don't use the system Python. > Creating a virtual environment with the system Python (for example, using `python -m venv`) can lead to runtime errors and plugin failures. > ->For more information, see the [processing 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). {{% /code-placeholders %}}