Skip to content

Commit 4de84bb

Browse files
MeelahMeMeelahMe
committed
Merge branch '6021-add-schedule-plugin-test-docs' of github.com:influxdata/docs-v2 into 6021-add-schedule-plugin-test-docs
2 parents 2d31bdf + 1eb841e commit 4de84bb

File tree

22 files changed

+539
-391
lines changed

22 files changed

+539
-391
lines changed

‎api-docs/influxdb/v2/v2/ref.yml

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,11 @@ tags:
218218
|:-----------:|:------------------------ |:--------------------- |
219219
| `200` | Success | |
220220
| `204` | Success. No content | InfluxDB doesn't return data for the request. |
221-
| `400` | Bad request | May indicate one of the following: <ul><li>Line protocol is malformed. The response body contains the first malformed line in the data and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. For more information, check the `rejected_points` measurement in your `_monitoring` bucket.</li><li>`Authorization` header is missing or malformed or the API token doesn't have permission for the operation.</li></ul> |
221+
| `400` | Bad request | May indicate one of the following:<ul><li>the request body is malformed</li><li>`Authorization` header is missing or malformed</li><li>the API token doesn't have permission for the operation.</li></ul> |
222222
| `401` | Unauthorized | May indicate one of the following: <ul><li>`Authorization: Token` header is missing or malformed</li><li>API token value is missing from the header</li><li>API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/v2/security/tokens/)</li></ul> |
223223
| `404` | Not found | Requested resource was not found. `message` in the response body provides details about the requested resource. |
224224
| `413` | Request entity too large | Request payload exceeds the size limit. |
225-
| `422` | Unprocessable entity | Request data is invalid. `code` and `message` in the response body provide details about the problem. |
225+
| `422` | Unprocessable entity | Request data is invalid. The request was well-formed, but couldn't complete due to semantic errors--for example, some or all points in a write request were rejected due to a schema or retention policy violation. The response body provides details about the problem. For more information about rejected points, see how to [Troubleshoot issues writing data](/influxdb/v2/write-data/troubleshoot/)|
226226
| `429` | Too many requests | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |
227227
| `500` | Internal server error | |
228228
| `503` | Service unavailable | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |
@@ -12752,6 +12752,12 @@ paths:
1275212752

1275312753
- Returns this error only if the [Go (golang) `ioutil.ReadAll()`](https://pkg.go.dev/io/ioutil#ReadAll) function raises an error.
1275412754
- Returns `Content-Type: application/json` for this error.
12755+
'422':
12756+
content:
12757+
application/json:
12758+
schema:
12759+
$ref: '#/components/schemas/Error'
12760+
description: The request was well-formed, but some or all the points were rejected due to semantic errors--for example, schema conflicts or retention policy violations. Error message contains details for one or more rejected points.
1275512761
'429':
1275612762
description: |
1275712763
Too many requests.
@@ -13190,6 +13196,14 @@ paths:
1319013196
- Legacy Query
1319113197
/write:
1319213198
post:
13199+
description: |-
13200+
Writes line protocol to the specified bucket.
13201+
13202+
This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools.
13203+
13204+
Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/v2/reference/syntax/line-protocol/) format to InfluxDB.
13205+
Use query parameters to specify options for writing data.
13206+
1319313207
operationId: PostLegacyWrite
1319413208
parameters:
1319513209
- $ref: '#/components/parameters/TraceSpan'
@@ -13263,6 +13277,12 @@ paths:
1326313277
schema:
1326413278
$ref: '#/components/schemas/LineProtocolLengthError'
1326513279
description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written.
13280+
'422':
13281+
content:
13282+
application/json:
13283+
schema:
13284+
$ref: '#/components/schemas/Error'
13285+
description: The request was well-formed, but some or all the points were rejected due to semantic errors--for example, schema conflicts or retention policy violations. Error message contains details for one or more rejected points.
1326613286
'429':
1326713287
description: Token is temporarily over quota. The Retry-After header describes when to try the write again.
1326813288
headers:

‎api-docs/influxdb3/cloud-dedicated/management/openapi.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ tags:
4040
See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/).
4141
4242
By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.
43+
<!-- ReDoc-Inject: <security-definitions> -->
4344
- name: Database tokens
4445
description: Manage database read/write tokens for a cluster
4546
- name: Databases

‎api-docs/influxdb3/core/v3/ref.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ tags:
5252
#### Related guides
5353
5454
- [Manage tokens](/influxdb3/core/admin/tokens/)
55-
- [Authentication and authorization](/influxdb3/core/reference/authentication/)
55+
- [Authentication and authorization](/influxdb3/core/reference/internals/authentication/)
5656
x-traitTag: true
5757
- name: Cache data
5858
description: |

‎api-docs/influxdb3/enterprise/v3/ref.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ tags:
5252
#### Related guides
5353
5454
- [Manage tokens](/influxdb3/enterprise/admin/tokens/)
55-
- [Authentication and authorization](/influxdb3/enterprise/reference/authentication/)
55+
- [Authentication and authorization](/influxdb3/enterprise/reference/internals/authentication/)
5656
x-traitTag: true
5757
- name: Cache data
5858
description: |
@@ -1936,8 +1936,6 @@ components:
19361936
scheme: bearer
19371937
bearerFormat: JWT
19381938
description: |
1939-
_During Alpha release, an API token is not required._
1940-
19411939
A Bearer token for authentication.
19421940
19431941
Provide the scheme and the API token in the `Authorization` header--for example:

‎content/influxdb/cloud/write-data/troubleshoot.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,5 @@ source: /shared/influxdb-v2/write-data/troubleshoot.md
1919
---
2020

2121
<!-- The content of this file is at
22-
// SOURCE content/shared/influxdb-v2/write-data/troubleshoot.md-->
22+
// SOURCE content/shared/influxdb-v2/write-data/troubleshoot.md
23+
-->

‎content/influxdb/v2/install/_index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -164,13 +164,13 @@ gpg: key 7C3D57159FC2F927: public key "InfluxData Package Signing Key <support@i
164164
<!--test:setup
165165
```sh
166166
curl --silent --location --output-dir ~/Downloads -O \
167-
"https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" \
167+
"https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" \
168168
```
169169
-->
170170

171171
```sh
172172
curl --silent --location \
173-
https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz.asc \
173+
https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz.asc \
174174
| gpg --verify - ~/Downloads/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz \
175175
2>&1 | grep 'InfluxData Package Signing Key <[email protected]>'
176176
```
@@ -239,12 +239,12 @@ brew install influxdb
239239

240240
1. In your browser or your terminal, download the InfluxDB package.
241241

242-
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" download>InfluxDB v2 (macOS)</a>
242+
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" download>InfluxDB v2 (macOS)</a>
243243

244244
```sh
245245
# Download using cURL
246246
curl --location -O \
247-
"https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz"
247+
"https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz"
248248
```
249249

250250
2. {{< req text="Recommended:" color="magenta" >}}: Verify the integrity of the download--for example, enter the
@@ -443,18 +443,18 @@ _If necessary, adjust the example file paths and utilities for your system._
443443
1. In your browser or your terminal, download the InfluxDB binary for your
444444
system architecture (AMD64 or ARM).
445445
446-
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz" download >InfluxDB v2 (amd64)</a>
447-
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz" download >InfluxDB v2 (arm)</a>
446+
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz" download >InfluxDB v2 (amd64)</a>
447+
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz" download >InfluxDB v2 (arm)</a>
448448
449449
<!--test:actual
450450
```sh
451451
curl -s --location -O \
452-
"https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz"
452+
"https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz"
453453
```
454454
455455
```sh
456456
curl -s --location -O \
457-
"https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz"
457+
"https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz"
458458
```
459459
-->
460460
@@ -463,15 +463,15 @@ _If necessary, adjust the example file paths and utilities for your system._
463463
```sh
464464
# Use curl to download the amd64 binary.
465465
curl --location -O \
466-
https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz
466+
https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz
467467
```
468468
469469
<!--pytest.mark.skip-->
470470
471471
```sh
472472
# Use curl to download the arm64 binary.
473473
curl --location -O \
474-
https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz
474+
https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz
475475
```
476476
477477
2. [Choose the InfluxData key-pair for your OS version](#choose-the-influxdata-key-pair-for-your-system).
@@ -505,7 +505,7 @@ _If necessary, adjust the example file paths and utilities for your system._
505505
| grep 'InfluxData Package Signing Key <[email protected]>' \
506506
&&
507507
# Download and verify the binary's signature file
508-
curl --silent --location "https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz.asc" \
508+
curl --silent --location "https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz.asc" \
509509
| gpg --verify - influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz \
510510
2>&1 | grep 'InfluxData Package Signing Key <[email protected]>'
511511
```
@@ -519,7 +519,7 @@ _If necessary, adjust the example file paths and utilities for your system._
519519
| grep 'InfluxData Package Signing Key <[email protected]>' \
520520
&&
521521
# Download and verify the binary's signature file
522-
curl --silent --location "https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz.asc" \
522+
curl --silent --location "https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz.asc" \
523523
| gpg --verify - influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz \
524524
2>&1 | grep 'InfluxData Package Signing Key <[email protected]>'
525525
```
@@ -618,7 +618,7 @@ chmod 0750 ~/.influxdbv2
618618
>
619619
> _You'll install the `influx CLI` in a [later step](#download-install-and-configure-the-influx-cli)._
620620
621-
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}-windows.zip" download >InfluxDB v2 (Windows)</a>
621+
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}-windows.zip" download >InfluxDB v2 (Windows)</a>
622622
623623
Expand the downloaded archive into `C:\Program Files\InfluxData\` and rename the
624624
files if desired.

‎content/influxdb/v2/reference/config-options.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2744,6 +2744,61 @@ storage-validate-keys = true
27442744

27452745
---
27462746

2747+
### storage-wal-flush-on-shutdown
2748+
Flush the WAL on shutdown.
2749+
2750+
**Default:** `false`
2751+
2752+
| influxd flag | Environment variable | Configuration key |
2753+
| :------------------------------ | :------------------------------------ | :---------------------------- |
2754+
| `--storage-wal-flush-on-shutdown` | `INFLUXD_STORAGE_WAL_FLUSH_ON_SHUTDOWN` | `storage-wal-flush-on-shutdown` |
2755+
2756+
If set, `influxd` flushes or snapshots all WALs prior to completing shutdown--`influxd` performs cache snapshots on shutdown, which
2757+
results in the WAL files being written to TSM files and then deleted.
2758+
2759+
This is useful in upgrade and downgrade scenarios to prevent WAL format
2760+
compatibility issues.
2761+
2762+
###### influxd flag
2763+
<!--pytest.mark.skip-->
2764+
2765+
```sh
2766+
influxd --storage-wal-flush-on-shutdown
2767+
```
2768+
2769+
###### Environment variable
2770+
```sh
2771+
export INFLUXD_STORAGE_WAL_FLUSH_ON_SHUTDOWN=true
2772+
```
2773+
2774+
###### Configuration file
2775+
{{< code-tabs-wrapper >}}
2776+
{{% code-tabs %}}
2777+
[YAML](#)
2778+
[TOML](#)
2779+
[JSON](#)
2780+
{{% /code-tabs %}}
2781+
{{% code-tab-content %}}
2782+
```yml
2783+
storage-wal-flush-on-shutdown: true
2784+
```
2785+
{{% /code-tab-content %}}
2786+
{{% code-tab-content %}}
2787+
```toml
2788+
storage-wal-flush-on-shutdown = true
2789+
```
2790+
{{% /code-tab-content %}}
2791+
{{% code-tab-content %}}
2792+
```json
2793+
{
2794+
"storage-wal-flush-on-shutdown": true
2795+
}
2796+
```
2797+
{{% /code-tab-content %}}
2798+
{{< /code-tabs-wrapper >}}
2799+
2800+
---
2801+
27472802
### storage-wal-fsync-delay
27482803
Duration a write will wait before fsyncing.
27492804
A duration greater than `0` batches multiple fsync calls.

0 commit comments

Comments
 (0)