Skip to content

Commit

Permalink
Clarify support for cross region Tiered Storage / RRR (#942)
Browse files Browse the repository at this point in the history
Co-authored-by: Paulo Borges <[email protected]>
  • Loading branch information
kbatuigas and Deflaimun authored Jan 14, 2025
1 parent 39b010e commit 4e66e5f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
18 changes: 7 additions & 11 deletions modules/manage/partials/remote-read-replicas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,10 @@ You can create Remote Read Replica topics in a Redpanda cluster that directly ac

[IMPORTANT]
====
- The Remote Read Replica cluster must run on the same version of Redpanda as the origin cluster, or just one feature release ahead of the origin cluster. For example, if the origin cluster is version 23.1, the Remote Read Replica cluster can be 23.2, but not 23.4. It cannot skip feature releases.
- The Remote Read Replica cluster must run on the same version of Redpanda as the origin cluster, or just one feature release ahead of the origin cluster. For example, if the origin cluster is version 24.1, the Remote Read Replica cluster can be 24.2, but not 24.3. It cannot skip feature releases.
- When upgrading, upgrade the Remote Read Replica cluster before upgrading the origin cluster.
- When upgrading to Redpanda 23.2, metadata from object storage is not synchronized until all brokers in the cluster are upgraded. If you need to force a mixed-version cluster to sync read replicas, move partition leadership to brokers running the original version.
====

TIP: To create a Remote Read Replica topic in another region, consider using a https://aws.amazon.com/s3/features/multi-region-access-points/[multi-region bucket^] to simplify deployment and optimize performance.

ifdef::env-kubernetes[]
helm_ref:storage.tiered.config[]
endif::[]
Expand All @@ -36,11 +33,12 @@ endif::[]

You need the following:

* An origin cluster with xref:{tiered-storage-link}#set-up-tiered-storage[Tiered Storage] set up.
* An origin cluster with xref:{tiered-storage-link}#set-up-tiered-storage[Tiered Storage] set up. Multi-region buckets or containers are not supported.
* A topic on the origin cluster, which you can use as a Remote Read Replica topic on the remote cluster.
* A separate remote cluster in the same region as the bucket or container used for the origin cluster.
** If you use a multi-region bucket/container, you can create the read replica cluster in any region that has that bucket/container.
** If you use a single-region bucket/container, the remote cluster must be in the same region as the bucket/container.
* A separate remote cluster.
** AWS: The remote cluster must be in the same region as the origin cluster's storage bucket/container.
** GCP: The remote cluster can be in the same or a different region as the bucket/container.
** Azure: Remote read replicas are not supported.

include::shared:partial$enterprise-license.adoc[]

Expand All @@ -58,9 +56,7 @@ You must configure access to the same object storage as the origin cluster.
ifndef::env-kubernetes[]
To set up a Remote Read Replica topic on a separate remote cluster:

. Create a remote cluster for the Remote Read Replica topic.
* If that's a multi-region bucket/container, you can create the read replica cluster in any region that has that bucket/container.
* If that's a single-region bucket/container, the remote cluster must be in the same region as the bucket/container.
. Create a remote cluster for the Remote Read Replica topic. For AWS, the remote cluster must be in the same region as the origin cluster's storage bucket/container. For GCP, the remote cluster can be in the same or a different region as the bucket/container.
. Run `rpk cluster config edit`, and then specify properties specific to your object storage provider (your cluster will require a restart after any changes to these properties):
+
|===
Expand Down
1 change: 1 addition & 0 deletions modules/manage/partials/tiered-storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ rpk cluster license info

- Migrating topics from one object storage provider to another is not supported.
- Migrating topics from one bucket or container to another is not supported.
- Multi-region buckets or containers are not supported.

CAUTION: Redpanda strongly recommends that you do not re-enable Tiered Storage after previously enabling and disabling it. Re-enabling Tiered Storage can result in inconsistent data and data gaps in Tiered Storage for a topic.

Expand Down

0 comments on commit 4e66e5f

Please sign in to comment.