Skip to content

Update PCR docs re: JSON typo & regions guidance #21562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rmloveland merged 2 commits into from
Dec 10, 2025
Merged

Update PCR docs re: JSON typo & regions guidance #21562

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24c67e3
Update PCR docs re: JSON typo & regions guidance
rmloveland Dec 9, 2025
ed46b08
Merge branch 'main' into 20251209-DOC-15580-fix-pcr-doc-bugs
rmloveland Dec 10, 2025
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
9 changes: 6 additions & 3 deletions src/current/cockroachcloud/physical-cluster-replication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ For the schema of each API response, refer to the [CockroachDB Cloud API referen

To use PCR, it is necessary to set the `supports_cluster_virtualization` field to `true`. This setting enables cluster virtualization, which is the architecture that supports PCR. For details on supported cluster cloud provider and region setup, refer to the [prerequisites section](#before-you-begin).

{{site.data.alerts.callout_info}}
If you are creating clusters in AWS or Azure, you must start the primary and standby clusters in different regions.
{{site.data.alerts.end}}

1. Send a `POST` [request](https://www.cockroachlabs.com/docs/api/cloud/v1.html#post-/api/v1/physical-replication-streams) to create the primary cluster:

{% include_cached copy-clipboard.html %}
Expand All @@ -73,7 +77,8 @@ To use PCR, it is necessary to set the `supports_cluster_virtualization` field t
"dedicated": {
"cockroachVersion": "v25.2",
"hardware": {
"disk_iops": 0 "machine_spec": {
"disk_iops": 0,
"machine_spec": {
"num_virtual_cpus": 4
},
"storage_gib": 16
Expand Down Expand Up @@ -126,8 +131,6 @@ Replace:
- `{api_secret_key}` with your API secret key.
- `{standby_cluster_id}` with the cluster ID returned after creating the standby cluster.

If you're creating clusters in AWS or Azure, you must start the primary and standby clusters in different regions.

{{site.data.alerts.callout_success}}
We recommend [enabling Prometheus metrics export]({% link cockroachcloud/export-metrics.md %}) on your cluster before starting a PCR stream. For details on metrics to track, refer to [Monitor the PCR stream](#step-3-monitor-the-pcr-stream).
{{site.data.alerts.end}}
Expand Down
Loading