docs: ShadowLink schema replication and role sync on Kubernetes (DOC-2333)#1817
docs: ShadowLink schema replication and role sync on Kubernetes (DOC-2333)#1817JakeSCahill wants to merge 2 commits into
Conversation
…-2333) - New Configure schema replication section: topic/api/disabled modes, Confluent Schema Registry example with Secret-backed credentials - New Configure role synchronization section with filters - Regenerated CRD reference from operator main via the crd-spec automation (Broker types excluded pending the config update) - Corrected the Verify shadow link status example to the conditions the CRD actually reports (Synced + state, not Ready) - Documented the external NodePort collision when two Redpanda clusters share one Kubernetes cluster (the cross-namespace dev/test topology) Validated end-to-end on kind v1.34 with an operator built from main: cross-namespace ShadowLink with schema_registry_shadowing_mode: api against the source's SR REST endpoint and roleSyncOptions enabled; topic, schema subject, and role all replicated to the shadow.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Matches redpanda-operator#1690: Broker CR types excluded, Stretch Cluster types included for GA (StretchCluster and RedpandaBrokerPool now have generated field reference documentation).
1 participant
Documents the new ShadowLink CRD surfaces for 26.2 (DOC-2333, eng epic ENG-1232, confirmed ready for docs by David):
Changes
k-shadow-linking.adoc: the threeschema_registry_shadowing_modevalues (topicdefault,apifor Confluent/external registries,disabled), a Confluent example with the API key/secret in a Kubernetes Secret, Operator + Helm tabs, and a pointer to the core migration guide for concepts and validation policies.crd-specautomation (ran its underlyingcrd-ref-docsinvocation with main's config plusBroker.*added to the ignore list, since the dark-launched Broker CR postdates the config's exclusions). Adds the ShadowLink SR/role types and the Gateway API types.Synced+state: active(+shadowTopicStatuses), not aReadycondition; the example now shows the real observed status.provided port is already allocated); disable external access on one or assign non-overlapping ports. Hit live during validation of the documented dev/test topology.Validation (kind v1.34.0, operator built from main @ 550bab24b)
Cross-namespace ShadowLink (src/dst namespaces, one cluster-scoped operator):
schema_registry_shadowing_mode: apipointed at the source's SR REST endpoint,roleSyncOptionsenabled. Verified on the shadow: theorderstopic (shadowTopicStatuses active), theorders-valuesubject replicated over the SR REST API, andshadow-test-rolereplicated. CEL admission verified (api mode requiresshadowSchemaRegistryAPI).Notes for eng (also raised on the operator side)
The
crd-ref-docs-config.yamlin the operator repo needsBroker.*added toignoreTypesbefore the next automated CRD regen, and theStretch.*ignore needs REMOVING at GA so StretchCluster/RedpandaBrokerPool get reference docs.Coordination: the Confluent-source specifics defer to Joyce's merged core page (docs#1776); role-sync core docs are #1780.