Skip to content

Commit 61269f3

Browse files
authored
fix(influxdb3): (#6479)
- malformed link - update broken link fragements - link to plugin docs at /telegraf instead of GitHub\ - Remove language fragments from tabs
1 parent 17558b8 commit 61269f3

File tree

16 files changed

+73
-73
lines changed

16 files changed

+73
-73
lines changed

content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ username and password to authenticate database reads and writes by passing a
7878
When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens).
7979
{{% product-name %}} ignores the `username` (`u`) parameter in the request.
8080

81-
Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)):
81+
Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token-scheme)):
8282

8383
- [Basic authentication](#basic-authentication)
8484
- [Query string authentication](#query-string-authentication)
@@ -260,7 +260,7 @@ Write data with your existing workloads that already use the InfluxDB v1 or v1.x
260260

261261
{{% api-endpoint endpoint="https://{{< influxdb/host >}}/write" method="post" %}}
262262

263-
- [`/api/v2/write` parameters](#v1-api-write-parameters)
263+
- [`/write` parameters](#v1-api-write-parameters)
264264
- [Tools for writing to the v1 API](#tools-for-writing-to-the-v1-api)
265265

266266
#### v1 API /write parameters
@@ -302,7 +302,7 @@ The following tools work with the {{% product-name %}} `/write` endpoint:
302302
#### Telegraf
303303

304304
If you have existing v1 workloads that use Telegraf,
305-
you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data.
305+
you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](/telegraf/v1/output-plugins/influxdb/) to write data.
306306

307307
> [!Note]
308308
> See how to [use Telegraf and the v2 API](/influxdb3/cloud-dedicated/write-data/use-telegraf/) for new workloads that don't already use the v1 API.
@@ -344,7 +344,7 @@ Replace the following:
344344
345345
`influx_uint_support`: supported in InfluxDB 3.
346346
347-
For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub.
347+
For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub.
348348
349349
#### Interactive clients
350350
@@ -355,7 +355,7 @@ Include the following in your request:
355355
- A `db` query string parameter with the name of the database to write to.
356356
- A request body that contains a string of data in [line protocol](/influxdb3/cloud-dedicated/reference/syntax/line-protocol/) syntax.
357357
- A [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens) in
358-
one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token).
358+
one of the following authentication schemes: [Basic authentication](#basic-authentication), [query string authentication](#query-string-authentication), or [token authentication](#authenticate-with-a-token-scheme).
359359
- Optional [parameters](#v1-api-write-parameters).
360360
361361
The following example shows how to use the **cURL** command line tool and the {{% product-name %}} v1 API to write line protocol data to a database:

content/influxdb3/cloud-dedicated/write-data/csv/telegraf.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ metrics from different sources and writes them to specified destinations.
6969
## Configure Telegraf to write to InfluxDB
7070

7171
To send data to {{< product-name >}}, enable the
72-
[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md)
72+
[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/)
7373
in the `telegraf.conf`.
7474

7575
{{% code-placeholders "DATABASE_NAME" %}}
@@ -145,4 +145,4 @@ The preceding examples describe Telegraf configurations necessary for writing to
145145
The output plugin provides several other options for configuring the Telegraf client:
146146

147147
- `influx_uint_support`: supported by the InfluxDB 3 storage engine.
148-
- See [`influxdb_v2` plugin options](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md) on GitHub.
148+
- See [`influxdb_v2` plugin options](/telegraf/v1/output-plugins/influxdb_v2/) on GitHub.

content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ To add any of the available [Telegraf plugins](/telegraf/v1/plugins/), follow th
6767
### Enable and configure the InfluxDB v2 output plugin
6868

6969
To send data to {{< product-name >}}, enable the
70-
[`influxdb_v2` output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb_v2/README.md)
70+
[`influxdb_v2` output plugin](/telegraf/v1/output-plugins/influxdb_v2/)
7171
in the `telegraf.conf`.
7272

7373
{{% code-placeholders "DATABASE_NAME" %}}
@@ -124,7 +124,7 @@ The name of the {{% product-name %}} database to write data to.
124124

125125
`influx_uint_support`: supported in InfluxDB 3.
126126

127-
For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) on GitHub.
127+
For more plugin options, see [`influxdb`](/telegraf/v1/output-plugins/influxdb/) on GitHub.
128128

129129
## Start Telegraf
130130

content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ username and password to authenticate bucket reads and writes by passing an [API
6464
When authenticating requests to the v1 API `/write` and `/query` endpoints, {{% product-name %}} checks that the `password` (`p`) value is an authorized [API token](/influxdb3/cloud-serverless/admin/tokens/).
6565
{{% product-name %}} ignores the `username` (`u`) parameter in the request.
6666

67-
Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token)):
67+
Use one of the following authentication schemes with clients that support Basic authentication or query parameters (that don't support [token authentication](#authenticate-with-a-token-scheme)):
6868

6969
- [Basic authentication](#basic-authentication)
7070
- [Query string authentication](#query-string-authentication)
@@ -144,8 +144,8 @@ curl --get "https://{{< influxdb/host >}}/query" \
144144

145145
Replace the following:
146146

147-
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets)
148-
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets)
147+
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets)
148+
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets)
149149
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket
150150

151151
### Authenticate with a token scheme
@@ -187,8 +187,8 @@ influx bucket delete -n DATABASE_NAME/RETENTION_POLICY_NAME
187187

188188
Replace the following:
189189

190-
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-databases-and-retention-policies-to-buckets)
191-
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-databases-and-retention-policies-to-buckets)
190+
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the [database](#map-v1-databases-and-retention-policies-to-buckets)
191+
- {{% code-placeholder-key %}}`RETENTION_POLICY`{{% /code-placeholder-key %}}: the [retention policy](#map-v1-databases-and-retention-policies-to-buckets)
192192
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) with sufficient permissions to the mapped bucket
193193

194194
## Responses
@@ -228,7 +228,7 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In
228228
```
229229

230230
The `?precision=` parameter contains an unknown value.
231-
Provide a [timestamp precision](#timestamp-precision).
231+
Provide a [timestamp precision]/influxdb3/cloud-serverless/reference/glossary/#timestamp-precision).
232232

233233
## Map v1 databases and retention policies to buckets
234234

@@ -336,7 +336,7 @@ Include the following:
336336

337337
{{< req type="key" >}}
338338

339-
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization).
339+
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket.
340340
- {{< req "\*" >}} the **database name** to map
341341
- {{< req "\*" >}} the **retention policy** name to map
342342
- {{< req "\*" >}} the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/#view-buckets-in-the-influxdb-ui) to map to
@@ -376,7 +376,7 @@ influx v1 dbrp delete --id $test_dbrp
376376

377377
Replace the following:
378378

379-
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
379+
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
380380
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: the database name to map to the bucket
381381
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: the retention policy name to map to the bucket
382382
- {{% code-placeholder-key %}}`BUCKET_ID`{{% /code-placeholder-key %}}: the [bucket ID](/influxdb3/cloud-serverless/admin/buckets/view-buckets/) to map to
@@ -395,7 +395,7 @@ Include the following:
395395

396396
- **Request method:** `POST`
397397
- **Headers:**
398-
- **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
398+
- **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
399399
- **Content-type:** `application/json`
400400
- **Request body:** JSON object with the following fields:
401401

@@ -485,7 +485,7 @@ Include the following:
485485

486486
- **Request method:** `GET`
487487
- **Headers:**
488-
- **Authorization:** `Token` scheme with your [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
488+
- **Authorization:** `Token` scheme with your [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
489489
- **Query parameters:**
490490
{{< req type="key" >}}
491491
- {{< req "\*" >}} **orgID:** your [organization ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id)
@@ -545,7 +545,7 @@ Use the [`influx v1 dbrp update` command](/influxdb3/cloud-serverless/reference/
545545
to update a DBRP mapping.
546546
Include the following:
547547

548-
- a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
548+
- a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
549549
- **DBRP mapping ID** to update
550550
- Optional: **Retention policy** name to update to
551551
- Optional: **Default flag** to set the retention policy as the [default DBRP mapping](#default-dbrp) for the database name.
@@ -577,7 +577,7 @@ influx v1 dbrp update \
577577

578578
Replace the following:
579579

580-
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
580+
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
581581
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
582582
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: a retention policy name to map to the bucket
583583

@@ -596,7 +596,7 @@ Include the following:
596596

597597
- **Request method:** `PATCH`
598598
- **Headers:**
599-
- {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
599+
- {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
600600
- **Path parameters:**
601601
- {{< req "\*" >}} **id:** the DBRP mapping ID to update
602602
- **Query parameters:**
@@ -622,7 +622,7 @@ curl --request PATCH \
622622

623623
Replace the following:
624624

625-
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
625+
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
626626
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
627627
- {{% code-placeholder-key %}}`RETENTION_POLICY_NAME`{{% /code-placeholder-key %}}: a retention policy name to map to the bucket
628628

@@ -648,7 +648,7 @@ Include the following:
648648

649649
{{< req type="key" >}}
650650

651-
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
651+
- {{< req "\*" >}} a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
652652
- {{< req "\*" >}} **DBRP mapping ID** to delete
653653

654654

@@ -689,7 +689,7 @@ Include the following:
689689

690690
- **Request method:** `DELETE`
691691
- **Headers:**
692-
- {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
692+
- {{< req "\*" >}} the **Authorization:** `Token` scheme with a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
693693
- **Path parameters:**
694694
- {{< req "\*" >}} **id:** DBRP mapping ID to update
695695
- **Query parameters:**
@@ -708,7 +708,7 @@ curl --request DELETE \
708708

709709
Replace the following:
710710

711-
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the [necessary permissions](#authorization)
711+
- {{% code-placeholder-key %}}`API_TOKEN`{{% /code-placeholder-key %}}: a [token](/influxdb3/cloud-serverless/admin/tokens/) that has the necessary permissions to the mapped bucket
712712
- {{% code-placeholder-key %}}`DBRP_ID`{{% /code-placeholder-key %}}: the DBRP ID to update
713713
- {{% code-placeholder-key %}}`ORG_ID`{{% /code-placeholder-key %}}: the [organization ID](/influxdb3/cloud-serverless/admin/organizations/view-orgs/#view-your-organization-id)
714714

0 commit comments

Comments
 (0)