-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from redpanda-data/#2524-update-readme-and-add-…
…api-files #2524 update readme and add api files
- Loading branch information
Showing
27 changed files
with
142 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| = Remote Read Replicas | ||
| :description: Learn how to create a remote read replica topic, which is a read-only topic that mirrors a topic on a different cluster. | ||
| :page-cloud: true | ||
| :page-beta: true | ||
|
|
||
| A remote read replica topic is a read-only topic that mirrors a topic on a different cluster. You can create a separate remote cluster just for consumers of this topic and populate its topics from object storage. A read-only topic on a remote cluster can serve any consumer, without increasing the load on the source cluster. Because these read-only topics access data directly from object storage, there's no impact to the performance of the cluster. | ||
|
|
||
| Redpanda Cloud supports remote read replicas with ephemeral BYOC clusters (not with a customer-managed VPC). Ephemeral clusters are temporary clusters created to handle specific, transient workloads or tasks. After processing, the cluster is terminated to free up resources and reduce costs. | ||
|
|
||
| == Prerequisites | ||
|
|
||
| * A BYOC source cluster in Ready state. | ||
| * A BYOC reader cluster in Ready state. This separate reader cluster must exist in the same Redpanda organization and the same cloud provider account and region as the source cluster. | ||
|
|
||
| == Configure remote read replicas | ||
|
|
||
| You can add or remove reader clusters to a source cluster in Redpanda Cloud with the xref:api:ROOT:cloud-api.adoc[Cloud API]. For information on accessing the Cloud API, see xref:manage:api/cloud-api-authentication.adoc[]. | ||
|
|
||
| . To update your source cluster to add one or more reader cluster IDs, make a xref:api:ROOT:cloud-api.adoc#patch-/v1beta2/clusters/-cluster.id-[`PATCH /v1beta2/clusters/\{cluster.id}`] request. The full list of clusters is expected on every call. If an ID is removed from the list, it will be removed as a reader cluster. | ||
| + | ||
| ```bash | ||
| export SOURCE_CLUSTER_ID=....... | ||
| export READER_CLUSTER_ID=....... | ||
|
|
||
| curl -X PATCH $API_HOST/v1beta2/clusters/$SOURCE_CLUSTER_ID \ | ||
| -H "Content-Type: application/json" \ | ||
| -H "Authorization: Bearer $API_TOKEN" \ | ||
| -d @- << EOF | ||
| { | ||
| "read_replica_cluster_ids": ["$READER_CLUSTER_ID"] | ||
| } | ||
| EOF | ||
| ``` | ||
|
|
||
| . To create a remote read replica topic, run: | ||
| + | ||
| ```bash | ||
| rpk topic create my-topic -c redpanda.remote.readreplica=redpanda-cloud-storage-${SOURCE_CLUSTER_ID} | ||
| ``` | ||
|
|
||
| . Optional: To see the list of reader clusters on a given source cluster, make a xref:api:ROOT:cloud-api.adoc#get-/v1beta2/clusters/-id-[`GET /v1beta2/clusters/\{id}`] request: | ||
| + | ||
| ```bash | ||
| export SOURCE_CLUSTER_ID=....... | ||
|
|
||
| curl -X GET $API_HOST/v1beta2/clusters/$SOURCE_CLUSTER_ID \ | ||
| -H "Content-Type: application/json" \ | ||
| -H "Authorization: Bearer $API_TOKEN" | ||
| ``` | ||
|
|
||
| . Optional: For remote read replicas reading from a live topic (that is, a topic that's being actively written to by a source cluster), it may be advantageous to control how often segments are flushed to object storage. By default, this is set to 60 minutes. To tune `cloud_storage_segment_max_upload_interval_sec` on the source cluster, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda support^]. (For cold topics, where segments are closed and older than 60 minutes, this configuration is unnecessary: the data is already uploaded to object storage.) | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| A source cluster cannot be deleted if it has remote read replica topics. When you delete a reader cluster, that cluster's ID is removed from any existing source cluster `read_replica_cluster_ids` lists. | ||
| ==== | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,9 @@ | ||
| = rpk Commands | ||
| :description: This page contains an alphabetized list of `rpk` commands. Each command includes a table of flags and their descriptions. | ||
| :description: pass:q[Index page of `rpk` commands for Redpanda Cloud in alphabetical order.] | ||
|
|
||
| You can also get descriptions for each flag by running `rpk <command> --help` in your locally-installed Redpanda, and you can get descriptions of all rpk-specific options by running `rpk -X help`. | ||
| :page-layout: index | ||
| Each `rpk` command includes a table of flags and their descriptions. You can also get descriptions for each flag by running `rpk <command> --help`, and you can get descriptions of all `rpk`-specific options by running `rpk -X help`. | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| All `rpk` commands feature autocompletion. To use the feature, press tab. See xref:ROOT:reference:rpk/rpk-generate/rpk-generate-shell-completion.adoc[`rpk generate shell-completion`]. | ||
| ==== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters