Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,13 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. From the *Shadow Link* page, select the shadow link you want to view.
. The *Overview* tab shows the state of the shadow link and its topics.
--

rpk::
+
--
Expand Down Expand Up @@ -159,6 +166,12 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
Capture the status from the *Shadow Link* page.
--

rpk::
+
--
Expand Down Expand Up @@ -251,6 +264,13 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. On your *Shadow Link* page, click *Failover All Topics*.
. Click to confirm the failover action. The failover process promotes all topics to writable status.
--

rpk::
+
--
Expand Down Expand Up @@ -287,6 +307,13 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. On your *Shadow Link* page, click the *Failover* button for the topics you want to failover.
. Click to confirm the failover action. The failover process promotes the selected topics to writable status.
--

rpk::
+
--
Expand Down Expand Up @@ -359,6 +386,13 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. From the *Shadow Link* page, select the shadow link you want to view.
. Click the *Tasks* tab to view all tasks and their status.
--

rpk::
+
--
Expand Down Expand Up @@ -427,6 +461,12 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
On your *Shadow Link* page, click *Delete*.
--

rpk::
+
--
Expand Down Expand Up @@ -480,6 +520,12 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
All failover actions in the Cloud UI include force delete functionality by default. When you failover a shadow link, all topics are immediately promoted to writable status.
--

rpk::
+
--
Expand Down
28 changes: 28 additions & 0 deletions modules/manage/pages/disaster-recovery/shadowing/failover.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. On the *Shadow Link* page, select your shadow link.
. For any of the topics you want to failover, click the corresponding *Failover* button.
. Click to confirm the failover action. The failover process promotes the selected topics to writable status.
--

rpk::
+
--
Expand Down Expand Up @@ -114,6 +122,14 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. On the *Shadow Link* page, select your shadow link.
. Click *Failover All Topics*.
. Click to confirm the failover action. The failover process promotes all topics to writable status.
--

rpk::
+
--
Expand Down Expand Up @@ -156,6 +172,12 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
All failover actions in the Cloud UI include force delete functionality by default. When you failover a shadow link, all topics are immediately promoted to writable status.
--

rpk::
+
--
Expand Down Expand Up @@ -223,6 +245,12 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
Track the progress of failover operations from the *Shadow Link* page in the Cloud UI.
--

rpk::
+
--
Expand Down
35 changes: 31 additions & 4 deletions modules/manage/pages/disaster-recovery/shadowing/monitor.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ include::shared:partial$emergency-shadowing-callout.adoc[]

== Status commands

To list existing shadow links, run:
To list existing shadow links:

ifndef::env-cloud[]
// tag::rpk-tab-list-links[]
Expand All @@ -31,6 +31,12 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
At the organization level of the Cloud UI, navigate to *Shadow Link*.
--

rpk::
+
--
Expand All @@ -50,7 +56,7 @@ curl 'https://api.redpanda.com/v1/shadow-links' \
======
endif::[]

To view shadow link configuration details, run:
To view shadow link configuration details:

ifndef::env-cloud[]
// tag::rpk-tab-view-link-details[]
Expand All @@ -66,6 +72,13 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. From the *Shadow Link* page, select the shadow link you want to view.
. Click the *Tasks* tab to view all tasks and their status.
--

rpk::
+
--
Expand All @@ -85,7 +98,7 @@ curl 'https://api.redpanda.com/v1/shadow-links/<shadow-link-id>' \
======
endif::[]

To check your shadow link status and ensure proper operation, run:
To check your shadow link status and ensure proper operation:

ifndef::env-cloud[]
// tag::rpk-tab-shadow-status[]
Expand All @@ -99,6 +112,13 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. From the *Shadow Link* page, select the shadow link you want to view.
. Click the *Tasks* tab to view all tasks and their status.
--

rpk::
+
--
Expand Down Expand Up @@ -127,7 +147,7 @@ curl "https://$DATAPLANE_API_URL/v1/shadowlinks/<shadow-link-name>/topic" \
--
======

The responses include the following:
The status includes the following:
endif::[]

* **Shadow link state**: Overall operational state (`ACTIVE`, `PAUSED`).
Expand Down Expand Up @@ -197,6 +217,13 @@ endif::[]
ifdef::env-cloud[]
[tabs]
======
Cloud UI::
+
--
. From the *Shadow Link* page, select the shadow link you want to view.
. Click the *Tasks* tab to view all tasks and their status.
--

rpk::
+
--
Expand Down
10 changes: 5 additions & 5 deletions modules/manage/pages/disaster-recovery/shadowing/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ include::shared:partial$enterprise-license.adoc[]
====
endif::[]

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.
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. Shadowing keeps data flowing, even during regional outages.

include::shared:partial$emergency-shadowing-callout.adoc[]

Expand Down Expand Up @@ -61,7 +61,7 @@ Shadowing for disaster recovery currently has the following limitations:

== Shadow link tasks

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.
Shadow linking operates through specialized tasks that handle different aspects of replication. If you use a `shadow-config.yaml` configuration file to create the shadow link, each task corresponds to a section in the file. Tasks run continuously to maintain synchronization with the source cluster.

[tabs]
====
Expand All @@ -71,7 +71,7 @@ Source Topic Sync::
[#source-topic-sync-task]
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.

The task is controlled by the `topic_metadata_sync_options` configuration section, which includes:
The task is controlled by the `topic_metadata_sync_options` section in the configuration file. It includes:

* **Auto-creation filters**: Determines which source topics automatically become shadow topics
* **Property synchronization**: Controls which topic properties replicate from source to shadow
Expand All @@ -87,7 +87,7 @@ Consumer Group Shadowing::
[#consumer-group-shadowing-task]
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.

The task is controlled by the `consumer_offset_sync_options` configuration section, which includes:
The task is controlled by the `consumer_offset_sync_options` section in the configuration file. It includes:

* **Group filters**: Determines which consumer groups have their offsets replicated
* **Sync interval**: How frequently to synchronize consumer group offsets
Expand All @@ -102,7 +102,7 @@ Security Migrator::
[#security-migrator-task]
The **Security Migrator task** replicates security policies, primarily ACLs (access control lists), from the source cluster to maintain consistent authorization across both environments.

The task is controlled by the `security_sync_options` configuration section, which includes:
The task is controlled by the `security_sync_options` section in the configuration file. It includes:

* **ACL filters**: Determines which security policies replicate
* **Sync interval**: How frequently to synchronize security settings
Expand Down
Loading