Skip to content

docs: document ZERO_CHANGE_STREAMER_SECRET for multi-node deployments - #329

Closed
arv wants to merge 1 commit into
mainfrom
arv/change-streamer-secret
Closed

arv wants to merge 1 commit into
mainfrom
arv/change-streamer-secret

Conversation

@arv

@arv arv commented Oct 31, 2026

Copy link
Copy Markdown
Contributor

Documents the --change-streamer-secret / ZERO_CHANGE_STREAMER_SECRET option that zero-cache 1.12 adds for authenticating view-syncers to the replication-manager's change-streamer.

  • zero-cache Config: new "Change Streamer Secret" entry (what it does, single-node generates its own, multi-node should always set it and warns when unset, and the no-downtime order for adding it to an existing deployment: view-syncers first, then the replication-manager).
  • Self-host: the secret is added to both the replication-manager and the view-syncer in the Docker Compose, Fly.io, SST and Kubernetes multi-node examples, and the Networking section tells readers to set it alongside keeping port 4849 private.

Hold until zero-cache 1.12 ships, since the option does not exist in 1.11.

@vercel

vercel Bot commented Oct 31, 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 31, 2026 11:00am UTC

Request Review

Copilot AI lite review requested due to automatic review settings October 31, 2026 10:59
@github-actions
github-actions Bot requested a review from tantaman October 31, 2026 10:59

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation and deployment examples cover the new shared-secret configuration and security guidance across supported environments, with only a minor non-blocking rollout-order clarification noted.

No open issues 🎉

What changed in this PR

Documents the --change-streamer-secret / ZERO_CHANGE_STREAMER_SECRET option introduced in zero-cache 1.12 and updates multi-node self-hosting examples.

Changes:

  • Documents secret behavior, defaults, security guidance, and no-downtime rollout order.
  • Adds the shared secret to Docker Compose, Fly.io, SST, and Kubernetes examples.
  • Updates networking guidance to keep port 4849 private.
  • Notes a minor clarification needed to distinguish secret rollout ordering from the general rolling-update sequence.
File Summary
contents/​docs/​zero-cache-config.mdx Documents the change-streamer secret option and deployment guidance. A nit notes that the view-syncers-first rollout should be explicitly identified as an exception to the general upgrade order.
contents/​docs/​self-host.mdx Adds the shared secret to multi-node deployment examples and networking guidance.

Review effort: Lite

@arv

arv commented Oct 31, 2026

Copy link
Copy Markdown
Contributor Author

Closing until zero-cache 1.12 ships; will reopen then.

@arv arv closed this Oct 31, 2026
@arv
arv deleted the arv/change-streamer-secret branch October 31, 2026 11:04

This branch was successfully deployed

1 active deployment
Preview — cf3105eb Deployed Oct 31, 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.

2 participants