Skip to content

Rewrite changelog registry docs for scrubber Lambda ownership - #3761

Open
cotti wants to merge 1 commit into
changelog-retire-client-registry-refreshfrom
changelog-registry-docs
Open

Rewrite changelog registry docs for scrubber Lambda ownership#3761
cotti wants to merge 1 commit into
changelog-retire-client-registry-refreshfrom
changelog-registry-docs

Conversation

@cotti

@cotti cotti commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Why

Phase 4 of elastic/docs-eng-team#688, stacked on #3760. After Phases 1–3 the registry docs described a retired system: client-side refresh, registry pass-through, an ETag "documented as useless", a CloudFront "1 h TTL" that hasn't existed since caching was disabled, and a claim that the refresh was "skipped for --artifact-type changelog".

What

docs/development/changelog-bundle-registry.md now documents the end state: the scrubber Lambda's RegistryReconciler as the manifest's sole producer (registry = f(state)), the producer field, bundles[].etag as the public object's ETag (finally usable for CDN cache revalidation), consistency stated as convergence with the consumer's listed-but-missing tolerance kept, the deliberate absent ≠ empty manifest semantics, and the registry reconcile / registry verify operator tooling with the reconcile message contract. The scrubber README's event-handling section and cmd-upload.md's registry paragraph are aligned with the same model.

Part of elastic/docs-eng-team#688 (Phase 4).

@cotti cotti added the documentation Improvements or additions to documentation label Aug 4, 2026
@cotti
cotti requested review from a team as code owners August 4, 2026 01:36
@cotti cotti added the documentation Improvements or additions to documentation label Aug 4, 2026
@cotti
cotti requested a review from reakaleek August 4, 2026 01:36
The registry docs still described the retired model: client-side refresh,
registry pass-through, pre-scrub ETags, a 1 h CloudFront TTL (caching is
disabled), and a refresh "skipped for --artifact-type changelog". Documents
the reconciler as sole producer, the public-object ETag, convergence
semantics, absent-vs-empty manifests, the reconcile message contract, and
the registry reconcile/verify operator commands (docs-eng-team#688 Phase 4).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant