Skip to content

Commit 14233e4

Browse files
paulohtb6kbatuigas
andauthored
tidy instructions for shadowing (#1549)
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
1 parent 298284e commit 14233e4

3 files changed

Lines changed: 13 additions & 58 deletions

File tree

modules/manage/pages/disaster-recovery/shadowing/setup.adoc

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -44,31 +44,11 @@ ifndef::env-cloud[]
4444
- You must have xref:get-started:licensing/overview.adoc[Enterprise Edition] licenses on both clusters.
4545
endif::[]
4646

47-
=== Cluster properties
47+
=== Cluster configuration
4848

49-
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`.
50-
51-
ifdef::env-cloud[]
52-
[NOTE]
53-
====
54-
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[].
55-
====
56-
endif::[]
49+
include::manage:partial$shadowing/shadow-link-prerequisites.adoc[tag=cluster-property]
5750

5851
ifndef::env-cloud[]
59-
To enable this property, run:
60-
[,bash]
61-
----
62-
rpk cluster config set enable_shadow_linking true
63-
----
64-
65-
[NOTE]
66-
====
67-
This cluster property must be configured using `rpk` or the Admin API v1 before you can create shadow links through any interface.
68-
====
69-
70-
To learn more about configuring cluster properties, see xref:manage:cluster-maintenance/cluster-property-configuration.adoc[].
71-
7252
=== Administrative access
7353

7454
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.

modules/manage/pages/kubernetes/shadowing/k-shadow-linking.adoc

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -42,41 +42,6 @@ For Kubernetes-specific networking configuration, see xref:manage:kubernetes/net
4242

4343
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.
4444

45-
IMPORTANT: Both clusters must have `enable_shadow_linking: true` in their cluster configuration to support Shadowing.
46-
47-
To enable Shadowing, set the `enable_shadow_linking` cluster property in your cluster configuration:
48-
49-
[tabs]
50-
======
51-
Operator::
52-
+
53-
--
54-
In your `Redpanda` CRD, set:
55-
56-
[,yaml]
57-
----
58-
spec:
59-
clusterSpec:
60-
config:
61-
cluster:
62-
enable_shadow_linking: true
63-
----
64-
--
65-
66-
Helm::
67-
+
68-
--
69-
In your Helm values file, set:
70-
71-
[,yaml]
72-
----
73-
config:
74-
cluster:
75-
enable_shadow_linking: true
76-
----
77-
--
78-
======
79-
8045
== Create a shadow link
8146

8247
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.

modules/manage/partials/shadowing/shadow-link-prerequisites.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
// tag::cluster-property[]
2-
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`.
2+
The shadow cluster must have the xref:reference:properties/cluster-properties.adoc#enable_shadow_linking[`enable_shadow_linking`] cluster property set to `true`.
3+
4+
ifdef::env-cloud[]
5+
[NOTE]
6+
====
7+
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[].
8+
====
9+
endif::[]
310

411
ifdef::env-kubernetes[]
512
[tabs]
@@ -39,6 +46,7 @@ config:
3946
endif::[]
4047

4148
ifndef::env-kubernetes[]
49+
ifndef::env-cloud[]
4250
To enable this property, run:
4351
[,bash]
4452
----
@@ -50,8 +58,10 @@ rpk cluster config set enable_shadow_linking true
5058
This cluster property must be configured using `rpk` or the Admin API v1 before you can create shadow links through any interface.
5159
====
5260

61+
5362
To learn more about configuring cluster properties, see xref:manage:cluster-maintenance/cluster-property-configuration.adoc[].
5463
endif::[]
64+
endif::[]
5565
// end::cluster-property[]
5666

5767
// tag::replication-permissions[]

0 commit comments

Comments
 (0)