Skip to content
Merged
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
75 changes: 41 additions & 34 deletions modules/manage/partials/remote-read-replicas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,46 +63,53 @@ To set up a Remote Read Replica topic on a separate remote cluster:
* If that's a single-region bucket/container, the remote cluster must be in the same 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):
+
|===
| Property | Description

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_enabled[`cloud_storage_enabled`]
| Must be set to `true` to enable object storage.

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_bucket[`cloud_storage_bucket`]
| No AWS or GCS bucket is needed for the remote cluster.

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_access_key[`cloud_storage_access_key`]
| AWS or GCS access key. +
Required for AWS and GCS authentication with access keys.

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_secret_key[`cloud_storage_secret_key`]
| AWS or GCS secret key. +
Required for AWS and GCS authentication with access keys.

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_region[`cloud_storage_region`]
| Object storage region of the remote cluster. +
Required for AWS and GCS.
[tabs]
======
Amazon S3::
+
--
[source,yaml]
----
cloud_storage_enabled : true
cloud_storage_access_key : <your-acess-key>
cloud_storage_secret_key : <your-secret-key>
cloud_storage_region : <your-region>
cloud_storage_bucket : <your-bucket> #Optional. Should not be changed after writing data to it
----

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_api_endpoint[`cloud_storage_api_endpoint`]
| AWS or GCS API endpoint. +
- For AWS, this can be left blank. It's generated automatically using the region and bucket. +
- For GCS, use `storage.googleapis.com`.
WARNING: Modifying the `cloud_storage_bucket` property after writing data to a bucket could cause data loss.

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_azure_container[`cloud_storage_azure_container`]
| Azure container name. +
Required for ABS.
--
Google Cloud Storage::
+
--
[source,yaml]
----
cloud_storage_enabled : true
cloud_storage_access_key : <your-acess-key>
cloud_storage_secret_key : <your-secret-key>
cloud_storage_region : <your-region>
cloud_storage_api_endpoint : `storage.googleapis.com`
cloud_storage_bucket : <your-bucket> #Optional. Should not be changed after writing data to it.
----

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_azure_storage_account[`cloud_storage_azure_storage_account`]
| Azure account name. +
Required for ABS.
WARNING: Modifying the `cloud_storage_bucket` property after writing data to a bucket could cause data loss.

| xref:reference:properties/object-storage-properties.adoc#cloud_storage_azure_shared_key[`cloud_storage_azure_shared_key`]
| Azure shared key. +
Required for ABS.
|===
--
Azure Blob Storage::
+
--
[source,yaml]
----
cloud_storage_enabled : true
cloud_storage_azure_container : <your-container>
cloud_storage_azure_storage_account : <your-storage-account>
cloud_storage_azure_shared_key: <your-shared-key>
----
--

WARNING: Modifying `cloud_storage_bucket` property after writing data to a bucket could cause data loss.
======

For a complete reference on object storage properties, see xref:reference:properties/object-storage-properties.adoc[].
endif::[]
Expand Down
Loading