Skip to content

Commit d03032b

Browse files
committed
minor edits
1 parent e7cd2b7 commit d03032b

File tree

5 files changed

+20
-18
lines changed

5 files changed

+20
-18
lines changed

modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,9 @@ Name: <topic-name>, State: ACTIVE
132132

133133
The partition information shows:
134134

135-
* **SRC_LSO**: Source partition Last Stable Offset
136-
* **SRC_HWM**: Source partition High Watermark
137-
* **DST_HWM**: Shadow (destination) partition High Watermark
135+
* **SRC_LSO**: Source partition last stable offset
136+
* **SRC_HWM**: Source partition high watermark
137+
* **DST_HWM**: Shadow (destination) partition high watermark
138138
* **Lag**: Message count difference between source and shadow partitions
139139

140140
[IMPORTANT]

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ include::shared:partial$enterprise-license.adoc[]
1212
endif::[]
1313

1414
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.
15+
1516
include::shared:partial$emergency-shadowing-callout.adoc[]
1617

1718
== Failover behavior

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ include::shared:partial$enterprise-license.adoc[]
1212
endif::[]
1313

1414
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.
15+
1516
include::shared:partial$emergency-shadowing-callout.adoc[]
1617

1718
== Status commands
@@ -52,10 +53,10 @@ For troubleshooting specific issues, you can use command options to show individ
5253

5354
The status output includes:
5455

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`).
5758
* **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).
5960

6061
[[shadow-link-metrics]]
6162
== Metrics

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Shadowing for disaster recovery currently has the following limitations:
5252
* 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.
5353
* After you failover shadow topics, automatic fallback to the original source cluster is not supported.
5454

55-
== Best Practices
55+
== Best practices
5656

5757
To ensure reliable disaster recovery with Shadowing:
5858

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ifndef::env-cloud[]
99
include::shared:partial$shadow-link-management-tip.adoc[]
1010
endif::[]
1111

12-
ifndef::env-cloud[]
12+
ifdef::env-cloud[]
1313
include::shared:partial$shadow-link-cloud-tip.adoc[]
1414
endif::[]
1515

@@ -116,14 +116,14 @@ To set up Shadowing:
116116
* **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>>.
117117
* **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>>.
118118

119-
== Shadow Link Tasks
119+
== Shadow link tasks
120120

121121
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.
122122

123123
[#source-topic-sync-task]
124-
=== Source Topic Sync Task
124+
=== Source Topic Sync task
125125

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

128128
The task is controlled by the `topic_metadata_sync_options` configuration section, which includes:
129129

@@ -135,7 +135,7 @@ The task is controlled by the `topic_metadata_sync_options` configuration sectio
135135
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.
136136

137137
[#consumer-group-shadowing-task]
138-
=== Consumer Group Shadowing Task
138+
=== Consumer Group Shadowing task
139139

140140
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.
141141

@@ -148,9 +148,9 @@ The task is controlled by the `consumer_offset_sync_options` configuration secti
148148
This task runs on brokers that host the `__consumer_offsets` topic and continuously tracks consumer group coordinators to optimize offset synchronization.
149149

150150
[#security-migrator-task]
151-
=== Security Migrator Task
151+
=== Security Migrator task
152152

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

155155
The task is controlled by the `security_sync_options` configuration section, which includes:
156156

@@ -159,7 +159,7 @@ The task is controlled by the `security_sync_options` configuration section, whi
159159

160160
By default, all ACLs replicate to ensure your shadow cluster maintains the same security posture as your source cluster.
161161

162-
=== Task Status and Monitoring
162+
=== Task status and monitoring
163163

164164
Each task reports its status through the shadow link status API. Task states include:
165165

@@ -218,7 +218,7 @@ The filtering system you configure determines the precise scope of replication a
218218

219219
Filters determine which resources Shadowing automatically creates when establishing your shadow link.
220220

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

223223
Consumer group and ACL filters control which groups and security policies replicate to maintain application functionality.
224224

@@ -300,7 +300,7 @@ schema_registry_sync_options:
300300
- The `_schemas` topic must not exist on the shadow cluster, or must be empty
301301
- Once enabled, the `_schemas` topic will be replicated completely
302302

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

305305

306306
=== System topic filtering rules
@@ -402,7 +402,7 @@ topic_metadata_sync_options:
402402

403403
[IMPORTANT]
404404
====
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.
406406
====
407407

408408
=== Generate a sample configuration

0 commit comments

Comments
 (0)