Merge branch 'master' into feature/cloud-dedicated-user-management-docs
commit
98d0f29ef9
|
|
@ -48,23 +48,35 @@ Descriptions should follow consistent patterns:
|
||||||
|
|
||||||
## Hugo shortcodes in Markdown
|
## Hugo shortcodes in Markdown
|
||||||
|
|
||||||
- `{{% code-placeholders "PLACEHOLDER1|PLACEHOLDER2" %}}`: Use this shortcode to define placeholders in code snippets.
|
**Syntax**:
|
||||||
- `{{% /code-placeholders %}}`: End the shortcode.
|
|
||||||
- `{{% code-placeholder-key %}}`: Use this shortcode to define a specific placeholder key.
|
- Use the `placeholders` code block attribute to define placeholder patterns:
|
||||||
- `{{% /code-placeholder-key %}}`: End the specific placeholder key shortcode.
|
```<language> { placeholders="<expr>" }
|
||||||
|
function sampleCode () {};
|
||||||
|
```
|
||||||
|
**Old (deprecated) syntax**:
|
||||||
|
|
||||||
|
- `{{% code-placeholders "PLACEHOLDER1|PLACEHOLDER2" %}}`
|
||||||
|
- `{{% /code-placeholders %}}`
|
||||||
|
|
||||||
|
**Define a placeholder key (typically following the example)**:
|
||||||
|
|
||||||
|
- `{{% code-placeholder-key %}}`: Use this shortcode to define a placeholder key
|
||||||
|
- `{{% /code-placeholder-key %}}`: Use this shortcode to close the key name
|
||||||
|
- Follow with a description
|
||||||
|
|
||||||
## Language-Specific Placeholder Formatting
|
## Language-Specific Placeholder Formatting
|
||||||
|
|
||||||
- **Bash/Shell**: Use uppercase variables with no quotes or prefix
|
- **Bash/Shell**: Use uppercase variables with no quotes or prefix
|
||||||
```bash
|
```bash { placeholders="DATABASE_NAME" }
|
||||||
--database DATABASE_NAME
|
--database DATABASE_NAME
|
||||||
```
|
```
|
||||||
- Python: Use string literals with quotes
|
- Python: Use string literals with quotes
|
||||||
```python
|
```python { placeholders="DATABASE_NAME" }
|
||||||
database_name='DATABASE_NAME'
|
database_name='DATABASE_NAME'
|
||||||
```
|
```
|
||||||
- JSON: Use key-value pairs with quotes
|
- JSON: Use key-value pairs with quotes
|
||||||
```json
|
```json { placeholders="DATABASE_NAME" }
|
||||||
{
|
{
|
||||||
"database": "DATABASE_NAME"
|
"database": "DATABASE_NAME"
|
||||||
}
|
}
|
||||||
|
|
@ -75,8 +87,7 @@ Descriptions should follow consistent patterns:
|
||||||
### InfluxDB CLI Commands
|
### InfluxDB CLI Commands
|
||||||
This pattern appears frequently in CLI documentation:
|
This pattern appears frequently in CLI documentation:
|
||||||
|
|
||||||
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}
|
```bash { placeholders="DATABASE_NAME|AUTH_TOKEN" }
|
||||||
```bash
|
|
||||||
influxdb3 write \
|
influxdb3 write \
|
||||||
--database DATABASE_NAME \
|
--database DATABASE_NAME \
|
||||||
--token AUTH_TOKEN \
|
--token AUTH_TOKEN \
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
---
|
||||||
|
title: influxdb3 install
|
||||||
|
description: >
|
||||||
|
The `influxdb3 install` command and its subcommands manage package installations for the InfluxDB 3 processing engine.
|
||||||
|
menu:
|
||||||
|
influxdb3_core:
|
||||||
|
parent: influxdb3
|
||||||
|
name: influxdb3 install
|
||||||
|
weight: 300
|
||||||
|
source: /shared/influxdb3-cli/install/_index.md
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
//SOURCE - content/shared/influxdb3-cli/install/_index.md
|
||||||
|
-->
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
---
|
||||||
|
title: influxdb3 install package
|
||||||
|
description: >
|
||||||
|
The `influxdb3 install package` command installs Python packages for use in InfluxDB 3 processing engine plugins.
|
||||||
|
influxdb3/core/tags: [cli, processing engine, plugins]
|
||||||
|
menu:
|
||||||
|
influxdb3_core:
|
||||||
|
name: influxdb3 install package
|
||||||
|
parent: influxdb3 install
|
||||||
|
weight: 201
|
||||||
|
related:
|
||||||
|
- /influxdb3/core/process/
|
||||||
|
- /influxdb3/core/plugins/
|
||||||
|
source: /shared/influxdb3-cli/install/package.md
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
//SOURCE - content/shared/influxdb3-cli/install/package.md
|
||||||
|
-->
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
---
|
||||||
|
title: influxdb3 install
|
||||||
|
description: >
|
||||||
|
The `influxdb3 install` command and its subcommands manage package installations for the InfluxDB 3 processing engine.
|
||||||
|
menu:
|
||||||
|
influxdb3_enterprise:
|
||||||
|
parent: influxdb3
|
||||||
|
name: influxdb3 install
|
||||||
|
weight: 300
|
||||||
|
source: /shared/influxdb3-cli/install/_index.md
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
//SOURCE - content/shared/influxdb3-cli/install/_index.md
|
||||||
|
-->
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
---
|
||||||
|
title: influxdb3 install package
|
||||||
|
description: >
|
||||||
|
The `influxdb3 install package` command installs Python packages for use in InfluxDB 3 processing engine plugins.
|
||||||
|
influxdb3/enterprise/tags: [cli, processing engine, plugins]
|
||||||
|
menu:
|
||||||
|
influxdb3_enterprise:
|
||||||
|
name: influxdb3 install package
|
||||||
|
parent: influxdb3 install
|
||||||
|
weight: 201
|
||||||
|
related:
|
||||||
|
- /influxdb3/enterprise/process/
|
||||||
|
- /influxdb3/enterprise/plugins/
|
||||||
|
source: /shared/influxdb3-cli/install/package.md
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
//SOURCE - content/shared/influxdb3-cli/install/package.md
|
||||||
|
-->
|
||||||
|
|
@ -47,6 +47,7 @@ influxdb3 serve
|
||||||
{{% show-in "enterprise" %}} - [node-id-from-env](#node-id-from-env){{% /show-in %}}
|
{{% show-in "enterprise" %}} - [node-id-from-env](#node-id-from-env){{% /show-in %}}
|
||||||
- [object-store](#object-store)
|
- [object-store](#object-store)
|
||||||
{{% show-in "enterprise" %}}
|
{{% show-in "enterprise" %}}
|
||||||
|
- [num-cores](#num-cores)
|
||||||
- [num-database-limit](#num-database-limit)
|
- [num-database-limit](#num-database-limit)
|
||||||
- [num-table-limit](#num-table-limit)
|
- [num-table-limit](#num-table-limit)
|
||||||
- [num-total-columns-per-table-limit](#num-total-columns-per-table-limit)
|
- [num-total-columns-per-table-limit](#num-total-columns-per-table-limit)
|
||||||
|
|
@ -297,6 +298,23 @@ This option supports the following values:
|
||||||
{{% show-in "enterprise" %}}
|
{{% show-in "enterprise" %}}
|
||||||
---
|
---
|
||||||
|
|
||||||
|
#### num-cores
|
||||||
|
|
||||||
|
Limits the total number of CPU cores that can be used by the server.
|
||||||
|
Default is determined by your {{% product-name %}} license:
|
||||||
|
|
||||||
|
- **Trial**: up to 256 cores
|
||||||
|
- **At-Home**: 2 cores
|
||||||
|
- **Commercial**: per contract
|
||||||
|
|
||||||
|
| influxdb3 serve option | Environment variable |
|
||||||
|
| :--------------------- | :--------------------------------- |
|
||||||
|
| `--num-cores` | `INFLUXDB3_ENTERPRISE_NUM_CORES` |
|
||||||
|
|
||||||
|
For more information about licensing, see [Manage license](/influxdb3/enterprise/admin/license).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
#### num-database-limit
|
#### num-database-limit
|
||||||
|
|
||||||
Limits the total number of active databases.
|
Limits the total number of active databases.
|
||||||
|
|
@ -1380,9 +1398,11 @@ Determines whether WAL replay should fail when encountering errors.
|
||||||
|
|
||||||
#### wal-replay-concurrency-limit
|
#### wal-replay-concurrency-limit
|
||||||
|
|
||||||
Sets the maximum number of concurrent WAL replay operations.
|
Concurrency limit during WAL replay.
|
||||||
|
Setting this number too high can lead to OOM.
|
||||||
|
The default is dynamically determined.
|
||||||
|
|
||||||
**Default:** `16`
|
**Default:** `max(num_cpus, 10)`
|
||||||
|
|
||||||
| influxdb3 serve option | Environment variable |
|
| influxdb3 serve option | Environment variable |
|
||||||
| :--------------------------------- | :------------------------------------------ |
|
| :--------------------------------- | :------------------------------------------ |
|
||||||
|
|
@ -1891,9 +1911,10 @@ Specifies how far back to look when creating generation 1 Parquet files.
|
||||||
|
|
||||||
#### retention-check-interval
|
#### retention-check-interval
|
||||||
|
|
||||||
Defines how often the system checks for data that should be deleted according to retention policies.
|
The interval at which retention policies are checked and enforced.
|
||||||
|
Enter as a human-readable time--for example: `30m` or `1h`.
|
||||||
|
|
||||||
**Default:** `1h`
|
**Default:** `30m`
|
||||||
|
|
||||||
| influxdb3 serve option | Environment variable |
|
| influxdb3 serve option | Environment variable |
|
||||||
| :----------------------------- | :--------------------------------------- |
|
| :----------------------------- | :--------------------------------------- |
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,7 @@ influxdb3 create trigger [OPTIONS] \
|
||||||
| | `--disabled` | Create the trigger in disabled state |
|
| | `--disabled` | Create the trigger in disabled state |
|
||||||
| | `--error-behavior` | Error handling behavior: `log`, `retry`, or `disable` |
|
| | `--error-behavior` | Error handling behavior: `log`, `retry`, or `disable` |
|
||||||
| | `--run-asynchronous` | Run the trigger asynchronously, allowing multiple triggers to run simultaneously (default is synchronous) |
|
| | `--run-asynchronous` | Run the trigger asynchronously, allowing multiple triggers to run simultaneously (default is synchronous) |
|
||||||
|
{{% show-in "enterprise" %}}| | `--node-spec` | Which node(s) the trigger should be configured on. Two value formats are supported: `all` (default) - applies to all nodes, or `nodes:<node-id>[,<node-id>..]` - applies only to specified comma-separated list of nodes |{{% /show-in %}}
|
||||||
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
|
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
|
||||||
| `-h` | `--help` | Print help information |
|
| `-h` | `--help` | Print help information |
|
||||||
| | `--help-all` | Print detailed help information |
|
| | `--help-all` | Print detailed help information |
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
The `influxdb3 install` command includes the following subcommands:
|
||||||
|
|
||||||
|
| Subcommand | Description |
|
||||||
|
|:----------|:------------|
|
||||||
|
| [`package`](/influxdb3/version/reference/cli/influxdb3/install/package/) | Install Python packages for processing engine plugins |
|
||||||
|
|
@ -0,0 +1,54 @@
|
||||||
|
The `influxdb3 install package` command installs Python packages for use in [InfluxDB 3 processing engine plugins](/influxdb3/version/process/).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```bash { placeholders="PACKAGE_NAME" }
|
||||||
|
influxdb3 install package --packages PACKAGE_NAME
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace the following:
|
||||||
|
|
||||||
|
- {{% code-placeholder-key %}}`PACKAGE_NAME`{{% /code-placeholder-key %}}: the name of the Python package to install
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
| Option | Description | Default | Environment | Required |
|
||||||
|
|--------|-------------|---------|-------------|----------|
|
||||||
|
| `--packages` | Python package names to install (comma-separated) | | | |
|
||||||
|
| `-r`, `--requirements` | Path to requirements.txt file | | | |
|
||||||
|
| `-H`, `--host` | Host URL of the running {{< product-name >}} server | `http://127.0.0.1:8181` | `INFLUXDB3_HOST_URL` | |
|
||||||
|
| `--token` | The token for authentication with the InfluxDB 3 server | | `INFLUXDB3_AUTH_TOKEN` | |
|
||||||
|
| `--tls-ca` | Path to a custom TLS certificate authority for testing with self-signed certificates | | `INFLUXDB3_TLS_CA` | |
|
||||||
|
| `--plugin-dir` | Location of the plugins directory | | `INFLUXDB3_PLUGIN_DIR` | |
|
||||||
|
| `--virtual-env-location` | Location of the Python virtual environment | | `VIRTUAL_ENV` | |
|
||||||
|
| `--package-manager` | Package manager to use for installing packages | `discover` | | |
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Install a single package
|
||||||
|
|
||||||
|
```bash { placeholders="pandas" }
|
||||||
|
influxdb3 install package --packages pandas
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install multiple packages
|
||||||
|
|
||||||
|
```bash
|
||||||
|
influxdb3 install package --packages pandas,numpy,scipy
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install packages from requirements file
|
||||||
|
|
||||||
|
```bash
|
||||||
|
influxdb3 install package -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
### Install with authentication
|
||||||
|
|
||||||
|
```bash { placeholders="AUTH_TOKEN|pandas" }
|
||||||
|
influxdb3 install package --token AUTH_TOKEN --packages pandas
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace the following:
|
||||||
|
|
||||||
|
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link "admin" %}} for your {{< product-name >}} instance
|
||||||
|
|
@ -6051,14 +6051,14 @@ for details about the mapping.
|
||||||
|
|
||||||
### New input data formats (parsers)
|
### New input data formats (parsers)
|
||||||
|
|
||||||
- [csv](https://archive.docs.influxdata.com/telegraf/v1/data_formats/input/csv) - Contributed by @maxunt
|
- [csv](https://docs.influxdata.com/telegraf/v1/data_formats/input/csv/) - Contributed by @maxunt
|
||||||
- [grok](https://archive.docs.influxdata.com/telegraf/v1/data_formats/input/grok/) - Contributed by @maxunt
|
- [grok](https://docs.influxdata.com/telegraf/v1/data_formats/input/grok/) - Contributed by @maxunt
|
||||||
- [logfmt](https://archive.docs.influxdata.com/telegraf/v1/data_formats/input/logfmt/) - Contributed by @Ayrdrie & @maxunt
|
- [logfmt](https://docs.influxdata.com/telegraf/v1/data_formats/input/logfmt/) - Contributed by @Ayrdrie & @maxunt
|
||||||
- [wavefront](https://archive.docs.influxdata.com/telegraf/v1/data_formats/input/wavefront/) - Contributed by @puckpuck
|
- [wavefront](https://docs.influxdata.com/telegraf/v1/data_formats/input/wavefront/) - Contributed by @puckpuck
|
||||||
|
|
||||||
### New output data formats (serializers)
|
### New output data formats (serializers)
|
||||||
|
|
||||||
- [splunkmetric](https://archive.docs.influxdata.com/telegraf/v1/data_formats/output/splunkmetric/) - Contributed by @ronnocol
|
- [splunkmetric](https://docs.influxdata.com/telegraf/v1/data_formats/output/splunkmetric/) - Contributed by @ronnocol
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
|
|
@ -6839,7 +6839,7 @@ These plugins will replace [udp_listener](https://github.com/influxdata/telegraf
|
||||||
- Add [DMCache input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/dmcache).
|
- Add [DMCache input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/dmcache).
|
||||||
- Add support for precision in [HTTP Listener input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/http_listener).
|
- Add support for precision in [HTTP Listener input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/http_listener).
|
||||||
- Add `message_len_max` option to the [Kafka consumer input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/kafka_consumer).
|
- Add `message_len_max` option to the [Kafka consumer input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/kafka_consumer).
|
||||||
- Add [collectd parser](https://archive.docs.influxdata.com/telegraf/v1/concepts/data_formats_input/#collectd).
|
- Add [collectd parser](https://docs.influxdata.com/telegraf/v1/data_formats/input/collectd/).
|
||||||
- Simplify plugin testing without outputs.
|
- Simplify plugin testing without outputs.
|
||||||
- Check signature in the [GitHub webhook input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/webhooks/github).
|
- Check signature in the [GitHub webhook input plugin](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/webhooks/github).
|
||||||
- Add [papertrail](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/webhooks/papertrail) support to webhooks.
|
- Add [papertrail](https://github.com/influxdata/telegraf/tree/release-1.8/plugins/inputs/webhooks/papertrail) support to webhooks.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue