Skip to content

docs: restricted-environment install runbook (#692 part 3) - #696

Merged
BorisTyshkevich merged 2 commits into
mainfrom
docs/692-restricted-runbook
Oct 26, 2026
Merged

BorisTyshkevich merged 2 commits into
mainfrom
docs/692-restricted-runbook

Conversation

@BorisTyshkevich

@BorisTyshkevich BorisTyshkevich commented Oct 26, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Adds docs/HOSTED-INSTALL.md, the operator runbook for restricted and multi-node ClickHouse installs. ASSET-DISTRIBUTION.md stays the mechanism/design reference (cross-linked, procedures not duplicated). README, DEPLOYMENT.md, ASSET-DISTRIBUTION.md, docs/deployment.html, .wiki/Deployment-and-Security.md, .wiki/Source-Map.md and CHANGELOG link to it. Also fixes a stale deployment.html statement (the container image is Caddy, not the Python runner).

Verified live on clickhouse-server:26.3.18.32 (single node, stage-grant user): SHOW GRANTS, system.clusters query, file() write/read/truncate probe, clusterAllReplicas identity probe, url() probe (incl. the real GitHub release URL, 2,126,368 bytes), binary-safe curl upload (SHA-256 identical). The clickhouse-operator spec.configuration.files convention (config.d/... key) and secret.auto were checked against the operator repo's examples/docs. Found while writing: the installer rejects the {cluster} macro (name must match [A-Za-z0-9_.-]+), so the runbook says to use the literal name from system.clusters.

PR 3 checklist

  • Preflight decision table: HOSTED-INSTALL section 1 (questions, topology table, preflight SQL a-f).
  • Tested least-privilege grants: section 2 as GRANT statements (mirrors tests/deploy/cfg/users.xml); versions recorded.
  • End-to-end examples: section 3 (a) native, (b) HTTPS/curl, (c) Altinity Cloud, (d) operator. (c)/(d) are explicitly not tested end to end; TLS against a live server is also untested.
  • Topology, scale-out, node replacement, retry: section 4.
  • Enable/verify handlers, redirect URI, public config.json: section 5.
  • Option B described only: section 6.

Definition of done

Tests: tsc --noEmit exit 0. Full npm test under load had 5 timeout-failing files; all pass when rerun alone (docs-only change).

Closes #692

Follow-ups: remaining unverified items (ACM/operator end to end, --secure live, release URL via installer, per-replica credentials, grant floors, next release bundle) are tracked in #697.

🤖 Generated with Claude Code

https://claude.ai/code/session_01P3CopPwrpzeWAJd7vaaLSk

New docs/HOSTED-INSTALL.md (preflight decision table + SQL, tested grants,
Altinity Cloud / clickhouse-operator / self-managed / HTTPS-only examples,
topology and scale-out, handler verification, Option B). README, DEPLOYMENT,
ASSET-DISTRIBUTION, deployment.html and the wiki link to it; deployment.html
container section corrected (Caddy, not the Python runner).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01P3CopPwrpzeWAJd7vaaLSk
@BorisTyshkevich
BorisTyshkevich merged commit 8c8176c into main Oct 26, 2026
9 checks passed
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.

deployment: SQL-only ClickHouse-hosted install for restricted and multi-node clusters (Altinity Cloud, operator)

1 participant