Skip to content

docs(influxdb/v2): document v2.9.0 release#7173

Merged
jstirnaman merged 6 commits into
masterfrom
dar-682-oss-2.9.0-release-notes
May 1, 2026
Merged

docs(influxdb/v2): document v2.9.0 release#7173
jstirnaman merged 6 commits into
masterfrom
dar-682-oss-2.9.0-release-notes

Conversation

@jstirnaman

@jstirnaman jstirnaman commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

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

  • v2.9.0 release notes section in content/influxdb/v2/reference/release-notes/influxdb.md covering the token-hashing default change (with a "Before you upgrade" callout), backup gzip compression (server header + CLI flag), restore --operator-token, EDR maxAgeSeconds bounds, the Flux v0.200.0 upgrade, and a compaction reliability summary.
  • New ## Token hashing section in content/influxdb/v2/admin/tokens/_index.md covering version defaults, startup behavior, opt-out, downgrade considerations, backup/restore implications, and lost-token recovery.
  • Sitewide notification + cascade prepend scoped to /influxdb/v2/ so the token-hashing default change surfaces on every v2 page.
  • Backup and restore admin pages updated with token-hashing-aware callouts and cross-links.
  • CLI reference updates for the new influx backup --gzip-compression-level and influx restore --operator-token flags (in content/shared/influxdb-v2/reference/cli/influx/).
  • influxd flag list: registered --use-hashed-tokens in data/influxd_flags.yml (the flag was introduced in 2.8 but never registered).
  • config-options.md: flipped use-hashed-tokens default from falsetrue; rewrote intro and examples.
  • data/products.yml: bumped latest to v2.9, latest_patches.v2 to 2.9.0, latest_cli.v2 to 2.8.0.

Notes for reviewers

  • Spec patch to api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml adds the Gzip-Compression-Level header parameter on GET /api/v2/backup/shards/{shardID} (mirroring the upstream change in influxdata/openapi#652).
  • OpenAPI follow-up tracked: 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-cli versioning: 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 server renders without errors
  • Cascade prepend appears at the top of /influxdb/v2/ and selected child pages (e.g. /influxdb/v2/admin/tokens/, /influxdb/v2/admin/backup-restore/backup/)
  • Notification banner renders on /influxdb/v2/ and is dismissible
  • All anchors resolve: #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 prose
  • v2 API reference renders with the Gzip-Compression-Level parameter on /backup/shards/{shardID} (still missing on /backup/metadata — tracked in influxdata/openapi#653)

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
@jstirnaman jstirnaman requested a review from a team as a code owner April 30, 2026 17:43
@jstirnaman jstirnaman requested review from sanderson and removed request for a team April 30, 2026 17:43
@github-actions

github-actions Bot commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 0
Warnings 10
Suggestions 8
Warnings (10)
File Line Rule Message
content/influxdb/v2/reference/release-notes/influxdb.md 2283 InfluxDBv2.ServerConfig Did you really mean 'Telegraf'?
content/influxdb/v2/reference/release-notes/influxdb.md 2335 InfluxDBv2.ServerConfig Did you really mean 'Telegraf'?
content/influxdb/v2/reference/release-notes/influxdb.md 2335 InfluxDataDocs.Spelling Did you really mean 'configs'?
content/influxdb/v2/reference/release-notes/influxdb.md 2335 InfluxDBv2.ServerConfig Did you really mean 'configs'?
content/influxdb/v2/reference/release-notes/influxdb.md 2337 InfluxDBv2.ServerConfig Did you really mean 'Telegraf'?
content/influxdb/v2/reference/release-notes/influxdb.md 2337 InfluxDBv2.ServerConfig Did you really mean 'config'?
content/influxdb/v2/reference/release-notes/influxdb.md 2337 InfluxDBv2.ServerConfig Did you really mean 'toml'?
content/influxdb/v2/reference/release-notes/influxdb.md 2337 InfluxDataDocs.Spelling Did you really mean 'toml'?
content/influxdb/v2/reference/release-notes/influxdb.md 2338 InfluxDBv2.ServerConfig Did you really mean 'config'?
content/influxdb/v2/reference/release-notes/influxdb.md 2346 InfluxDBv2.ServerConfig Did you really mean 'config'?

Check passed

@github-actions github-actions Bot added product:shared Shared content across products product:v2 InfluxDB v2 (Cloud TSM, OSS) product:v2-cloud InfluxDB Cloud (TSM) product:v3-distributed InfluxDB 3 Cloud Serverless, Cloud Dedicated, Clustered labels Apr 30, 2026
@github-actions

github-actions Bot commented Apr 30, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-7173/
on branch gh-pages at 2026-05-01 21:31 UTC

@jstirnaman jstirnaman requested review from devanbenz and gwossum April 30, 2026 17:56
@jstirnaman jstirnaman force-pushed the dar-682-oss-2.9.0-release-notes branch from c795beb to 64ca0d9 Compare April 30, 2026 17:57
…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
@jstirnaman jstirnaman force-pushed the dar-682-oss-2.9.0-release-notes branch from 64ca0d9 to 020647c Compare April 30, 2026 18:32
@jstirnaman

Copy link
Copy Markdown
Contributor Author

PR Preview should include:
/influxdb/v2/api/backup

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.

@sanderson sanderson left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor question.

Comment thread content/influxdb/v2/_index.md
@jstirnaman jstirnaman added release:pending Waiting for product release before merging waiting:engineering Waiting for engineer confirmation labels May 1, 2026

@davidby-influx davidby-influx left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One suggested change, not blocking.

influx backup --bucket example-bucket /path/to/backup/dir/
```

##### Back up using a faster server-side compression level

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might also mention using none at all, because TSM files are already compressed to some degree.

@jstirnaman jstirnaman merged commit 46e5c44 into master May 1, 2026
32 of 51 checks passed
@jstirnaman jstirnaman deleted the dar-682-oss-2.9.0-release-notes branch May 1, 2026 21:32
github-actions Bot added a commit that referenced this pull request May 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:shared Shared content across products product:v2-cloud InfluxDB Cloud (TSM) product:v2 InfluxDB v2 (Cloud TSM, OSS) product:v3-distributed InfluxDB 3 Cloud Serverless, Cloud Dedicated, Clustered release:pending Waiting for product release before merging waiting:engineering Waiting for engineer confirmation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants