Repository navigation
docs(zero-cache-config): document legacy query, operator password, readiness and hydration options - #324
Closed
arv wants to merge 1 commit into
Closed
docs(zero-cache-config): document legacy query, operator password, readiness and hydration options#324arv wants to merge 1 commit into
arv wants to merge 1 commit into
Conversation
…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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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 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-configGenerated by Claude Code |
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 |
This branch was successfully deployed
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.
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)ZERO_ALLOW_LEGACY_QUERIESfalseZERO_OPERATOR_PASSWORD(/profz,/profrmz,/statz,/plannerz; not the inspector or/heapz)ZERO_REPLICATION_LAG_INITIAL_READINESS_THRESHOLD_MS1000ZERO_REPLICATION_LAG_MAX_READINESS_DELAY_MS600000ZERO_VIEW_SYNCER_HYDRATION_BUDGET_MS0(off)ZERO_VIEW_SYNCER_QUERY_HYDRATION_TIMEOUT_MS0(off)Corrected defaults and text
ZERO_REPLICATION_LAG_REPORT_INTERVAL_MS30000 → 10000. The interval is now described as approximate, with a note on readiness.ZERO_CVR_GARBAGE_COLLECTION_INACTIVITY_THRESHOLD_HOURS48 → 168.ZERO_CHANGE_STREAMER_FLOW_CONTROL_CONSENSUS_TIMEOUT_PROPORTION2 → 4.ZERO_AUTH_REVALIDATE_INTERVAL_SECONDSandZERO_AUTH_RETRANSFORM_INTERVAL_SECONDSunset→300. These were already wrong for 1.10.ZERO_LITESTREAM_BACKUP_USING_V5false → true. The surrounding v5 text is updated: what a restore needs, running without a v5 executable, and lifecycle policy guidance.0.5.18-zero.16, and that a custom v5 executable must support-fork-to-url.ZERO_LITESTREAM_MULTIPART_CONCURRENCY48→ unset. Unset means 48, lowered to fit in a quarter of the container's memory.ZERO_LITESTREAM_VFS_*entries are removed. Those options no longer exist.ZERO_CHANGE_STREAMER_MODEandZERO_LITESTREAM_MIN_CHECKPOINT_PAGE_COUNTmove to Deprecated Flags, as the code marks them. The page-count formula is now* 256.Other pages
deprecated/ad-hoc-queries.mdxnotes that these queries needZERO_ALLOW_LEGACY_QUERIES=true.debug/slow-queries.mdxnames the operator password for/statz.Names and defaults were checked against
zero-cache/src/config/zero-config.tsat rocicorp/mono 22fa3c27e, and the Litestream version againstpackages/zero/Dockerfile.Not covered (follow-up)
ZERO_LITESTREAM_FORCE_CHECKPOINT_THRESHOLD_MBZERO_LITESTREAM_MAX_WAL_SIZE_MBZERO_SELF_DRAIN_DELAY_MSZERO_CHANGE_STREAMER_MAX_CONCURRENT_SWITCHOVER_RESTORESZERO_UPSTREAM_PG_REPLICATION_SLOT_PER_REPLICAZERO_LOG_*thresholdsZERO_UPSTREAM_PG_REPLICATION_SLOT_FAILOVERis listed twice on the page. That was already the case.assets/search-index.jsonis not regenerated, to avoid conflicts with the other 1.11 docs PRs. Regenerate it when merging.Checks
prettier --checkpasses, all three pages compile as MDX, andtests/search.test.tspasses.🤖 Generated with Claude Code
https://claude.ai/code/session_01RRckJnCeGsYg9nCJSxBgTJ
Generated by Claude Code