Skip to content

Commit 2e822de

Browse files
committed
code review
1 parent 8d88936 commit 2e822de

File tree

2 files changed

+20
-15
lines changed

2 files changed

+20
-15
lines changed

modules/deploy/pages/redpanda/manual/resilience/shadowing.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,17 @@ include::shared:partial$enterprise-license.adoc[]
1010

1111
Shadowing is Redpanda's enterprise-grade disaster recovery solution that establishes asynchronous, offset-preserving replication between two distinct Redpanda clusters. A cluster is able to create a dedicated client that continuously replicates source cluster data, including offsets, timestamps, and cluster metadata. This creates a read-only shadow cluster that you can quickly failover to handle production traffic during a disaster.
1212

13-
[IMPORTANT]
14-
====
15-
**Experiencing an active disaster?** See xref:deploy:redpanda/manual/resilience/shadowing-guide.adoc[Emergency Shadowing Failover] for immediate step-by-step emergency procedures.
16-
====
13+
include::shared:partial$emergency-shadowing-callout.adoc[]
1714

1815
Unlike traditional replication tools that re-produce messages, Shadowing copies data at the byte level, ensuring shadow topics contain identical copies of source topics with preserved offsets and timestamps.
1916

2017
Shadowing replicates:
2118

2219
* **Topic data**: All records with preserved offsets and timestamps
2320
* **Topic configurations**: Partition counts, retention policies, and other xref:reference:properties/topic-properties.adoc[topic properties]
24-
* **xref:develop:consume-data/consumer-offsets.adoc[Consumer group offsets]**: Enables seamless consumer resumption after failover
21+
* **Consumer group offsets**: Enables seamless consumer resumption after failover
2522
* **Access Control Lists (ACLs)**: User permissions and security policies
26-
* **xref:manage:schema-reg/schema-reg-overview.adoc[Schema Registry] data**: Schema definitions and compatibility settings
23+
* **Schema Registry data**: Schema definitions and compatibility settings
2724
2825
== How Shadowing fits into disaster recovery
2926

@@ -81,17 +78,16 @@ This service account authenticates from the shadow cluster to the source cluster
8178

8279
=== Network and authentication
8380

84-
You must configure network connectivity between clusters with appropriate firewall rules to allow the shadow cluster to connect to the source cluster for data replication. Shadowing uses a pull-based architecture where the shadow cluster fetches data from the source cluster.
81+
You must configure network connectivity between clusters with appropriate firewall rules to allow the shadow cluster to connect to the source cluster for data replication. Shadowing uses a pull-based architecture where the shadow cluster fetches data from the source cluster. For detailed networking configuration, see <<networking>>.
8582

8683
If using xref:manage:security/authentication.adoc[authentication] for the shadow link connection, configure the source cluster with your chosen authentication method (SASL/SCRAM, TLS, mTLS) and ensure the shadow cluster has the proper credentials to authenticate to the source cluster.
8784

8885
== Set up Shadowing
8986

9087
To set up Shadowing:
9188

92-
* **Understand replication behavior**: Before you set up Shadowing, review what topic properties, consumer groups, and security settings Redpanda automatically replicates versus what requires explicit configuration
93-
* **Configure filters**: Define which topics, consumer groups, and ACLs should replicate by creating include/exclude patterns that match your disaster recovery requirements
94-
* **Create a shadow link**: Establish the connection between clusters using `rpk`, the Admin API, or Redpanda Console with authentication and network settings
89+
* **Configure filters**: Define which topics, consumer groups, and ACLs should replicate by creating include/exclude patterns that match your disaster recovery requirements. See <<set-filters>>.
90+
* **Create a shadow link**: Establish the connection between clusters using `rpk`, the Admin API, or Redpanda Console with authentication and network settings. See <<create-a-shadow-link>>.
9591

9692
== What gets replicated
9793

@@ -143,16 +139,16 @@ Each filter uses two key settings:
143139
* **Pattern type**: Determines how names are matched
144140
- `LITERAL`: Matches names exactly (including the special wildcard `*` to match all items)
145141
- `PREFIX`: Matches names that start with the specified string
146-
* **Filter type**: Specifies whether to include or exclude matching items
142+
* **Filter type**: Specifies whether to INCLUDE or EXCLUDE matching items
147143
- `INCLUDE`: Replicate items that match the pattern
148144
- `EXCLUDE`: Skip items that match the pattern
149145

150146
==== Filter processing rules
151147

152-
Redpanda processes filters in the order you define them with exclude filters taking precedence. Design your filter lists carefully:
148+
Redpanda processes filters in the order you define them with EXCLUDE filters taking precedence. Design your filter lists carefully:
153149

154150
1. **Exclude filters win**: If any EXCLUDE filter matches a resource, it is excluded regardless of INCLUDE filters
155-
2. **Order matters for includes**: Among INCLUDE filters, the first match determines the result
151+
2. **Order matters for INCLUDE filters**: Among INCLUDE filters, the first match determines the result
156152
3. **Default behavior**: Items that don't match any filter are excluded from replication
157153

158154
==== Common filtering patterns
@@ -312,6 +308,8 @@ This creates a template configuration file that you can customize for your envir
312308

313309
Configure network connectivity between your source and shadow clusters to enable shadow link replication. The shadow cluster initiates connections to the source cluster using a pull-based architecture.
314310

311+
For additional details about networking, see <<network-and-authentication>>.
312+
315313
==== Connection requirements
316314

317315
* **Direction**: Shadow cluster connects to source cluster (outbound from shadow, inbound to source)
@@ -526,9 +524,11 @@ See also: link:/api/doc/admin/[Admin API v2 reference^]
526524

527525
== Failover
528526

527+
include::shared:partial$emergency-shadowing-callout.adoc[]
528+
529529
Failover is the process of modifying shadow topics or an entire shadow cluster from read-only replicas to fully writable resources, and ceasing replication from the source cluster. You can fail over individual topics for selective workload migration or fail over the entire cluster for comprehensive disaster recovery. This critical operation transforms your shadow resources into operational production assets, allowing you to redirect application traffic when the source cluster becomes unavailable.
530530

531-
=== Understanding failover behavior
531+
=== Failover behavior
532532

533533
When you initiate failover, Redpanda performs the following operations:
534534

@@ -612,7 +612,7 @@ After successful failover, your shadow cluster exhibits the following characteri
612612

613613
**Topic accessibility:**
614614

615-
* Failedover topics become fully writable and readable.
615+
* Failed over topics become fully writable and readable.
616616
* Applications can produce and consume messages normally.
617617
* All Kafka APIs are available for failedover topics.
618618
* Original offsets and timestamps are preserved.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[IMPORTANT]
2+
.Experiencing an active disaster?
3+
====
4+
See xref:deploy:redpanda/manual/resilience/shadowing-guide.adoc[Emergency Shadowing Failover] for immediate step-by-step emergency procedures.
5+
====

0 commit comments

Comments
 (0)