Skip to content

docs(zero-cache-config): document legacy query, operator password, readiness and hydration options - #324

Closed
arv wants to merge 1 commit into
mainfrom
arv/docs-1.11-config
Closed

arv wants to merge 1 commit into
mainfrom
arv/docs-1.11-config

Conversation

@arv

@arv arv commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

Documents the new zero-cache options in 1.11 and fixes defaults that are out of date for 1.11. This is a draft until 1.11 ships.

New options (contents/docs/zero-cache-config.mdx)

Option Default
ZERO_ALLOW_LEGACY_QUERIES false
ZERO_OPERATOR_PASSWORD (/profz, /profrmz, /statz, /plannerz; not the inspector or /heapz) unset
ZERO_REPLICATION_LAG_INITIAL_READINESS_THRESHOLD_MS 1000
ZERO_REPLICATION_LAG_MAX_READINESS_DELAY_MS 600000
ZERO_VIEW_SYNCER_HYDRATION_BUDGET_MS 0 (off)
ZERO_VIEW_SYNCER_QUERY_HYDRATION_TIMEOUT_MS 0 (off)

Corrected defaults and text

  • ZERO_REPLICATION_LAG_REPORT_INTERVAL_MS 30000 → 10000. The interval is now described as approximate, with a note on readiness.
  • ZERO_CVR_GARBAGE_COLLECTION_INACTIVITY_THRESHOLD_HOURS 48 → 168.
  • ZERO_CHANGE_STREAMER_FLOW_CONTROL_CONSENSUS_TIMEOUT_PROPORTION 2 → 4.
  • ZERO_AUTH_REVALIDATE_INTERVAL_SECONDS and ZERO_AUTH_RETRANSFORM_INTERVAL_SECONDS unset → 300. These were already wrong for 1.10.
  • ZERO_LITESTREAM_BACKUP_USING_V5 false → true. The surrounding v5 text is updated: what a restore needs, running without a v5 executable, and lifecycle policy guidance.
  • The docs now say the image ships Litestream 0.5.18-zero.16, and that a custom v5 executable must support -fork-to-url.
  • ZERO_LITESTREAM_MULTIPART_CONCURRENCY 48 → unset. Unset means 48, lowered to fit in a quarter of the container's memory.
  • The four ZERO_LITESTREAM_VFS_* entries are removed. Those options no longer exist.
  • ZERO_CHANGE_STREAMER_MODE and ZERO_LITESTREAM_MIN_CHECKPOINT_PAGE_COUNT move to Deprecated Flags, as the code marks them. The page-count formula is now * 256.

Other pages

  • deprecated/ad-hoc-queries.mdx notes that these queries need ZERO_ALLOW_LEGACY_QUERIES=true.
  • debug/slow-queries.mdx names the operator password for /statz.

Names and defaults were checked against zero-cache/src/config/zero-config.ts at rocicorp/mono 22fa3c27e, and the Litestream version against packages/zero/Dockerfile.

Not covered (follow-up)

  • New public options this page doesn't document:
    • ZERO_LITESTREAM_FORCE_CHECKPOINT_THRESHOLD_MB
    • ZERO_LITESTREAM_MAX_WAL_SIZE_MB
    • ZERO_SELF_DRAIN_DELAY_MS
    • ZERO_CHANGE_STREAMER_MAX_CONCURRENT_SWITCHOVER_RESTORES
    • ZERO_UPSTREAM_PG_REPLICATION_SLOT_PER_REPLICA
    • the new ZERO_LOG_* thresholds
  • ZERO_UPSTREAM_PG_REPLICATION_SLOT_FAILOVER is listed twice on the page. That was already the case.
  • assets/search-index.json is not regenerated, to avoid conflicts with the other 1.11 docs PRs. Regenerate it when merging.

Checks

prettier --check passes, all three pages compile as MDX, and tests/search.test.ts passes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ


Generated by Claude Code

…adiness and hydration options

Add ZERO_ALLOW_LEGACY_QUERIES, ZERO_OPERATOR_PASSWORD,
ZERO_REPLICATION_LAG_INITIAL_READINESS_THRESHOLD_MS,
ZERO_REPLICATION_LAG_MAX_READINESS_DELAY_MS,
ZERO_VIEW_SYNCER_HYDRATION_BUDGET_MS and
ZERO_VIEW_SYNCER_QUERY_HYDRATION_TIMEOUT_MS.

Update defaults (replication lag report interval, CVR GC threshold,
flow control consensus proportion, auth revalidate/retransform
intervals, litestream v5 backups, multipart concurrency), remove the
litestream VFS options, and move ZERO_CHANGE_STREAMER_MODE and
ZERO_LITESTREAM_MIN_CHECKPOINT_PAGE_COUNT to deprecated flags.
@vercel

vercel Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
zero-docs Ready Ready Preview Oct 14, 2026 3:56pm UTC

Request Review

arv commented Oct 14, 2026

Copy link
Copy Markdown
Contributor Author

The Verify Signed Commit Authors check fails, but not because of what this PR changes. A cloud Claude Code session signed commit fe63616 with its own SSH key, which isn't in rocicorp/.github's allowed signers. A re-run won't fix it. To fix it, re-sign the commit with an allowed key:

git fetch origin arv/docs-1.11-config
git checkout arv/docs-1.11-config
git commit --amend --no-edit -S
git push --force-with-lease origin arv/docs-1.11-config

Generated by Claude Code

@arv arv mentioned this pull request Oct 14, 2026
4 of 7 tasks

arv commented Oct 14, 2026

Copy link
Copy Markdown
Contributor Author

Folded into #325, which has all the 1.11 docs and the release notes in one PR. This commit is there unchanged.


Generated by Claude Code

@arv arv closed this Oct 14, 2026

This branch was successfully deployed

1 active deployment
Preview — fe636160 Deployed Oct 14, 2026 by vercel[bot]
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