docs(influxdb/v2): document v2.9.0 release#7173
Merged
Merged
Conversation
Add v2.9.0 release notes and supporting docs for the InfluxDB OSS 2.9.0 release. Token hashing default change: - Add v2.9.0 release notes section with "Before you upgrade" callout, disable / opt-out guidance, and backup/restore workflow note. - Flip the use-hashed-tokens default in the config-options reference from false to true; rewrite intro and examples to reflect the new default. - Add a Token hashing section to admin/tokens/ covering version defaults, startup behavior, opt-out, downgrade considerations, and recovery for lost tokens. - Add a sitewide notification scoped to /influxdb/v2 and a cascade prepend on the /influxdb/v2 landing page that surface the change on every page in the v2 doc tree. - Register --use-hashed-tokens in data/influxd_flags.yml so it appears in the influxd flag list. Backup gzip compression: - Document the new server-side Gzip-Compression-Level header and the influx backup --gzip-compression-level flag (influx-cli 2.8.0+) in the admin backup page and the shared CLI reference, including the --compression coupling. - Note the regenerated v2 OpenAPI bundle in api-docs/, produced by api-docs/getswagger.sh after promoting influxdata/openapi#652 to docs-release/influxdb-oss. The /backup/metadata operation is still missing the parameter; tracked in influxdata/openapi#653. Restore --operator-token: - Document the new --operator-token flag (influx-cli 2.8.0+) in the admin restore page and the shared CLI reference, with explicit guidance for restoring backups whose operator token is hashed. EDR replication: - Note the new maxAgeSeconds bounds (60s–60d, 0 = use default) in the v2.9.0 release notes. Version metadata: - Bump data/products.yml: latest v2.8 -> v2.9, latest_patches.v2 2.8.0 -> 2.9.0, latest_cli.v2 2.7.5 -> 2.8.0. Refs influxdata/DAR#682
Contributor
Vale Style Check Results
Warnings (10)
✅ Check passed |
Contributor
|
c795beb to
64ca0d9
Compare
…rds endpoint
Surgical patch to api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml
adding the new Gzip-Compression-Level header parameter on
GET /api/v2/backup/shards/{shardID}, mirroring the upstream change in
influxdata/openapi#652.
The bundled YAML carries local Hugo-native customizations (title,
description, server URLs, tag descriptions with x-related doc links,
v2-scoped link paths) that get clobbered by api-docs/getswagger.sh.
Hand-applied here to preserve those customizations. The /backup/metadata
endpoint also receives this header in the server and CLI implementations
but is missing the parameter in the upstream spec; tracked in
influxdata/openapi#653.
Refs influxdata/DAR#682
64ca0d9 to
020647c
Compare
Contributor
Author
|
PR Preview should include: |
Update the operator-token link in admin/backup-restore/restore.md from the non-existent `#admin-token` anchor to `#operator-token`, which matches the actual heading on the tokens page. The link prose still reads "admin token" as colloquial wording; only the anchor target is corrected here.
This was referenced Apr 30, 2026
davidby-influx
approved these changes
May 1, 2026
davidby-influx
left a comment
There was a problem hiding this comment.
One suggested change, not blocking.
| influx backup --bucket example-bucket /path/to/backup/dir/ | ||
| ``` | ||
|
|
||
| ##### Back up using a faster server-side compression level |
There was a problem hiding this comment.
I might also mention using none at all, because TSM files are already compressed to some degree.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the InfluxDB OSS 2.9.0 release. Headlines: API token hashing is now enabled by default, plus configurable backup compression, hashed-backup restore support, EDR replication validation, and incremental enhancements.
What's in this PR
content/influxdb/v2/reference/release-notes/influxdb.mdcovering the token-hashing default change (with a "Before you upgrade" callout), backup gzip compression (server header + CLI flag), restore--operator-token, EDRmaxAgeSecondsbounds, the Flux v0.200.0 upgrade, and a compaction reliability summary.## Token hashingsection incontent/influxdb/v2/admin/tokens/_index.mdcovering version defaults, startup behavior, opt-out, downgrade considerations, backup/restore implications, and lost-token recovery./influxdb/v2/so the token-hashing default change surfaces on every v2 page.influx backup --gzip-compression-levelandinflux restore --operator-tokenflags (incontent/shared/influxdb-v2/reference/cli/influx/).influxdflag list: registered--use-hashed-tokensindata/influxd_flags.yml(the flag was introduced in 2.8 but never registered).config-options.md: flippeduse-hashed-tokensdefault fromfalse→true; rewrote intro and examples.data/products.yml: bumpedlatestto v2.9,latest_patches.v2to 2.9.0,latest_cli.v2to 2.8.0.Notes for reviewers
api-docs/influxdb/v2/influxdb-oss-v2-openapi.yamladds theGzip-Compression-Levelheader parameter onGET /api/v2/backup/shards/{shardID}(mirroring the upstream change ininfluxdata/openapi#652).influxdata/openapi#653— the upstream spec is missing the same parameter on/backup/metadata, even though both the server (influxdata/influxdb#27297) and CLI (influxdata/influx-cli#574) apply it to that endpoint as well.influx-cliversioning: confirmed by @devanbenz — CLI stays at v2.8.0 for this release; no v2.9.0 CLI tag is being cut. The "2.8.0+" version strings throughout the docs are correct.Refs
influxdata/DAR#682(manual close required — cross-repo private DAR issue won't auto-close).Test plan
npx hugo serverrenders without errors/influxdb/v2/and selected child pages (e.g./influxdb/v2/admin/tokens/,/influxdb/v2/admin/backup-restore/backup/)/influxdb/v2/and is dismissible#token-hashing,#before-upgrading-to-290,#disable-token-hashing,#token-hashing-enabled-by-default,#v290,#restore-a-backup-that-contains-hashed-tokens{{< latest-patch >}}and{{< latest-cli >}}shortcodes render the new versions where used{{< current-version >}}reflects v2.9 in v2 proseGzip-Compression-Levelparameter on/backup/shards/{shardID}(still missing on/backup/metadata— tracked ininfluxdata/openapi#653)