Skip to content

Commit 5501715

Browse files
jstirnamanjstirnaman
committed
feat(influxdb3): add install package command documentation
- Create shared CLI documentation for install package command - Add Enterprise and Core frontmatter files referencing shared content - Add --node-spec option to create trigger command for Enterprise - Update code-placeholders to use new fenced code block syntax Closes influxdata/DAR#6301
1 parent 1f62fde commit 5501715

File tree

8 files changed

+148
-9
lines changed

8 files changed

+148
-9
lines changed

‎.github/instructions/influxdb3-code-placeholders.instructions.md‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,23 +48,35 @@ Descriptions should follow consistent patterns:
4848

4949
## Hugo shortcodes in Markdown
5050

51-
- `{{% code-placeholders "PLACEHOLDER1|PLACEHOLDER2" %}}`: Use this shortcode to define placeholders in code snippets.
52-
- `{{% /code-placeholders %}}`: End the shortcode.
53-
- `{{% code-placeholder-key %}}`: Use this shortcode to define a specific placeholder key.
54-
- `{{% /code-placeholder-key %}}`: End the specific placeholder key shortcode.
51+
**Syntax**:
52+
53+
- Use the `placeholders` code block attribute to define placeholder patterns:
54+
```<language> { placeholders="<expr>" }
55+
function sampleCode () {};
56+
```
57+
**Old (deprecated) syntax**:
58+
59+
- `{{% code-placeholders "PLACEHOLDER1|PLACEHOLDER2" %}}`
60+
- `{{% /code-placeholders %}}`
61+
62+
**Define a placeholder key (typically following the example)**:
63+
64+
- `{{% code-placeholder-key %}}`: Use this shortcode to define a placeholder key
65+
- `{{% /code-placeholder-key %}}`: Use this shortcode to close the key name
66+
- Follow with a description
5567

5668
## Language-Specific Placeholder Formatting
5769

5870
- **Bash/Shell**: Use uppercase variables with no quotes or prefix
59-
```bash
71+
```bash { placeholders="DATABASE_NAME" }
6072
--database DATABASE_NAME
6173
```
6274
- Python: Use string literals with quotes
63-
```python
75+
```python { placeholders="DATABASE_NAME" }
6476
database_name='DATABASE_NAME'
6577
```
6678
- JSON: Use key-value pairs with quotes
67-
```json
79+
```json { placeholders="DATABASE_NAME" }
6880
{
6981
"database": "DATABASE_NAME"
7082
}
@@ -75,8 +87,7 @@ Descriptions should follow consistent patterns:
7587
### InfluxDB CLI Commands
7688
This pattern appears frequently in CLI documentation:
7789

78-
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}
79-
```bash
90+
```bash { placeholders="DATABASE_NAME|AUTH_TOKEN" }
8091
influxdb3 write \
8192
--database DATABASE_NAME \
8293
--token AUTH_TOKEN \

‎content/influxdb3/core/reference/cli/influxdb3/install/_index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 install
3+
description: >
4+
The `influxdb3 install` command and its subcommands manage package installations for the InfluxDB 3 processing engine.
5+
menu:
6+
influxdb3_core:
7+
parent: influxdb3
8+
name: influxdb3 install
9+
weight: 300
10+
source: /shared/influxdb3-cli/install/_index.md
11+
---
12+
13+
<!--
14+
//SOURCE - content/shared/influxdb3-cli/install/_index.md
15+
-->

‎content/influxdb3/core/reference/cli/influxdb3/install/package.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: influxdb3 install package
3+
description: >
4+
The `influxdb3 install package` command installs Python packages for use in InfluxDB 3 processing engine plugins.
5+
influxdb3/core/tags: [cli, processing engine, plugins]
6+
menu:
7+
influxdb3_core:
8+
name: influxdb3 install package
9+
parent: influxdb3 install
10+
weight: 201
11+
related:
12+
- /influxdb3/core/process/
13+
- /influxdb3/core/plugins/
14+
source: /shared/influxdb3-cli/install/package.md
15+
---
16+
17+
<!--
18+
//SOURCE - content/shared/influxdb3-cli/install/package.md
19+
-->

‎content/influxdb3/enterprise/reference/cli/influxdb3/install/_index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 install
3+
description: >
4+
The `influxdb3 install` command and its subcommands manage package installations for the InfluxDB 3 processing engine.
5+
menu:
6+
influxdb3_enterprise:
7+
parent: influxdb3
8+
name: influxdb3 install
9+
weight: 300
10+
source: /shared/influxdb3-cli/install/_index.md
11+
---
12+
13+
<!--
14+
//SOURCE - content/shared/influxdb3-cli/install/_index.md
15+
-->

‎content/influxdb3/enterprise/reference/cli/influxdb3/install/package.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: influxdb3 install package
3+
description: >
4+
The `influxdb3 install package` command installs Python packages for use in InfluxDB 3 processing engine plugins.
5+
influxdb3/enterprise/tags: [cli, processing engine, plugins]
6+
menu:
7+
influxdb3_enterprise:
8+
name: influxdb3 install package
9+
parent: influxdb3 install
10+
weight: 201
11+
related:
12+
- /influxdb3/enterprise/process/
13+
- /influxdb3/enterprise/plugins/
14+
source: /shared/influxdb3-cli/install/package.md
15+
---
16+
17+
<!--
18+
//SOURCE - content/shared/influxdb3-cli/install/package.md
19+
-->

‎content/shared/influxdb3-cli/create/trigger.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ influxdb3 create trigger [OPTIONS] \
3232
| | `--disabled` | Create the trigger in disabled state |
3333
| | `--error-behavior` | Error handling behavior: `log`, `retry`, or `disable` |
3434
| | `--run-asynchronous` | Run the trigger asynchronously, allowing multiple triggers to run simultaneously (default is synchronous) |
35+
{{% 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 %}}
3536
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
3637
| `-h` | `--help` | Print help information |
3738
| | `--help-all` | Print detailed help information |

‎content/shared/influxdb3-cli/install/_index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
The `influxdb3 install` command includes the following subcommands:
2+
3+
| Subcommand | Description |
4+
|:----------|:------------|
5+
| [`package`](/influxdb3/version/reference/cli/influxdb3/install/package/) | Install Python packages for processing engine plugins |

‎content/shared/influxdb3-cli/install/package.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
The `influxdb3 install package` command installs Python packages for use in [InfluxDB 3 processing engine plugins](/influxdb3/version/process/).
2+
3+
## Usage
4+
5+
```bash { placeholders="PACKAGE_NAME" }
6+
influxdb3 install package --packages PACKAGE_NAME
7+
```
8+
9+
Replace the following:
10+
11+
- {{% code-placeholder-key %}}`PACKAGE_NAME`{{% /code-placeholder-key %}}: the name of the Python package to install
12+
13+
## Options
14+
15+
| Option | Description | Default | Environment | Required |
16+
|--------|-------------|---------|-------------|----------|
17+
| `--packages` | Python package names to install (comma-separated) | | | |
18+
| `-r`, `--requirements` | Path to requirements.txt file | | | |
19+
| `-H`, `--host` | Host URL of the running {{< product-name >}} server | `http://127.0.0.1:8181` | `INFLUXDB3_HOST_URL` | |
20+
| `--token` | The token for authentication with the InfluxDB 3 server | | `INFLUXDB3_AUTH_TOKEN` | |
21+
| `--tls-ca` | Path to a custom TLS certificate authority for testing with self-signed certificates | | `INFLUXDB3_TLS_CA` | |
22+
| `--plugin-dir` | Location of the plugins directory | | `INFLUXDB3_PLUGIN_DIR` | |
23+
| `--virtual-env-location` | Location of the Python virtual environment | | `VIRTUAL_ENV` | |
24+
| `--package-manager` | Package manager to use for installing packages | `discover` | | |
25+
26+
## Examples
27+
28+
### Install a single package
29+
30+
```bash { placeholders="pandas" }
31+
influxdb3 install package --packages pandas
32+
```
33+
34+
### Install multiple packages
35+
36+
```bash
37+
influxdb3 install package --packages pandas,numpy,scipy
38+
```
39+
40+
### Install packages from requirements file
41+
42+
```bash
43+
influxdb3 install package -r requirements.txt
44+
```
45+
46+
### Install with authentication
47+
48+
```bash { placeholders="AUTH_TOKEN|pandas" }
49+
influxdb3 install package --token AUTH_TOKEN --packages pandas
50+
```
51+
52+
Replace the following:
53+
54+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: your {{% token-link "admin" %}} for your {{< product-name >}} instance

0 commit comments

Comments
 (0)