Skip to content

docs: Update Runtime-Watcher Architecture Documentation#720

Merged
medmes merged 5 commits into
kyma-project:mainfrom
medmes:docs/update-runtime-watcher-architecture
May 8, 2026
Merged

docs: Update Runtime-Watcher Architecture Documentation#720
medmes merged 5 commits into
kyma-project:mainfrom
medmes:docs/update-runtime-watcher-architecture

Conversation

@medmes
Copy link
Copy Markdown
Member

@medmes medmes commented Apr 27, 2026

Summary

Brings docs/architecture.md up to date with all changes introduced by epic kyma-project/lifecycle-manager#2998 (Robust Zero-Downtime CA Cert Rotation) and the listener v2 cleanup (issues #548 and #549).

  • Remove SAN Pinning sectionsan_pinning.go was deleted from lifecycle-manager and VerifyFunc was removed from the listener API; the section was no longer accurate.
  • Listener package — replace the non-existent RegisterListenerComponent/channel-return pattern with the current NewSKREventListener / ReceivedEvents() API; describe XFCC-based runtime ID extraction from the client certificate Common Name; update the example link to internal/controller/kyma/setup.go.
  • Runtime Watcher — update the WatchEvents type link to listener/pkg/v2/types/event.go; clarify that a WatchEvent carries a resource reference (name + namespace + GVK), not the full object body.
  • Watcher CR — fix stale commit-SHA link to the watcher controller.
  • Certificates — document the two-secret model (klm-watcher / klm-istio-gateway), CA bundle management, caAddedToBundleAt annotation, the new Istio Gateway Secret controller, Gardener cert-management as an alternative backend, and the six-step zero-downtime CA rotation flow; add a link to ADR 007 for the full design rationale.

Related issue
#685

Reflect changes introduced by epic kyma-project/lifecycle-manager#2998
(Robust Zero-Downtime CA Cert Rotation) and the listener v2 cleanup:

- Remove SAN Pinning section: san_pinning.go was deleted and VerifyFunc
  was removed from the listener API
- Listener: replace RegisterListenerComponent/channel-return pattern with
  the current NewSKREventListener / ReceivedEvents() API; describe
  XFCC-based runtime ID extraction from the client certificate CN; update
  example link to internal/controller/kyma/setup.go
- Runtime Watcher: update WatchEvents link to listener/pkg/v2/types/event.go;
  clarify that a WatchEvent carries a resource reference (name/namespace +
  GVK) rather than the full object body
- Watcher CR: fix stale commit-SHA link to the watcher controller
- Certificates: document the two-secret model (klm-watcher / klm-istio-gateway),
  CA bundle management, caAddedToBundleAt annotation, Istio Gateway Secret
  controller, Gardener cert-management backend, and the six-step
  zero-downtime CA rotation flow with a link to ADR 007

Closes kyma-project#685
@medmes medmes requested a review from a team as a code owner April 27, 2026 11:56
@medmes medmes linked an issue Apr 27, 2026 that may be closed by this pull request
1 task
Comment thread docs/architecture.md Outdated
Comment thread docs/architecture.md Outdated
@medmes medmes requested a review from a team as a code owner May 6, 2026 15:31
@medmes medmes force-pushed the docs/update-runtime-watcher-architecture branch from c12486c to 24aca87 Compare May 6, 2026 15:31
medmes added 2 commits May 8, 2026 12:01
- Replace all occurrences of "listener package" with "listener module"
  (or "runtime-watcher/listener") to avoid ambiguity with Go's package
  concept (per review comment by Tomasz-Smelcerz-SAP)
- Drop "operator" framing for the listener: it defines an HTTP endpoint,
  not a K8s operator (per review comment by Tomasz-Smelcerz-SAP)
@medmes medmes enabled auto-merge (squash) May 8, 2026 10:11
Comment thread docs/architecture.md Outdated
Comment thread docs/architecture.md Outdated
Comment thread docs/architecture.md Outdated
Comment thread docs/architecture.md Outdated
Comment thread docs/architecture.md Outdated
Comment thread docs/architecture.md Outdated
Comment thread docs/architecture.md Outdated
Co-authored-by: Natalia Sitko <80401180+nataliasitko@users.noreply.github.com>
@medmes medmes merged commit 4d7c119 into kyma-project:main May 8, 2026
12 checks passed
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.

Check if RW architecture docs is up to date

3 participants