You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Monitor your shadow links to ensure proper replication performance and understand your disaster recovery readiness. Use `rpk` commands, metrics, and status information to track shadow link health and troubleshoot issues.
@@ -52,10 +53,10 @@ For troubleshooting specific issues, you can use command options to show individ
52
53
53
54
The status output includes:
54
55
55
-
* **Shadow link state**: Overall operational state (`ACTIVE`)
56
-
* **Individual topic states**: Current state of each replicated topic (`ACTIVE`, `FAULTED`, `FAILING_OVER`, `FAILED_OVER`)
56
+
* **Shadow link state**: Overall operational state (`ACTIVE`).
57
+
* **Individual topic states**: Current state of each replicated topic (`ACTIVE`, `FAULTED`, `FAILING_OVER`, `FAILED_OVER`).
57
58
* **Task status**: Health of replication tasks across brokers (`ACTIVE`, `FAULTED`, `NOT_RUNNING`, `LINK_UNAVAILABLE`). For details about shadow link tasks, see xref:manage:disaster-recovery/shadowing/setup.adoc#shadow-link-tasks[Shadow link tasks].
58
-
* **Lag information**: Replication lag per partition showing source vs shadow high watermarks (HWM)
59
+
* **Lag information**: Replication lag per partition showing source vs shadow high watermarks (HWM).
Copy file name to clipboardExpand all lines: modules/manage/pages/disaster-recovery/shadowing/overview.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ Shadowing for disaster recovery currently has the following limitations:
52
52
* During a disaster, xref:manage:audit-logging.adoc[audit log] history from the source cluster is lost, though the shadow cluster begins generating new audit logs immediately after the failover.
53
53
* After you failover shadow topics, automatic fallback to the original source cluster is not supported.
54
54
55
-
== Best Practices
55
+
== Best practices
56
56
57
57
To ensure reliable disaster recovery with Shadowing:
* **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>>.
117
117
* **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>>.
118
118
119
-
== Shadow Link Tasks
119
+
== Shadow link tasks
120
120
121
121
Shadow linking operates through specialized tasks that handle different aspects of replication. Each task corresponds to a configuration section in your shadow link setup and runs continuously to maintain synchronization with the source cluster.
122
122
123
123
[#source-topic-sync-task]
124
-
=== Source Topic Sync Task
124
+
=== Source Topic Sync task
125
125
126
-
The **Source Topic Sync Task** manages topic discovery and metadata synchronization. This task periodically queries the source cluster to discover available topics, applies your configured topic filters to determine which topics should become shadow topics, and synchronizes topic properties between clusters.
126
+
The **Source Topic Sync task** manages topic discovery and metadata synchronization. This task periodically queries the source cluster to discover available topics, applies your configured topic filters to determine which topics should become shadow topics, and synchronizes topic properties between clusters.
127
127
128
128
The task is controlled by the `topic_metadata_sync_options` configuration section, which includes:
129
129
@@ -135,7 +135,7 @@ The task is controlled by the `topic_metadata_sync_options` configuration sectio
135
135
When this task discovers a new topic that matches your filters, it creates the corresponding shadow topic and begins replication from your configured starting offset.
136
136
137
137
[#consumer-group-shadowing-task]
138
-
=== Consumer Group Shadowing Task
138
+
=== Consumer Group Shadowing task
139
139
140
140
The **Consumer Group Shadowing task** replicates consumer group offsets and membership information from the source cluster. This ensures that consumer applications can resume processing from the correct position after failover.
141
141
@@ -148,9 +148,9 @@ The task is controlled by the `consumer_offset_sync_options` configuration secti
148
148
This task runs on brokers that host the `__consumer_offsets` topic and continuously tracks consumer group coordinators to optimize offset synchronization.
149
149
150
150
[#security-migrator-task]
151
-
=== Security Migrator Task
151
+
=== Security Migrator task
152
152
153
-
The **Security Migrator task** replicates security policies, primarily ACLs (Access Control Lists), from the source cluster to maintain consistent authorization across both environments.
153
+
The **Security Migrator task** replicates security policies, primarily ACLs (access control lists), from the source cluster to maintain consistent authorization across both environments.
154
154
155
155
The task is controlled by the `security_sync_options` configuration section, which includes:
156
156
@@ -159,7 +159,7 @@ The task is controlled by the `security_sync_options` configuration section, whi
159
159
160
160
By default, all ACLs replicate to ensure your shadow cluster maintains the same security posture as your source cluster.
161
161
162
-
=== Task Status and Monitoring
162
+
=== Task status and monitoring
163
163
164
164
Each task reports its status through the shadow link status API. Task states include:
165
165
@@ -218,7 +218,7 @@ The filtering system you configure determines the precise scope of replication a
218
218
219
219
Filters determine which resources Shadowing automatically creates when establishing your shadow link.
220
220
221
-
Topic filters select which topics Shadowing automatically creates as shadow topics when they appear on the source cluster. Once Shadowing creates a shadow topic, it continues replicating until you failover the topic, delete it, or delete the entire shadow link.
221
+
Topic filters select which topics Shadowing automatically creates as shadow topics when they appear on the source cluster. After Shadowing creates a shadow topic, it continues replicating until you failover the topic, delete it, or delete the entire shadow link.
222
222
223
223
Consumer group and ACL filters control which groups and security policies replicate to maintain application functionality.
224
224
@@ -300,7 +300,7 @@ schema_registry_sync_options:
300
300
- The `_schemas` topic must not exist on the shadow cluster, or must be empty
301
301
- Once enabled, the `_schemas` topic will be replicated completely
302
302
303
-
**Important:** Once the `_schemas` topic becomes a shadow topic, it cannot be stopped without either failing over the topic or deleting it entirely.
303
+
**Important:** After the `_schemas` topic becomes a shadow topic, it cannot be stopped without either failing over the topic or deleting it entirely.
304
304
305
305
306
306
=== System topic filtering rules
@@ -402,7 +402,7 @@ topic_metadata_sync_options:
402
402
403
403
[IMPORTANT]
404
404
====
405
-
The starting offset only affects **new shadow topics**. Once a shadow topic exists and has data, changing this setting has no effect on that topic's replication.
405
+
The starting offset only affects **new shadow topics**. After a shadow topic exists and has data, changing this setting has no effect on that topic's replication.
0 commit comments