Skip to content

Commit c312fef

Browse files
jstirnamanjstirnaman
committed
Merge remote-tracking branch 'origin/jts-6160-3-2-cli' into core-ent-3.2
2 parents ae85ae4 + 16f79c9 commit c312fef

File tree

21 files changed

+616
-35
lines changed

21 files changed

+616
-35
lines changed

‎.github/instructions/contributing.instructions.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
applyTo: "content/**/*.md, layouts/**/*.html"
33
---
44

5-
# GitHub Copilot Instructions for InfluxData Documentation
5+
# Contributing instructions for InfluxData Documentation
66

77
## Purpose and scope
88

9-
GitHub Copilot should help document InfluxData products
9+
Help document InfluxData products
1010
by creating clear, accurate technical content with proper
1111
code examples, frontmatter, shortcodes, and formatting.
1212

@@ -375,6 +375,9 @@ list_query_example:# Code examples included with article descriptions in childre
375375
# References to examples in data/query_examples
376376
canonical: # Path to canonical page, overrides auto-gen'd canonical URL
377377
v2: # Path to v2 equivalent page
378+
alt_links: # Alternate pages in other products/versions for cross-product navigation
379+
cloud-dedicated: /influxdb3/cloud-dedicated/path/to/page/
380+
core: /influxdb3/core/path/to/page/
378381
prepend: # Prepend markdown content to an article (especially powerful with cascade)
379382
block: # (Optional) Wrap content in a block style (note, warn, cloud)
380383
content: # Content to prepend to article
@@ -466,6 +469,29 @@ add the following frontmatter to the 1.x page:
466469
v2: /influxdb/v2.0/get-started/
467470
```
468471

472+
### Alternative links for cross-product navigation
473+
474+
Use the `alt_links` frontmatter to specify equivalent pages in other InfluxDB products,
475+
for example, when a page exists at a different path in a different version or if
476+
the feature doesn't exist in that product.
477+
This enables the product switcher to navigate users to the corresponding page when they
478+
switch between products. If a page doesn't exist in another product (for example, an
479+
Enterprise-only feature), point to the nearest parent page if relevant.
480+
481+
```yaml
482+
alt_links:
483+
cloud-dedicated: /influxdb3/cloud-dedicated/admin/tokens/create-token/
484+
cloud-serverless: /influxdb3/cloud-serverless/admin/tokens/create-token/
485+
core: /influxdb3/core/reference/cli/influxdb3/update/ # Points to parent if exact page doesn't exist
486+
```
487+
488+
Supported product keys for InfluxDB 3:
489+
- `core`
490+
- `enterprise`
491+
- `cloud-serverless`
492+
- `cloud-dedicated`
493+
- `clustered`
494+
469495
### Prepend and append content to a page
470496

471497
Use the `prepend` and `append` frontmatter to add content to the top or bottom of a page.

‎CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,9 @@ list_query_example:# Code examples included with article descriptions in childre
363363
# References to examples in data/query_examples
364364
canonical: # Path to canonical page, overrides auto-gen'd canonical URL
365365
v2: # Path to v2 equivalent page
366+
alt_links: # Alternate pages in other products/versions for cross-product navigation
367+
cloud-dedicated: /influxdb3/cloud-dedicated/path/to/page/
368+
core: /influxdb3/core/path/to/page/
366369
prepend: # Prepend markdown content to an article (especially powerful with cascade)
367370
block: # (Optional) Wrap content in a block style (note, warn, cloud)
368371
content: # Content to prepend to article
@@ -454,6 +457,29 @@ add the following frontmatter to the 1.x page:
454457
v2: /influxdb/v2.0/get-started/
455458
```
456459

460+
### Alternative links for cross-product navigation
461+
462+
Use the `alt_links` frontmatter to specify equivalent pages in other InfluxDB products,
463+
for example, when a page exists at a different path in a different version or if
464+
the feature doesn't exist in that product.
465+
This enables the product switcher to navigate users to the corresponding page when they
466+
switch between products. If a page doesn't exist in another product (for example, an
467+
Enterprise-only feature), point to the nearest parent page if relevant.
468+
469+
```yaml
470+
alt_links:
471+
cloud-dedicated: /influxdb3/cloud-dedicated/admin/tokens/create-token/
472+
cloud-serverless: /influxdb3/cloud-serverless/admin/tokens/create-token/
473+
core: /influxdb3/core/reference/cli/influxdb3/update/ # Points to parent if exact page doesn't exist
474+
```
475+
476+
Supported product keys for InfluxDB 3:
477+
- `core`
478+
- `enterprise`
479+
- `cloud-serverless`
480+
- `cloud-dedicated`
481+
- `clustered`
482+
457483
### Prepend and append content to a page
458484

459485
Use the `prepend` and `append` frontmatter to add content to the top or bottom of a page.

‎compose.yaml

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -304,13 +304,21 @@ services:
304304
image: influxdb:3-core
305305
ports:
306306
- 8181:8181
307+
volumes:
308+
- type: bind
309+
source: test/influxdb3/core/data
310+
target: /var/lib/influxdb3/data
311+
- type: bind
312+
source: test/influxdb3/core/plugins
313+
target: /var/lib/influxdb3-plugins
307314
command:
308315
- influxdb3
309316
- serve
310-
- --node-id=sensors_node0
317+
- --node-id=node0
311318
- --log-filter=debug
312319
- --object-store=file
313-
- --data-dir=/var/lib/influxdb3
320+
- --data-dir=/var/lib/influxdb3/data
321+
- --plugin-dir=/var/lib/influxdb3/plugins
314322
influxdb3-enterprise:
315323
container_name: influxdb3-enterprise
316324
image: influxdb:3-enterprise
@@ -326,16 +334,16 @@ services:
326334
- --cluster-id=cluster0
327335
- --log-filter=debug
328336
- --object-store=file
329-
- --data-dir=/var/lib/influxdb3
337+
- --data-dir=/var/lib/influxdb3/data
330338
- --plugin-dir=/var/lib/influxdb3/plugins
331339
- --license-email=${INFLUXDB3_LICENSE_EMAIL}
332340
volumes:
333341
- type: bind
334-
source: docker/influxdb3/data
335-
target: /var/lib/influxdb3
342+
source: test/influxdb3/enterprise/data
343+
target: /var/lib/influxdb3/data
336344
- type: bind
337-
source: docker/influxdb3/plugins
338-
target: /var/lib/influxdb3-plugins
345+
source: test/influxdb3/enterprise/plugins
346+
target: /var/lib/influxdb3/plugins
339347
telegraf-pytest:
340348
container_name: telegraf-pytest
341349
image: influxdata/docs-pytest

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ influxdb3 [GLOBAL-OPTIONS] [COMMAND]
3232
| [serve](/influxdb3/core/reference/cli/influxdb3/serve/) | Run the {{% product-name %}} server |
3333
| [show](/influxdb3/core/reference/cli/influxdb3/show/) | List resources |
3434
| [test](/influxdb3/core/reference/cli/influxdb3/test/) | Test plugins |
35+
| [update](/influxdb3/core/reference/cli/influxdb3/update/) | Update resources |
3536
| [write](/influxdb3/core/reference/cli/influxdb3/write/) | Write to {{% product-name %}} |
3637

3738
## Global options

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 update
3+
description: >
4+
The `influxdb3 update` command updates resources such as databases.
5+
menu:
6+
influxdb3_core:
7+
parent: influxdb3
8+
name: influxdb3 update
9+
weight: 300
10+
source: /shared/influxdb3-cli/update/_index.md
11+
---
12+
13+
<!--
14+
// SOURCE content/shared/influxdb3-cli/update/_index.md
15+
-->

‎content/influxdb3/core/reference/cli/influxdb3/update/database.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 update database
3+
description: >
4+
The `influxdb3 update database` command updates an existing database.
5+
menu:
6+
influxdb3_core:
7+
parent: influxdb3 update
8+
name: influxdb3 update database
9+
weight: 400
10+
source: /shared/influxdb3-cli/update/database/_index.md
11+
---
12+
13+
<!--
14+
// SOURCE content/shared/influxdb3-cli/update/database/_index.md
15+
-->

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ influxdb3 [GLOBAL-OPTIONS] [COMMAND]
3232
| [serve](/influxdb3/enterprise/reference/cli/influxdb3/serve/) | Run the {{% product-name %}} server |
3333
| [show](/influxdb3/enterprise/reference/cli/influxdb3/show/) | List resources |
3434
| [test](/influxdb3/enterprise/reference/cli/influxdb3/test/) | Test plugins |
35+
| [update](/influxdb3/enterprise/reference/cli/influxdb3/update/) | Update resources |
3536
| [write](/influxdb3/enterprise/reference/cli/influxdb3/write/) | Write to {{% product-name %}} |
3637

3738
## Global options

‎content/influxdb3/enterprise/reference/cli/influxdb3/show/license.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: influxdb3 show license
3+
description: >
4+
The `influxdb3 show license` command displays license information for your
5+
InfluxDB 3 Enterprise server.
6+
menu:
7+
influxdb3_enterprise:
8+
parent: influxdb3 show
9+
name: influxdb3 show license
10+
weight: 300
11+
---
12+
13+
The `influxdb3 show license` command displays license information for your {{< product-name >}} instance.
14+
15+
16+
## Usage
17+
18+
<!--pytest.mark.skip-->
19+
20+
```bash
21+
influxdb3 show license [OPTIONS]
22+
```
23+
24+
## Options
25+
26+
| Option | | Description |
27+
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
28+
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
29+
| | `--cluster-id` | _({{< req >}})_ Cluster identifier |
30+
| | `--node-id` | _({{< req >}})_ Node identifier |
31+
| | `--object-store` | _({{< req >}})_ Object store type (file, memory, s3, gcs, azure) |
32+
| | `--token` | Authentication token |
33+
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
34+
| `-h` | `--help` | Print help information |
35+
| | `--help-all` | Print detailed help information |
36+
37+
> [!Note]
38+
> **CLI help documentation bug in v3.2.0**
39+
>
40+
> The `influxdb3 show license --help` output in v3.2.0 does not display the required `--object-store`, `--cluster-id`, and `--node-id` options and related object store configuration options.
41+
> This command requires object store configuration and cluster/node identification to function properly.
42+
43+
### Additional object store options
44+
45+
Depending on the `--object-store` type specified, additional configuration options may be required:
46+
47+
- **S3**: AWS credentials and bucket configuration
48+
- **GCS**: Google Cloud credentials and bucket configuration
49+
- **Azure**: Azure credentials and container configuration
50+
- **File**: Local file system path configuration
51+
52+
### Option environment variables
53+
54+
You can use the following environment variables to set command options:
55+
56+
| Environment Variable | Option |
57+
| :------------------------ | :----------- |
58+
| `INFLUXDB3_HOST_URL` | `--host` |
59+
| `INFLUXDB3_AUTH_TOKEN` | `--token` |
60+
61+
## Examples
62+
63+
### Display license information with file object store
64+
65+
{{% code-placeholders "AUTH_TOKEN|CLUSTER_ID|NODE_ID" %}}
66+
67+
<!--pytest.mark.skip-->
68+
69+
```bash
70+
influxdb3 show license \
71+
--cluster-id CLUSTER_ID \
72+
--node-id NODE_ID \
73+
--object-store file \
74+
--token AUTH_TOKEN
75+
```
76+
77+
{{% /code-placeholders %}}
78+
79+
In the example above, replace the following:
80+
81+
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
82+
Authentication token
83+
- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}:
84+
Your cluster identifier
85+
- {{% code-placeholder-key %}}`NODE_ID`{{% /code-placeholder-key %}}:
86+
Your node identifier
87+
88+
The command displays information about your Enterprise license, including license type, expiration date, and usage limits.

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 update
3+
description: >
4+
The `influxdb3 update` command updates resources such as databases and tables.
5+
menu:
6+
influxdb3_enterprise:
7+
parent: influxdb3
8+
name: influxdb3 update
9+
weight: 300
10+
source: /shared/influxdb3-cli/update/_index.md
11+
---
12+
13+
<!--
14+
// SOURCE content/shared/influxdb3-cli/update/_index.md
15+
-->

‎content/influxdb3/enterprise/reference/cli/influxdb3/update/database.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: influxdb3 update database
3+
description: >
4+
The `influxdb3 update database` command updates an existing database.
5+
menu:
6+
influxdb3_enterprise:
7+
parent: influxdb3 update
8+
name: influxdb3 update database
9+
weight: 400
10+
source: /shared/influxdb3-cli/update/database/_index.md
11+
---
12+
13+
<!--
14+
// SOURCE content/shared/influxdb3-cli/update/database/_index.md
15+
-->

0 commit comments

Comments
 (0)