From ee4d21314adaa1c8a0d49050ed89dcd561d757e0 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Mon, 3 Aug 2026 16:12:11 -0700 Subject: [PATCH 1/3] Fix GCP throughput tier in API examples --- modules/manage/partials/controlplane-api.adoc | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/modules/manage/partials/controlplane-api.adoc b/modules/manage/partials/controlplane-api.adoc index c343d8759..198bb5b84 100644 --- a/modules/manage/partials/controlplane-api.adoc +++ b/modules/manage/partials/controlplane-api.adoc @@ -255,13 +255,13 @@ curl -d \ "name": "my-new-cluster", "resource_group_id": "", "network_id": "", - "region": "us-west1", - "throughput_tier": "tier-1-gcp-um4g", + "region": "us-central1", + "throughput_tier": "", "type": "TYPE_DEDICATED", "zones": [ - "us-west1-a", - "us-west1-b", - "us-west1-c" + "us-central1-a", + "us-central1-b", + "us-central1-c" ], "cluster_configuration": { "custom_properties": { @@ -272,6 +272,8 @@ curl -d \ }' -H "Content-Type: application/json" \ -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1/clusters ---- + +Replace `` with a usage tier that is valid for your region and cluster type. For example, `tier-1-gcp-v2-x86`. See the link:/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers[Control Plane API reference] for the full list of regions, zones, and tiers. endif::[] ifdef::env-byoc[] [,bash] @@ -285,7 +287,7 @@ curl -d \ "resource_group_id": "", "network_id": "", "region": "us-west1", - "throughput_tier": "tier-1-gcp-um4g", + "throughput_tier": "", "type": "TYPE_BYOC", "zones": [ "us-west1-a", @@ -301,6 +303,8 @@ curl -d \ }' -H "Content-Type: application/json" \ -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1/clusters ---- + +Replace `` with a usage tier that is valid for your region and cluster type. For example, `tier-1-gcp-v2-x86`. See the link:/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers[Control Plane API reference] for the full list of regions, zones, and tiers. endif::[] The Create Cluster endpoint returns a <>. When the operation completes, you can retrieve cluster details by calling link:/api/doc/cloud-controlplane/operation/operation-clusterservice_getcluster[`GET /v1/clusters/\{id}`], and passing the cluster ID as a parameter. From db56d2ed8772c0cc2435618ac0a9f5bb7afd4287 Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Mon, 3 Aug 2026 16:20:41 -0700 Subject: [PATCH 2/3] DOC-2379: Align Dedicated network example region with cluster example The Dedicated cluster example uses us-central1, but the preceding network example still created the network in us-west1. Reusing that network for the cluster fails with REASON_CLUSTER_NETWORK_REGION_MISMATCH, so align the network example to us-central1. Co-Authored-By: Claude Opus 4.8 (1M context) --- modules/manage/partials/controlplane-api.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/manage/partials/controlplane-api.adoc b/modules/manage/partials/controlplane-api.adoc index 198bb5b84..0a632f52a 100644 --- a/modules/manage/partials/controlplane-api.adoc +++ b/modules/manage/partials/controlplane-api.adoc @@ -105,7 +105,7 @@ curl -d \ "cluster_type": "TYPE_DEDICATED", "name": "", "resource_group_id": "", - "region": "us-west1" + "region": "us-central1" } }' -H "Content-Type: application/json" \ -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1/networks From 6d0389a2ce8359bd80f35151584c83402be84e4a Mon Sep 17 00:00:00 2001 From: Kat Batuigas Date: Mon, 3 Aug 2026 18:19:17 -0700 Subject: [PATCH 3/3] DOC-2379: Single-source the GCP example region via an attribute Define :gcp-region: once per environment (us-central1 for Dedicated, us-west1 for BYOC) and reference it in the create-network and create-cluster examples for both the region field and the zones, with subs="+attributes" on the affected code blocks. This makes the network and cluster regions structurally impossible to drift apart (a mismatch is rejected with REASON_CLUSTER_NETWORK_REGION_MISMATCH), rather than relying on two literals happening to agree. Co-Authored-By: Claude Opus 4.8 (1M context) --- modules/manage/partials/controlplane-api.adoc | 34 +++++++++++-------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/modules/manage/partials/controlplane-api.adoc b/modules/manage/partials/controlplane-api.adoc index 0a632f52a..153870818 100644 --- a/modules/manage/partials/controlplane-api.adoc +++ b/modules/manage/partials/controlplane-api.adoc @@ -1,3 +1,9 @@ +// GCP region for the create-network and create-cluster examples below. +// Defined once per environment so the network and cluster regions can't drift +// (a mismatch is rejected with REASON_CLUSTER_NETWORK_REGION_MISMATCH). +ifdef::env-dedicated[:gcp-region: us-central1] +ifdef::env-byoc[:gcp-region: us-west1] + The Redpanda Cloud API is a collection of REST APIs that allow you to interact with different parts of Redpanda Cloud. The Control Plane API enables you to programmatically manage your organization's Redpanda infrastructure outside of the Cloud UI. You can call the API endpoints directly, or use tools like Terraform or Python scripts to automate cluster management. See link:/api/doc/cloud-controlplane/[Control Plane API] for the full API reference documentation. @@ -95,7 +101,7 @@ Create a network by making a request to link:/api/doc/cloud-controlplane/operati Choose a xref:networking:cidr-ranges.adoc[CIDR range] that does not overlap with your existing VPCs or your Redpanda network. ifdef::env-dedicated[] -[,bash] +[,bash,subs="+attributes"] ---- curl -d \ '{ @@ -105,14 +111,14 @@ curl -d \ "cluster_type": "TYPE_DEDICATED", "name": "", "resource_group_id": "", - "region": "us-central1" + "region": "{gcp-region}" } }' -H "Content-Type: application/json" \ -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1/networks ---- endif::[] ifdef::env-byoc[] -[,bash] +[,bash,subs="+attributes"] ---- curl -d \ '{ @@ -122,7 +128,7 @@ curl -d \ "cluster_type": "TYPE_BYOC", "name": "", "resource_group_id": "", - "region": "us-west1" + "region": "{gcp-region}" } }' -H "Content-Type: application/json" \ -H "Authorization: Bearer " -X POST https://api.redpanda.com/v1/networks @@ -245,7 +251,7 @@ This endpoint returns a <>. After the network is created, make a request to the link:/api/doc/cloud-controlplane/operation/operation-clusterservice_createcluster[`POST /v1/clusters`] with the resource group ID and network ID in the request body. ifdef::env-dedicated[] -[,bash] +[,bash,subs="+attributes"] ---- curl -d \ '{ @@ -255,13 +261,13 @@ curl -d \ "name": "my-new-cluster", "resource_group_id": "", "network_id": "", - "region": "us-central1", + "region": "{gcp-region}", "throughput_tier": "", "type": "TYPE_DEDICATED", "zones": [ - "us-central1-a", - "us-central1-b", - "us-central1-c" + "{gcp-region}-a", + "{gcp-region}-b", + "{gcp-region}-c" ], "cluster_configuration": { "custom_properties": { @@ -276,7 +282,7 @@ curl -d \ Replace `` with a usage tier that is valid for your region and cluster type. For example, `tier-1-gcp-v2-x86`. See the link:/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers[Control Plane API reference] for the full list of regions, zones, and tiers. endif::[] ifdef::env-byoc[] -[,bash] +[,bash,subs="+attributes"] ---- curl -d \ '{ @@ -286,13 +292,13 @@ curl -d \ "name": "my-new-cluster", "resource_group_id": "", "network_id": "", - "region": "us-west1", + "region": "{gcp-region}", "throughput_tier": "", "type": "TYPE_BYOC", "zones": [ - "us-west1-a", - "us-west1-b", - "us-west1-c" + "{gcp-region}-a", + "{gcp-region}-b", + "{gcp-region}-c" ], "cluster_configuration": { "custom_properties": {