feat(influxdb3): describe use cases and effects of --package-manager disabled
parent
b86c391a34
commit
187d888c7b
File diff suppressed because it is too large
Load Diff
|
|
@ -15,12 +15,12 @@ influxdb3 install package [OPTIONS] [PACKAGES]...
|
||||||
|
|
||||||
| Option | Description | Default | Environment Variable |
|
| Option | Description | Default | Environment Variable |
|
||||||
| :---------------------------------------------- | :------------------------------------------------------------------ | :---------------------- | :-------------------------- |
|
| :---------------------------------------------- | :------------------------------------------------------------------ | :---------------------- | :-------------------------- |
|
||||||
| `-H`, `--host <HOST_URL>` | The host url of the running {{< product-name >}} server | `http://127.0.0.1:8181` | `INFLUXDB3_HOST_URL` |
|
| `-H`, `--host <HOST_URL>` | The host URL of the running {{< product-name >}} server | `http://127.0.0.1:8181` | `INFLUXDB3_HOST_URL` |
|
||||||
| `--token <AUTH_TOKEN>` | The token for authentication with the {{< product-name >}} server | | `INFLUXDB3_AUTH_TOKEN` |
|
| `--token <AUTH_TOKEN>` | The token for authentication with the {{< product-name >}} server | | `INFLUXDB3_AUTH_TOKEN` |
|
||||||
| `--plugin-dir <PLUGIN_DIR>` | Location of the plugins directory | `/plugins` | `INFLUXDB3_PLUGIN_DIR` |
|
| `--plugin-dir <PLUGIN_DIR>` | Location of the plugins directory | `/plugins` | `INFLUXDB3_PLUGIN_DIR` |
|
||||||
| `--virtual-env-location <VIRTUAL_ENV_LOCATION>` | Custom virtual environment location | | `VIRTUAL_ENV` |
|
| `--virtual-env-location <VIRTUAL_ENV_LOCATION>` | Custom virtual environment location | | `VIRTUAL_ENV` |
|
||||||
| `--package-manager <PACKAGE_MANAGER>` | Package manager to use: `discover`, `pip`, `uv`, or `disabled` | `discover` | `INFLUXDB3_PACKAGE_MANAGER` |
|
| `--package-manager <PACKAGE_MANAGER>` | Package manager to use: `discover`, `pip`, `uv`, or `disabled` | `discover` | `INFLUXDB3_PACKAGE_MANAGER` |
|
||||||
| `--plugin-repo <PLUGIN_REPO>` | Plugin repository url | | `INFLUXDB3_PLUGIN_REPO` |
|
| `--plugin-repo <PLUGIN_REPO>` | Plugin repository URL | | `INFLUXDB3_PLUGIN_REPO` |
|
||||||
| `-r`, `--requirements <REQUIREMENTS>` | Path to a `requirements.txt` file | | |
|
| `-r`, `--requirements <REQUIREMENTS>` | Path to a `requirements.txt` file | | |
|
||||||
| `--tls-ca <CA_CERT>` | Custom CA certificate for TLS (useful for self-signed certificates) | | `INFLUXDB3_TLS_CA` |
|
| `--tls-ca <CA_CERT>` | Custom CA certificate for TLS (useful for self-signed certificates) | | `INFLUXDB3_TLS_CA` |
|
||||||
| `-h`, `--help` | Print help information | | |
|
| `-h`, `--help` | Print help information | | |
|
||||||
|
|
@ -89,16 +89,39 @@ By default (`--package-manager discover`), the CLI automatically detects and use
|
||||||
The CLI manages a virtual environment for plugin packages to avoid conflicts with system Python packages.
|
The CLI manages a virtual environment for plugin packages to avoid conflicts with system Python packages.
|
||||||
You can customize the virtual environment location with `--virtual-env-location` or the `VIRTUAL_ENV` environment variable.
|
You can customize the virtual environment location with `--virtual-env-location` or the `VIRTUAL_ENV` environment variable.
|
||||||
|
|
||||||
|
### Security mode
|
||||||
|
|
||||||
|
If your {{< product-name >}} server was started with [`--package-manager disabled`](/influxdb3/version/reference/config-options/#package-manager), the `influxdb3 install package` command is blocked for security and compliance requirements.
|
||||||
|
|
||||||
|
When attempting to install packages with this command while the server has package installation disabled, the command fails with a `403 Forbidden` error:
|
||||||
|
|
||||||
|
```
|
||||||
|
Package installation has been disabled. Contact your administrator for more information.
|
||||||
|
```
|
||||||
|
|
||||||
|
The server's `--package-manager disabled` setting is designed for:
|
||||||
|
|
||||||
|
- **Enterprise security requirements**: Prevent arbitrary package installation
|
||||||
|
- **Compliance environments**: Control exactly which packages are available
|
||||||
|
- **Air-gapped deployments**: Pre-install all dependencies before deployment
|
||||||
|
- **Multi-tenant scenarios**: Prevent tenants from installing potentially malicious packages
|
||||||
|
|
||||||
|
In these environments, administrators must pre-install all required Python packages into the server's virtual environment before starting {{< product-name >}}.
|
||||||
|
|
||||||
|
For more information, see the [`package-manager`](/influxdb3/version/reference/config-options/#package-manager) configuration option.
|
||||||
|
|
||||||
### Troubleshooting
|
### Troubleshooting
|
||||||
|
|
||||||
If package installation fails:
|
If package installation fails:
|
||||||
|
|
||||||
1. **Verify network connectivity**: Ensure your {{< product-name >}} instance can reach PyPI or your custom package repository
|
- **Check if package installation is disabled**: If you receive a `403 Forbidden` error, contact your administrator. Package installation may be disabled on your {{< product-name >}} instance.
|
||||||
2. **Check package names**: Verify package names are correct and available in the package repository
|
- **Verify network connectivity**: Ensure your {{< product-name >}} instance can reach PyPI or your custom package repository
|
||||||
3. **Review logs**: Check {{< product-name >}} server logs for detailed error messages
|
- **Check package names**: Verify package names are correct and available in the package repository
|
||||||
4. **Test with pip**: Try installing the package directly with `pip` to verify it's available
|
- **Review logs**: Check {{< product-name >}} server logs for detailed error messages
|
||||||
5. **Use requirements file**: For complex dependencies, use a `requirements.txt` file with version pinning
|
- **Test with pip**: Try installing the package directly with `pip` to verify it's available
|
||||||
6. **Check Docker disk space** (Docker environments only): If running {{< product-name >}} in Docker and seeing "No space left on device" errors, free up disk space:
|
- **Use requirements file**: For complex dependencies, use a `requirements.txt` file with version pinning
|
||||||
|
- **Check Docker disk space** (Docker environments only): If running {{< product-name >}} in Docker and seeing "No space left on device" errors, free up disk space:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Check Docker disk usage
|
# Check Docker disk usage
|
||||||
docker system df
|
docker system df
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue