Skip to content

Document cross-namespace clusterRef for shadow links in Kubernetes #1793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JakeSCahill merged 1 commit into from
Jul 15, 2026
Merged

Document cross-namespace clusterRef for shadow links in Kubernetes #1793

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions modules/manage/pages/kubernetes/shadowing/k-shadow-linking.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,39 @@ The operator automatically resolves cluster connection details from the referenc
+
[NOTE]
====
When using `clusterRef`, the operator handles authentication automatically using the cluster's internal credentials. For cross-namespace or external clusters, use `staticConfiguration` instead.
When using `clusterRef`, the operator handles authentication automatically using the cluster's internal credentials. For clusters that are not managed by the same operator, use `staticConfiguration` instead.
====
+
By default, a `clusterRef` resolves in the same namespace as the `ShadowLink` resource. If the source and shadow clusters are managed by the same operator but deployed in different namespaces on the same Kubernetes cluster, set the `namespace` field on the source cluster's `clusterRef`:
+
.`shadowlink.yaml`
[,yaml]
----
apiVersion: cluster.redpanda.com/v1alpha2
kind: ShadowLink
metadata:
name: disaster-recovery-link
spec:
shadowCluster:
clusterRef:
name: redpanda-shadow
sourceCluster:
clusterRef:
name: redpanda-source
namespace: <source-namespace>
topicMetadataSyncOptions:
autoCreateShadowTopicFilters:
- name: '*'
filterType: include
patternType: literal
----
+
[WARNING]
====
Use this same-cluster, cross-namespace topology only for development and testing, such as rehearsing replication and failover on a single Kubernetes cluster. A single Kubernetes cluster is a single failure domain, so it cannot provide disaster recovery. For production, deploy the source and shadow clusters in separate Kubernetes clusters, ideally in separate cloud regions, and connect them using `staticConfiguration`.
====

- For external or cross-namespace clusters, use `staticConfiguration`:
- For external clusters, or clusters that are not managed by the same operator, use `staticConfiguration`:
+
Create a shadow link with explicit connection details:
+
Expand Down
Loading