Repository navigation
docs(influxdb): add v2.10.0 release notes - #7911
Merged
Merged
Conversation
Contributor
Vale Style Check Results
Warnings (2)
✅ Check passed |
Contributor
Release version check
💡 Badge new features with the versionDocumenting a new feature? Add a version badge in the page frontmatter — the
For inline version text, use |
What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes #7699, #7841, and #7286.
Sets latest to v2.10 and latest_patches.v2 to 2.10.0 in data/products.yml. Leaves latest_cli.v2 at 2.8.0, because no new influx CLI release ships with v2.10.
What changed:
- post-process-specs.ts applies a new content/exclude.yml overlay that
removes listed schema properties from the published spec. Stale entries
log a warning and don't fail the build.
- The InfluxDB Cloud denylist removes the Routes keys that Cloud 2 doesn't
return: backup, plugins, restore, scrapers, setup, sources, swagger, and
system.
- The Cloud Setup tag now explains that Cloud doesn't support initial
setup: GET /api/v2/setup always returns {"allowed": false}.
- Documented exclude.yml in the API docs README, and added test 16.
Why: The upstream influxdata/openapi contract shares the Routes schema
between OSS and Cloud, so the Cloud reference listed routes that Cloud
doesn't serve. influxdata/openapi#658 adds more OSS-only keys. Internal
clients might rely on the full contract, so docs-v2 filters at publish
time instead of asking upstream to remove the keys.
Impact: The published InfluxDB Cloud v2 API reference only. The committed
spec stays a raw upstream mirror.
Verification: GET /api/v2 on a production Cloud 2 org (2026-10-08)
doesn't return the excluded keys. post-process-specs tests pass (57 of
57). Running the script on influxdb/cloud removes 3 properties from the
current spec; the other 5 arrive with influxdata/openapi#658.
A failed run writes no build spec, so the readYaml call that follows already fails the test.
Contributor
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/enterprise_influxdb/v1/introduction/installation/single-server/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v1/introduction/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v2/install/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/install/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v2/install/_index.md |
https://docs.docker.com/engine/reference/run/#detached-vs-foreground | Cannot find fragment: Cannot find fragment |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/secrets | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/tasks | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/buckets | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/backup | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/users | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb/v2/reference/release-notes/influxdb/_index.md |
file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v2/api/secrets | File not found. Check if file exists and path is correct: File not found. Check … |
content/influxdb3/core/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/install/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/explorer/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/telegraf/v1/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/telegraf/v1/install/_index.md |
https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell… | Cannot find fragment: Cannot find fragment |
Full details: workflow run summary and artifact. Last updated: 2026-10-15 20:20:43 UTC
Enhance the raw GitHub release draft into Google Developer Documentation style: action-oriented descriptions, docs links for options already documented in this release cycle, and no PR links or usernames. Filters internal-only changes (tests, WAL context cleanup, build flags, CI artifact storage) that don't affect users.
jstirnaman
force-pushed
the
release-notes/v2.10.0-enhanced
branch
from
October 15, 2026 20:19
acb81c7 to
c31f3a0
Compare
jstirnaman
changed the base branch from
release/influxdb2.10-cloud
to
dar-800
October 15, 2026 20:19
jstirnaman
added a commit
that referenced
this pull request
Oct 16, 2026
…paction throughput (#7867) * docs(influxdb): document InfluxDB OSS v2.10 options, metrics, and compaction throughput * docs(influxdb): link compaction throughput options and lead metrics with version What changed: Cross-link storage-compact-throughput and storage-compact-throughput-burst. Move the v2.10 availability note to the first paragraph of the per-user query and write bytes metric sections. Why: Review feedback. Readers can jump between related options, and see version availability before the description. Impact: Two v2 reference pages; no behavior change. Verification: Pre-commit hooks. * docs(influxdb): document v2.10 health options, exit codes, and max-time-range errors What changed: - Add health-auth-mode and startup-error-linger to the config options reference, and explain how hardening-enabled restricts /health and /ready details. - Document that influxql-max-time-range errors return HTTP 200 with the error in results[].error, and that a query with no lower time bound exceeds any non-zero limit. - Add an exit codes section to the influxd reference, with a systemd RestartPreventExitStatus example. - Add a restricted health check details section to the enable-hardening page. - Link the new options and exit codes from the v2.10 release notes. - Add the six v2.10 flags to data/influxd_flags.yml. Why: influxdata/DAR#800 acceptance criteria. The behavior was verified against a local build of main-2.x (310ee146d9). Impact: InfluxDB OSS v2 reference, admin, and release notes pages only. Verification: Ran a live influxd for the max-time-range, startup failure, linger, and health-auth-mode cases. Confirmed the environment variable names with print-config. Code-block lint and link checks pass, and the pages render on a local Hugo server. * docs(influxdb): add v2.10.0 release notes (#7911) * sync(api): update InfluxDB OSS v2 and Cloud v2 specs for v2.10 What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes #7699, #7841, and #7286. * chore(influxdb): bump InfluxDB OSS v2 latest to v2.10.0 Sets latest to v2.10 and latest_patches.v2 to 2.10.0 in data/products.yml. Leaves latest_cli.v2 at 2.8.0, because no new influx CLI release ships with v2.10. * feat(api): exclude schema properties that InfluxDB Cloud doesn't return What changed: - post-process-specs.ts applies a new content/exclude.yml overlay that removes listed schema properties from the published spec. Stale entries log a warning and don't fail the build. - The InfluxDB Cloud denylist removes the Routes keys that Cloud 2 doesn't return: backup, plugins, restore, scrapers, setup, sources, swagger, and system. - The Cloud Setup tag now explains that Cloud doesn't support initial setup: GET /api/v2/setup always returns {"allowed": false}. - Documented exclude.yml in the API docs README, and added test 16. Why: The upstream influxdata/openapi contract shares the Routes schema between OSS and Cloud, so the Cloud reference listed routes that Cloud doesn't serve. influxdata/openapi#658 adds more OSS-only keys. Internal clients might rely on the full contract, so docs-v2 filters at publish time instead of asking upstream to remove the keys. Impact: The published InfluxDB Cloud v2 API reference only. The committed spec stays a raw upstream mirror. Verification: GET /api/v2 on a production Cloud 2 org (2026-10-08) doesn't return the excluded keys. post-process-specs tests pass (57 of 57). Running the script on influxdb/cloud removes 3 properties from the current spec; the other 5 arrive with influxdata/openapi#658. * test(api): drop redundant exit-code assertion from exclude overlay test A failed run writes no build spec, so the readYaml call that follows already fails the test. * docs(influxdb): add v2.10.0 release notes Enhance the raw GitHub release draft into Google Developer Documentation style: action-oriented descriptions, docs links for options already documented in this release cycle, and no PR links or usernames. Filters internal-only changes (tests, WAL context cleanup, build flags, CI artifact storage) that don't affect users.
dhoard
pushed a commit
to dhoard/docs-v2
that referenced
this pull request
Oct 21, 2026
…paction throughput (influxdata#7867) * docs(influxdb): document InfluxDB OSS v2.10 options, metrics, and compaction throughput * docs(influxdb): link compaction throughput options and lead metrics with version What changed: Cross-link storage-compact-throughput and storage-compact-throughput-burst. Move the v2.10 availability note to the first paragraph of the per-user query and write bytes metric sections. Why: Review feedback. Readers can jump between related options, and see version availability before the description. Impact: Two v2 reference pages; no behavior change. Verification: Pre-commit hooks. * docs(influxdb): document v2.10 health options, exit codes, and max-time-range errors What changed: - Add health-auth-mode and startup-error-linger to the config options reference, and explain how hardening-enabled restricts /health and /ready details. - Document that influxql-max-time-range errors return HTTP 200 with the error in results[].error, and that a query with no lower time bound exceeds any non-zero limit. - Add an exit codes section to the influxd reference, with a systemd RestartPreventExitStatus example. - Add a restricted health check details section to the enable-hardening page. - Link the new options and exit codes from the v2.10 release notes. - Add the six v2.10 flags to data/influxd_flags.yml. Why: influxdata/DAR#800 acceptance criteria. The behavior was verified against a local build of main-2.x (310ee146d9). Impact: InfluxDB OSS v2 reference, admin, and release notes pages only. Verification: Ran a live influxd for the max-time-range, startup failure, linger, and health-auth-mode cases. Confirmed the environment variable names with print-config. Code-block lint and link checks pass, and the pages render on a local Hugo server. * docs(influxdb): add v2.10.0 release notes (influxdata#7911) * sync(api): update InfluxDB OSS v2 and Cloud v2 specs for v2.10 What changed: - Resynced both specs from influxdata/openapi master. - Adds the v2.10 `/ready` and `/health` schemas from influxdata/openapi#661: measure groups (`progress`, `failures`), `uptime`, the `/ready` 503 response, and `version` and `commit` on `/health`. - Adds the Routes keys from influxdata/openapi#658. - Doesn't add `onConflict`. influxdata/openapi#663 removed it upstream. Why: the `docs-release/influxdb-oss` branch is still at v2.9.0, so this fetches OSS from master with `getswagger.sh v2 -b`. Supersedes influxdata#7699, influxdata#7841, and influxdata#7286. * chore(influxdb): bump InfluxDB OSS v2 latest to v2.10.0 Sets latest to v2.10 and latest_patches.v2 to 2.10.0 in data/products.yml. Leaves latest_cli.v2 at 2.8.0, because no new influx CLI release ships with v2.10. * feat(api): exclude schema properties that InfluxDB Cloud doesn't return What changed: - post-process-specs.ts applies a new content/exclude.yml overlay that removes listed schema properties from the published spec. Stale entries log a warning and don't fail the build. - The InfluxDB Cloud denylist removes the Routes keys that Cloud 2 doesn't return: backup, plugins, restore, scrapers, setup, sources, swagger, and system. - The Cloud Setup tag now explains that Cloud doesn't support initial setup: GET /api/v2/setup always returns {"allowed": false}. - Documented exclude.yml in the API docs README, and added test 16. Why: The upstream influxdata/openapi contract shares the Routes schema between OSS and Cloud, so the Cloud reference listed routes that Cloud doesn't serve. influxdata/openapi#658 adds more OSS-only keys. Internal clients might rely on the full contract, so docs-v2 filters at publish time instead of asking upstream to remove the keys. Impact: The published InfluxDB Cloud v2 API reference only. The committed spec stays a raw upstream mirror. Verification: GET /api/v2 on a production Cloud 2 org (2026-10-08) doesn't return the excluded keys. post-process-specs tests pass (57 of 57). Running the script on influxdb/cloud removes 3 properties from the current spec; the other 5 arrive with influxdata/openapi#658. * test(api): drop redundant exit-code assertion from exclude overlay test A failed run writes no build spec, so the readYaml call that follows already fails the test. * docs(influxdb): add v2.10.0 release notes Enhance the raw GitHub release draft into Google Developer Documentation style: action-oriented descriptions, docs links for options already documented in this release cycle, and no PR links or usernames. Filters internal-only changes (tests, WAL context cleanup, build flags, CI artifact storage) that don't affect users.
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.
What changed
Add a v2.10.0 section to
content/influxdb/v2/reference/release-notes/influxdb.md, built from the GitHub release draft.Why
Enhance the raw GitHub release draft to Google Developer Documentation style for publication:
influxql-max-time-range,http-user-write-bytes-enabled,http-user-query-bytes-enabled,storage-compact-throughput,health-auth-mode,startup-error-linger,influxdexit codes).Impact
Readers of the v2 release notes get a v2.10.0 entry consistent with prior versions' style, with working links into the config-options and CLI reference for anything already documented.
Verification
npx hugo --quietnot run in this pass — the file is Markdown content only (no shortcodes added); content/options linked already exist onrelease/influxdb2.10-cloudfrom docs(influxdb): document InfluxDB OSS v2.10 options, metrics, and compaction throughput #7867.v2-lint,lint-instructions,check-source-paths,check-support-links).Checklist