Skip to content

docs(operator): document native cold storage (spec.coldStorage) - #553

Merged
sklarsa merged 1 commit into
mainfrom
docs/operator-cold-storage
Sep 14, 2026
Merged

sklarsa merged 1 commit into
mainfrom
docs/operator-cold-storage

Conversation

@sklarsa

@sklarsa sklarsa commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Operator v0.3.0 (questdb/questdb-enterprise-operator#312) ships native cold storage. This documents the spec.coldStorage block and its operational contract in the operator section, and cross-links the database-level cold storage pages:

  • configuration.md: new Cold storage section — the coldStorage block, default identity-scoped root cold/<namespace>/<cluster>/, the QuestDB Enterprise 4.0.0 floor, ColdStorageHealthy / status.coldStorage, legacy cold.storage.* key handling, and updated immutability rules including QuestDBObjectStore physical coordinates
  • high-availability.md: the settled cold-manager Planned precheck (ColdManagerMoveRequired) with a verification snippet, and Emergency behavior while the manager is lost
  • operations/database.md: a "Move the cold-storage manager" runbook (spec.coldStorage.manager, never direct SWITCH COLD STORAGE ROLE)
  • known-limitations.md: the manager-off-the-departing-primary requirement and the default manager: 1 friction
  • operations/cold-storage.md + concepts/cold-storage.md: notes steering operator-managed clusters to the operator flow

All condition, reason, field, and default names were verified against the operator source at v0.3.0-rc (7ef5d63).

Out of scope

The generated enterprise-kubernetes-operator/releases.md and reference/api.md pages are updated by make docs-sync in the operator repo once v0.3.0 is tagged. The supported-versions matrix (QuestDB Enterprise 4.0.0) is also left to the release sync — v0.3.0 certification ran against 4.0.1.

🤖 Generated with Claude Code

https://claude.ai/code/session_01ASL866WftGbwTF6PUqV76Y

Operator v0.3.0 adds native cold storage. Document the structured
spec.coldStorage block and its operational contract:

- configuration: the coldStorage block, default identity-scoped root,
  version floor, ColdStorageHealthy/status.coldStorage, legacy
  cold.storage.* key handling, and the new immutability rules including
  QuestDBObjectStore physical coordinates
- high availability: the settled cold-manager Planned precheck
  (ColdManagerMoveRequired) and Emergency behavior while the manager
  is lost
- database operations: a "Move the cold-storage manager" runbook
- known limitations: the manager-off-the-departing-primary requirement
  and the default manager: 1 friction
- database-level cold storage pages: steer operator-managed clusters
  to spec.coldStorage.manager instead of SWITCH COLD STORAGE ROLE

The generated releases.md and reference/api.md pages follow separately
via make docs-sync once v0.3.0 is tagged.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ASL866WftGbwTF6PUqV76Y
@github-actions

Copy link
Copy Markdown

🚀 Build success!

Latest successful preview: https://preview-553--questdb-documentation.netlify.app/docs/

Commit SHA: 0bef0c0

📦 Build generates a preview & updates the link on each commit.

@sklarsa
sklarsa merged commit e46b7f9 into main Sep 14, 2026
3 checks passed
@sklarsa
sklarsa deleted the docs/operator-cold-storage branch September 14, 2026 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant