Skip to content

Commit fadee66

Browse files
committed
Update peer fill release docs
1 parent ab5bfcc commit fadee66

4 files changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,8 +355,9 @@ amplification. Local proxy-cache misses can now ask configured peers for that
355355
safe no-origin response, store valid peer hits locally, and fall back to origin
356356
only when `fail_open` allows it. `examples/cache-peer-fill.toml` shows the
357357
current config shape, and `scripts/smoke_peer_fill_cache.sh` verifies the
358-
two-node `PEER-HIT` path plus local post-fill hits before release. An optional
359-
`1.2.5` is reserved only if production testing finds one more cache blocker. `1.3` is the
358+
multi-node `PEER-HIT` path, local post-fill hits, `Vary` variants, peer `Age`,
359+
and fail-open/fail-closed behavior before release. An optional `1.2.5` is
360+
reserved only if production testing finds one more cache blocker. `1.3` is the
360361
load-balancer/proxy parity line. Wasm is planned as a shared `1.4`
361362
extensibility release, covering nginx-Lua-style hooks and VCL-like cache policy
362363
hooks through one sandboxed runtime.

docs/cache-backends.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -258,20 +258,19 @@ internal cache implementation.
258258
- The `1.2.4` distributed-cache line starts with a safe `[cache.peer_fill]`
259259
policy contract. Peer fill is disabled by default, requires an enabled cache
260260
policy, bounds peers/timeouts/object size/concurrency, and validates peer
261-
origins before runtime peer retrieval is enabled. As the first runtime
262-
primitive, proxy-cache requests with `Cache-Control: only-if-cached` are
263-
served only from a fresh local cache object; misses, stale objects, bypassed
261+
origins. Proxy-cache requests with `Cache-Control: only-if-cached` are served
262+
only from a fresh local cache object; misses, stale objects, bypassed
264263
policies, or ineligible methods return `504` and do not contact origin. This
265264
gives outbound peer fill a safe no-origin endpoint. On a local proxy-cache
266-
miss, Fluxheim can ask configured peers for that no-origin endpoint before
265+
miss, Fluxheim asks configured peers for that no-origin endpoint before
267266
falling back to origin according to `fail_open`; peer hits are stored locally
268267
and peer requests forward only host plus safe negotiation headers rather than
269268
client credentials. The example
270269
`examples/cache-peer-fill.toml` shows the current config shape for
271270
cache-cluster planning. `scripts/smoke_peer_fill_cache.sh` runs a local
272-
two-node smoke that proves node-to-node `PEER-HIT`, no extra origin fetch,
273-
local post-fill `HIT`, fail-closed `504` without origin fetch, fail-open
274-
origin fallback, and peer-fill metrics. The configured
271+
multi-node smoke that proves node-to-node `PEER-HIT`, no extra origin fetch,
272+
local post-fill `HIT`, `Vary` variants, fail-closed `504` without origin
273+
fetch, fail-open origin fallback, and peer-fill metrics. The configured
275274
`peer_fill.max_concurrent_requests` budget is enforced per vhost or route
276275
cache policy for active outbound peer fetches.
277276
Peer response `Age` is preserved during admission, so a peer-filled object

docs/release-checklist.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,7 @@ cargo build --release --no-default-features --features proxy,metrics
363363
cargo build --release --no-default-features --features proxy,tls-rustls,acme
364364
cargo build --release --no-default-features --features profile-load-balancer
365365
cargo build --release --no-default-features --features profile-observability
366+
scripts/smoke_peer_fill_cache.sh
366367
scripts/smoke_observability_local.sh
367368
```
368369

docs/versioning-plan.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -823,7 +823,8 @@ Focused cache-only follow-up releases after 1.2:
823823
another node for a fresh cached object without causing that node to contact
824824
origin. Outbound peer-fill uses that path on local proxy-cache misses, stores
825825
valid peer hits locally, applies `fail_open` to decide whether a peer miss
826-
falls back to origin, and is covered by a local two-node smoke test.
826+
falls back to origin, preserves peer `Age`, stores `Vary` variants correctly,
827+
and is covered by a local multi-node smoke test.
827828
- `1.2.5`: reserved only if production 1.2 testing exposes one more
828829
cache-specific gap that should close before the 1.3 line starts. Candidate
829830
work includes proper Pingora-path partial streaming/slice range fill,

0 commit comments

Comments
 (0)