Skip to content

tidy instructions for shadowing #1549

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
paulohtb6 merged 7 commits into from
Jan 14, 2026
Merged

tidy instructions for shadowing #1549

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5af52e8
tiddy instructions for shadowing
paulohtb6 Jan 13, 2026
d17d5d8
fix
paulohtb6 Jan 13, 2026
4cddbca
fix header
paulohtb6 Jan 13, 2026
42f600b
reintroduce cloud if
paulohtb6 Jan 14, 2026
6c50797
remove link on clcoud
paulohtb6 Jan 14, 2026
cf8ed3e
fix
paulohtb6 Jan 14, 2026
8e53908
Update modules/manage/partials/shadowing/shadow-link-prerequisites.adoc
paulohtb6 Jan 14, 2026
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
24 changes: 2 additions & 22 deletions modules/manage/pages/disaster-recovery/shadowing/setup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,31 +44,11 @@ ifndef::env-cloud[]
- You must have xref:get-started:licensing/overview.adoc[Enterprise Edition] licenses on both clusters.
endif::[]

=== Cluster properties
=== Cluster configuration

Both source and shadow clusters must have the xref:reference:properties/cluster-properties.adoc#enable_shadow_linking[`enable_shadow_linking`] cluster property set to `true`.

ifdef::env-cloud[]
[NOTE]
====
Starting with Redpanda v25.3, this cluster property is enabled by default on new Redpanda Cloud clusters. Existing clusters created before v25.3 must enable this property manually. See xref:manage:cluster-maintenance/config-cluster.adoc[].
====
endif::[]
include::manage:partial$shadowing/shadow-link-prerequisites.adoc[tag=cluster-property]
Copy link
Contributor

@kbatuigas kbatuigas Jan 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks all right in Self-managed (including Kubernetes) but not really in Cloud? Unless I'm looking at the wrong preview. Could you please double check?

Copy link
Collaborator Author

@paulohtb6 paulohtb6 Jan 14, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missed one if for cloud. Should be fine now. Thanks for spotting that!


ifndef::env-cloud[]
To enable this property, run:
[,bash]
----
rpk cluster config set enable_shadow_linking true
----

[NOTE]
====
This cluster property must be configured using `rpk` or the Admin API v1 before you can create shadow links through any interface.
====

To learn more about configuring cluster properties, see xref:manage:cluster-maintenance/cluster-property-configuration.adoc[].

=== Administrative access

Superuser access is required on both clusters through xref:get-started:rpk/index.adoc[`rpk`], the Admin API, or xref:console:index.adoc[Redpanda Console] to create and manage shadow links.
Expand Down
35 changes: 0 additions & 35 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 @@ -42,41 +42,6 @@ For Kubernetes-specific networking configuration, see xref:manage:kubernetes/net

Deploy both your source and shadow Redpanda clusters with Shadowing enabled. See xref:deploy:deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc[Deploy Redpanda in Kubernetes] for full deployment instructions.

IMPORTANT: Both clusters must have `enable_shadow_linking: true` in their cluster configuration to support Shadowing.

To enable Shadowing, set the `enable_shadow_linking` cluster property in your cluster configuration:

[tabs]
======
Operator::
+
--
In your `Redpanda` CRD, set:

[,yaml]
----
spec:
clusterSpec:
config:
cluster:
enable_shadow_linking: true
----
--

Helm::
+
--
In your Helm values file, set:

[,yaml]
----
config:
cluster:
enable_shadow_linking: true
----
--
======

== Create a shadow link

In the examples, `<shadow-namespace>` represents the namespace where your shadow Redpanda cluster is deployed, and `<source-namespace>` represents the namespace where your source Redpanda cluster is deployed. The shadow cluster and its associated resources (shadow links, secrets) should be deployed in the same namespace as the shadow cluster.
Expand Down
12 changes: 11 additions & 1 deletion modules/manage/partials/shadowing/shadow-link-prerequisites.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
// tag::cluster-property[]
Both source and shadow clusters must have the xref:reference:properties/cluster-properties.adoc#enable_shadow_linking[`enable_shadow_linking`] cluster property set to `true`.
The shadow cluster must have the xref:reference:properties/cluster-properties.adoc#enable_shadow_linking[`enable_shadow_linking`] cluster property set to `true`.

ifdef::env-cloud[]
[NOTE]
====
Starting with Redpanda v25.3, this cluster property is enabled by default on new Redpanda Cloud clusters. For existing clusters on versions earlier than v25.3, you must enable this property manually. See xref:manage:cluster-maintenance/config-cluster.adoc[].
====
endif::[]

ifdef::env-kubernetes[]
[tabs]
Expand Down Expand Up @@ -39,6 +46,7 @@ config:
endif::[]

ifndef::env-kubernetes[]
ifndef::env-cloud[]
Copy link
Contributor

@kbatuigas kbatuigas Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block is still somehow displayed on the Cloud version on the page: https://deploy-preview-1549--redpanda-docs-preview.netlify.app/redpanda-cloud/manage/disaster-recovery/shadowing/setup/#cluster-configuration I wonder if it's the double ifndefs.

To enable this property, run:
[,bash]
----
Expand All @@ -50,8 +58,10 @@ rpk cluster config set enable_shadow_linking true
This cluster property must be configured using `rpk` or the Admin API v1 before you can create shadow links through any interface.
====


To learn more about configuring cluster properties, see xref:manage:cluster-maintenance/cluster-property-configuration.adoc[].
endif::[]
endif::[]
// end::cluster-property[]

// tag::replication-permissions[]
Expand Down