diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index a3b07da..7c29b45 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -572,7 +572,7 @@ components: schema_registry: $ref: '#/components/schemas/SchemaRegistrySpec' throughput_tier: - description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api/#api-description) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' + description: '[Throughput tier](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' type: string type: $ref: '#/components/schemas/Cluster.Type' @@ -1441,7 +1441,7 @@ components: $ref: '#/components/schemas/User' type: object HTTPProxySpec: - description: Cluster's HTTP Proxy properties. See [Use Redpanda with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/) and the [HTTP Proxy API reference](https://docs.redpanda.com/api/pandaproxy-rest) for more information. + description: Cluster's HTTP Proxy properties. See [Use Redpanda with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/) and the [HTTP Proxy API reference](https://docs.redpanda.com/api/doc/http-proxy) for more information. properties: mtls: $ref: '#/components/schemas/MTLSSpec' @@ -2428,7 +2428,7 @@ components: title: SASL configuration type: object SchemaRegistrySpec: - description: Cluster's Schema Registry properties. See the [Schema Registry overview](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-overview/) and the [Schema Registry API reference](https://docs.redpanda.com/api/pandaproxy-schema-registry) for more information. + description: Cluster's Schema Registry properties. See the [Schema Registry overview](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-overview/) and the [Schema Registry API reference](https://docs.redpanda.com/api/doc/schema-registry) for more information. properties: mtls: $ref: '#/components/schemas/MTLSSpec' @@ -3232,11 +3232,7 @@ components: x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap type: oauth2 info: - description: |- -

Regions

Tiers define the sizing of a cluster and provide tested and guaranteed workload configurations for throughput, logical partitions, and connections. Availability depends on the region and the cluster type (BYOC, Dedicated). See Dedicated tiers and BYOC tiers for further details.

GCP

-
RegionZonesThroughput Tiers
europe-west9europe-west9-a,europe-west9-b,europe-west9-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-southwest1europe-southwest1-a,europe-southwest1-b,europe-southwest1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-west1southamerica-west1-btier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-east1asia-east1-a,asia-east1-b,asia-east1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-northeast1asia-northeast1-a,asia-northeast1-b,asia-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-south1asia-south1-a,asia-south1-b,asia-south1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-southeast1asia-southeast1-a,asia-southeast1-b,asia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
australia-southeast1australia-southeast1-a,australia-southeast1-b,australia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west1europe-west1-b,europe-west1-c,europe-west1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west2europe-west2-a,europe-west2-b,europe-west2-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west3europe-west3-a,europe-west3-b,europe-west3-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: Dedicated, BYOC
tier-7-gcp-v2-x86: Dedicated, BYOC
tier-8-gcp-v2-x86: Dedicated, BYOC
tier-9-gcp-v2-x86: Dedicated, BYOC
europe-west4europe-west4-a,europe-west4-b,europe-west4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
northamerica-northeast1northamerica-northeast1-a,northamerica-northeast1-b,northamerica-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-east1southamerica-east1-b,southamerica-east1-c,southamerica-east1-atier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-central1us-central1-a,us-central1-b,us-central1-c,us-central1-ftier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east1us-east1-b,us-east1-c,us-east1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east4us-east4-a,us-east4-b,us-east4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-west1us-west1-a,us-west1-b,us-west1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC

AWS

-
RegionZonesThroughput Tiers
ap-southeast-3apse3-az1,apse3-az2,apse3-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
eu-north-1eun1-az1,eun1-az2,eun1-az3tier-1-aws-v3-arm: BYOC
tier-2-aws-v3-arm: BYOC
tier-3-aws-v3-arm: BYOC
tier-4-aws-v3-arm: BYOC
tier-5-aws-v3-arm: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v3-arm: BYOC
eu-south-1eus1-az1,eus1-az2,eus1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
eu-west-3euw3-az1,euw3-az2,euw3-az3tier-1-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-6-aws-v2-arm: Dedicated, BYOC
tier-7-aws-v2-arm: Dedicated, BYOC
tier-8-aws-v2-arm: Dedicated, BYOC
tier-9-aws-v2-arm: Dedicated, BYOC
ap-east-1ape1-az1,ape1-az2,ape1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
ap-northeast-1apne1-az4,apne1-az1,apne1-az2tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
af-south-1afs1-az1,afs1-az2,afs1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
ap-south-1aps1-az1,aps1-az2,aps1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ap-southeast-1apse1-az1,apse1-az2,apse1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ap-southeast-2apse2-az1,apse2-az3,apse2-az2tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ca-central-1cac1-az1,cac1-az2,cac1-az4tier-1-aws-v2-arm: Dedicated, BYOC
tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-arm: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-arm: BYOC
tier-9-aws-v2-x86: BYOC
eu-central-1euc1-az2,euc1-az3,euc1-az1tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
eu-west-1euw1-az1,euw1-az2,euw1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
eu-west-2euw2-az1,euw2-az2,euw2-az3tier-1-aws-v2-arm: Dedicated, BYOC
tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-arm: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-arm: BYOC
tier-9-aws-v2-x86: BYOC
me-central-1mec1-az1,mec1-az2,mec1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
sa-east-1sae1-az1,sae1-az2,sae1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
us-east-1use1-az2,use1-az4,use1-az5,use1-az6tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
us-east-2use2-az1,use2-az2,use2-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
us-west-2usw2-az1,usw2-az2,usw2-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC

AZURE

-
RegionZonesThroughput Tiers
eastuseastus-az1,eastus-az2,eastus-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
uksouthuksouth-az1,uksouth-az2,uksouth-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
norwayeastnorwayeast-az1,norwayeast-az2,norwayeast-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
centraluscentralus-az1,centralus-az2,centralus-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
eastus2eastus2-az1,eastus2-az2,eastus2-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
northeuropenortheurope-az1,northeurope-az2,northeurope-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
westeuropewesteurope-az1,westeurope-az2,westeurope-az3tier-1-azure-v3-x86: BYOC
tier-2-azure-v3-x86: BYOC
tier-3-azure-v3-x86: BYOC
tier-4-azure-v3-x86: BYOC
tier-5-azure-v3-x86: BYOC
westus2westus2-az1,westus2-az2,westus2-az3tier-1-azure-v3-x86: BYOC
tier-2-azure-v3-x86: BYOC
tier-3-azure-v3-x86: BYOC
tier-4-azure-v3-x86: BYOC
tier-5-azure-v3-x86: BYOC
+ description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clusters and networks.' title: Redpanda Cloud Control Plane API version: v1 openapi: 3.0.3 @@ -3360,11 +3356,11 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: List Clusters + summary: List clusters tags: - Clusters post: - description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/cloud-controlplane-api.html#api-description) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). + description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). operationId: ClusterService_CreateCluster requestBody: content: @@ -3449,7 +3445,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Create Cluster + summary: Create cluster tags: - Clusters /v1/clusters/{cluster.id}: @@ -3567,7 +3563,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Update Cluster + summary: Update cluster tags: - Clusters /v1/clusters/{id}: @@ -3610,7 +3606,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Delete Cluster + summary: Delete cluster tags: - Clusters get: @@ -3700,7 +3696,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Get Cluster + summary: Get cluster tags: - Clusters /v1/networks: @@ -3773,7 +3769,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: List Networks + summary: List networks tags: - Networks post: @@ -3830,7 +3826,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Create Network + summary: Create network tags: - Networks /v1/networks/{id}: @@ -3873,7 +3869,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Delete Network + summary: Delete network tags: - Networks get: @@ -3920,7 +3916,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Please reach out to support. - summary: Get Network + summary: Get network tags: - Networks /v1/operations: @@ -3992,7 +3988,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Operations + summary: List operations tags: - Operations /v1/operations/{id}: @@ -4225,7 +4221,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Operation + summary: Get operation tags: - Operations /v1/organizations/available: @@ -4437,7 +4433,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Reach out to support. - summary: List Resource Groups + summary: List resource groups tags: - Resource Groups post: @@ -4472,7 +4468,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Reach out to support. - summary: Create Resource Group + summary: Create resource group tags: - Resource Groups /v1/resource-groups/{id}: @@ -4499,7 +4495,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Not Found - summary: Delete Resource Group + summary: Delete resource group tags: - Resource Groups get: @@ -4542,7 +4538,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Reach out to support. - summary: Get Resource Group + summary: Get resource group tags: - Resource Groups /v1/resource-groups/{resource_group.id}: @@ -4593,7 +4589,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: Internal Server Error. Reach out to support. - summary: Update Resource Group + summary: Update resource group tags: - Resource Groups /v1/role-bindings: @@ -4658,7 +4654,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Role Bindings + summary: List role bindings tags: - Control Plane Role Bindings post: @@ -4691,7 +4687,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Role Binding + summary: Create role binding tags: - Control Plane Role Bindings /v1/role-bindings/{id}: @@ -4722,7 +4718,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Role Binding + summary: Delete role binding tags: - Control Plane Role Bindings get: @@ -4759,7 +4755,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Role Binding + summary: Get role binding tags: - Control Plane Role Bindings /v1/serverless/clusters: @@ -4838,7 +4834,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Serverless Clusters + summary: List Serverless clusters tags: - Serverless Clusters post: @@ -4883,7 +4879,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Serverless Cluster + summary: Create Serverless cluster tags: - Serverless Clusters /v1/serverless/clusters/{id}: @@ -4922,7 +4918,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Serverless Cluster + summary: Delete Serverless cluster tags: - Serverless Clusters get: @@ -4964,7 +4960,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Serverless Cluster + summary: Get Serverless cluster tags: - Serverless Clusters /v1/serverless/region: @@ -5006,7 +5002,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get ServerlessRegion + summary: Get Serverless region tags: - Serverless Regions /v1/serverless/regions: @@ -5059,7 +5055,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List ServerlessRegions + summary: List Serverless regions tags: - Serverless Regions /v1/service-accounts: @@ -5099,7 +5095,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Service Accounts + summary: List service accounts tags: - Control Plane Service Accounts post: @@ -5132,7 +5128,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Service Account + summary: Create service account tags: - Control Plane Service Accounts /v1/service-accounts/{id}: @@ -5163,7 +5159,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Service Account + summary: Delete service account tags: - Control Plane Service Accounts get: @@ -5200,7 +5196,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Service Account + summary: Get service account tags: - Control Plane Service Accounts patch: @@ -5244,7 +5240,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Service Account + summary: Update service account tags: - Control Plane Service Accounts /v1/service-accounts/{id}/credentials: @@ -5282,7 +5278,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Service Account Credentials + summary: Get service account credentials tags: - Control Plane Service Accounts /v1/service-accounts/{id}/rotate-secret: @@ -5320,7 +5316,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Rotate Service Account Secret + summary: Rotate service account secret tags: - Control Plane Service Accounts /v1/user-invites: @@ -5356,9 +5352,9 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List User Invites + summary: List user invites tags: - - User invites + - User Invites post: description: Create a Redpanda Cloud user invite. operationId: UserInviteService_CreateUserInvite @@ -5388,9 +5384,9 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create User Invite + summary: Create user invite tags: - - User invites + - User Invites /v1/user-invites/{id}: delete: description: Delete Redpanda Cloud User from the organization. @@ -5421,7 +5417,7 @@ paths: description: An unexpected error response. summary: Delete User from the organization tags: - - User invites + - User Invites get: description: Get Redpanda user invite. operationId: UserInviteService_GetUserInvite @@ -5456,9 +5452,9 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get User Invite + summary: Get user invite tags: - - User invites + - User Invites patch: description: Update a Redpanda Cloud user invite. operationId: UserInviteService_UpdateUserInvite @@ -5500,9 +5496,9 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update UserInvite + summary: Update user invite tags: - - User invites + - User Invites /v1/users: get: description: List Redpanda Cloud Users. @@ -5540,7 +5536,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Users + summary: List users tags: - Control Plane Users /v1/users/{id}: @@ -5571,7 +5567,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete User + summary: Delete user tags: - Control Plane Users get: @@ -5612,7 +5608,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get User + summary: Get user tags: - Control Plane Users security: @@ -5645,4 +5641,4 @@ tags: - description: Manage Redpanda Cloud organization users. name: Control Plane Users - description: Manage user invites for your organization. - name: User invites + name: User Invites diff --git a/cloud-controlplane/x-topics/cloud-regions.md b/cloud-controlplane/x-topics/cloud-regions.md index c0f43f1..c9fdf68 100644 --- a/cloud-controlplane/x-topics/cloud-regions.md +++ b/cloud-controlplane/x-topics/cloud-regions.md @@ -1,5 +1,3 @@ -# Cloud Regions and Tiers - Usage tiers define the sizing of a cluster and provide tested and guaranteed workload configurations for throughput, logical partitions, and connections. Availability depends on the region and the cluster type (BYOC, Dedicated). See [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/) and [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/) for further details.

GCP

RegionZonesThroughput Tiers
europe-west9europe-west9-a,europe-west9-b,europe-west9-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-southwest1europe-southwest1-a,europe-southwest1-b,europe-southwest1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-west1southamerica-west1-btier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-east1asia-east1-a,asia-east1-b,asia-east1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-northeast1asia-northeast1-a,asia-northeast1-b,asia-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-south1asia-south1-a,asia-south1-b,asia-south1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-southeast1asia-southeast1-a,asia-southeast1-b,asia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
australia-southeast1australia-southeast1-a,australia-southeast1-b,australia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west1europe-west1-b,europe-west1-c,europe-west1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west2europe-west2-a,europe-west2-b,europe-west2-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west3europe-west3-a,europe-west3-b,europe-west3-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: Dedicated, BYOC
tier-7-gcp-v2-x86: Dedicated, BYOC
tier-8-gcp-v2-x86: Dedicated, BYOC
tier-9-gcp-v2-x86: Dedicated, BYOC
europe-west4europe-west4-a,europe-west4-b,europe-west4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
northamerica-northeast1northamerica-northeast1-a,northamerica-northeast1-b,northamerica-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-east1southamerica-east1-b,southamerica-east1-c,southamerica-east1-atier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-central1us-central1-a,us-central1-b,us-central1-c,us-central1-ftier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east1us-east1-b,us-east1-c,us-east1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east4us-east4-a,us-east4-b,us-east4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-west1us-west1-a,us-west1-b,us-west1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC

AWS

diff --git a/cloud-controlplane/x-topics/error-and-status-codes.md b/cloud-controlplane/x-topics/error-and-status-codes.md index 515a1ba..4b3e5d3 100644 --- a/cloud-controlplane/x-topics/error-and-status-codes.md +++ b/cloud-controlplane/x-topics/error-and-status-codes.md @@ -1,5 +1,3 @@ -# Control Plane API Error and Status Codes - The Redpanda Cloud API uses HTTP codes to indicate the status of a request. The response payload also includes [additional error codes and descriptions](#error-codes-and-details) that provide more detail about why an operation failed. Example request: diff --git a/cloud-controlplane/x-topics/long-running-operations.md b/cloud-controlplane/x-topics/long-running-operations.md index 79adeaf..09d0892 100644 --- a/cloud-controlplane/x-topics/long-running-operations.md +++ b/cloud-controlplane/x-topics/long-running-operations.md @@ -1,5 +1,3 @@ -# Long-running Operations in Redpanda Cloud - Some Cloud API endpoints do not directly return the resource itself, but instead return an operation. These operations may be long-running, meaning they may not complete immediately and can take several seconds or minutes to finish. Examples include creating or deleting clusters and networks, and updating cluster properties. Long-running operations are asynchronous and return a response indicating that the request has been accepted and is being processed. When you initiate a long-running operation, the API responds with a status code such as `202 Accepted` and includes an operation ID. The following is an example response of Create Cluster: diff --git a/cloud-controlplane/x-topics/quickstart.md b/cloud-controlplane/x-topics/quickstart.md index 8b44d25..d92f589 100644 --- a/cloud-controlplane/x-topics/quickstart.md +++ b/cloud-controlplane/x-topics/quickstart.md @@ -1,6 +1,4 @@ -# Redpanda Cloud Control Plane API Quickstart - -The following steps describe how to authenticate with the Control API and create a new Redpanda cluster. For more information on the Control Plane API, see the Redpanda Cloud API Overview. +The following steps describe how to authenticate with the Control API and create a new Redpanda cluster. For more information on the Control Plane API, see the Cloud API Overview. > **Note:** Redpanda Cloud uses a control plane and data plane architecture. To see the available endpoints for managing resources within your clusters, such as topics, users, access control lists (ACLs), and connectors, see the Data Plane API Reference. @@ -12,28 +10,32 @@ To use the Control Plane API: 1. You must be a customer with an existing organization in Redpanda Cloud. 2. You can only use one organization for authentication. +**BYOC only**: To create a BYOC cluster, [install or update `rpk`](https://docs.redpanda.com/redpanda-cloud/manage/rpk/rpk-install). + ### Authenticate to the API from API Explorer -You can issue requests against the Control Plane API from your browser when viewing the API Explorer: +To make API requests in your browser, you must obtain an access token. You can do so by clicking **Get token** on the API endpoint you want to call. -1. In the Redpanda Cloud UI, create a [service account (client)](https://cloud.redpanda.com/organization-iam?tab=service-accounts). Save the client ID and secret. -1. Go to the "Get access token" endpoint and click **Run in API Explorer**. -1. In the request body: - 1. For `grant_type`, select `client_credentials`. - 1. Enter the `client_id` and `client_secret` values you generated using the service account. - 1. For `audience`, select `cloudv2-production.redpanda.cloud`. -1. Click **Send Request** on the code example to the right. -The Response block should populate with an `access_token` value. Copy the string value without the quotes. To make your next request to a different endpoint in the API Explorer, add the access token in the Authentication field. -> **Warning:** API requests from this page are executed against your actual environment and data, not a sandbox. +If you successfully retrieve an access token, it is valid for one hour. You can use the same token in requests to both Control Plane and Data Plane API endpoints, for as long as the token is valid. ## Create a new cluster +> **Warning:** API requests from the API Explorer are executed against your actual environment and data, not a sandbox. + ### BYOC or Dedicated -1. Create a resource group by making a Create Resource Group request. The response returns a resource group ID. Pass this ID later when you call the Create Cluster endpoint. -1. Create a network by making a Create Network request. Note that this endpoint returns a long-running operation. The response returns a network ID in `resource_id`. Pass this ID when you call the Create Cluster endpoint. -1. When the Create Network operation is complete, create a cluster by making a Create Cluster request. Note that this endpoint returns a long-running operation. -1. For BYOC, run `rpk cloud byoc` in the shell, passing the `metadata.cluster_id` from the Create Cluster response as a flag: +1. In the page header, click **API Explorer**. +1. On the **Choose an operation** dropdown, select **Create resource group**. +1. Click **Get token**. You may be prompted to log in to the Redpanda Cloud UI. After you log in, the browser automatically redirects you back to the Create resource group endpoint in the API Explorer. +1. Prepare your Create resource group request. + 1. Under **Body**, click **+ Add** and provide a name for your resource group. A resource group is a container to organize your Redpanda Cloud resources, such as clusters and networks. + 1. Click **Send request**. If successful, the response returns a resource group ID. Pass this ID when you make a Create network request. +1. On the dropdown, select **Create network**. +1. Prepare your Create network request. + 1. Include the ID of the resource group you created in the previous step. + 1. Click **Send request**. Note that this endpoint returns a long-running operation. The response returns a network ID in `metadata.network_id`. Pass this ID when you call the Create Cluster endpoint.To check the operation state, make a **Get operation** request with the `operation.id`. +1. When the Create network operation is complete, make a Create cluster request. Use the resource group and network IDs you just created. Note that this endpoint also returns a long-running operation. +1. For BYOC, run `rpk cloud byoc` in the shell, passing the `metadata.cluster_id` from the Create cluster response as a flag: **AWS:** ```bash @@ -50,7 +52,30 @@ The Response block should populate with an `access_token` value. Copy the string ### Serverless -1. Make a Get Resource Group request to retrieve the default resource group ID. Pass this ID later when you call the Create Serverless Cluster endpoint. -1. Make a Get Serverless Regions request to see available regions. -1. Create a cluster by making a Create Serverless Cluster request, passing in the default resource group ID and desired cloud region in the request. +1. In the page header, click **API Explorer**. +1. On the **Choose an operation** dropdown, select **Create resource group**. +1. Click **Get token**. You may be prompted to log in to the Redpanda Cloud UI. After you log in, the browser automatically redirects you back to the Create resource group endpoint in the API Explorer. +1. Prepare your Create resource group request. + 1. Under **Body**, click **+ Add** and provide a name for your resource group. A resource group is a container to organize your Redpanda Cloud resources, such as clusters and networks. + 1. Click **Send request**. If successful, the response returns a resource group ID. Pass this ID later when you make a Create Serverless cluster request. +1. On the dropdown, select **Create Serverless cluster**. +1. Prepare your Create Serverless cluster request. + 1. Make a Get Serverless Regions request to see available regions. + 1. In the request body, use the resource group ID and desired cloud region. + 1. Click **Send request**. Note that this endpoint returns a long-running operation. The response returns a Serverless cluster ID in `metadata.cluster_id`. To check the operation state, make a **Get operation** request with the `operation.id`. + +## Next steps: try the Data Plane APIs + +1. Retrieve your cluster's data plane API URL by making a **Get cluster** (BYOC, Dedicated) or **Get Serverless cluster** (Serverless) request in the API Explorer. +1. Save the value of `dataplane_api.url` from the response body. +1. From the **Redpanda APIs** selector, go to **Cloud Data Plane API**. +1. Select an operation, for example **Create topic** or **List users**. +1. In the URL field, add the data plane API URL. You can now make Data Plane API requests to your target cluster. + +See also: [Data Plane API Quickstart](https://docs.redpanda.com/api/doc/cloud-dataplane/topic/topic-quickstart) + +## Suggested reading +- Learn about Redpanda Cloud [network security and connectivity](https://docs.redpanda.com/redpanda-cloud/networking/) for BYOC and Dedicated clusters. +- Manage [authentication and authorization](https://docs.redpanda.com/redpanda-cloud/security/authorization/) in Redpanda Cloud. +- [Create a Kafka client or generate a sample application](https://docs.redpanda.com/redpanda-cloud/get-started/cluster-types/serverless/#connect-with-your-cluster) to interact with your Serverless cluster. \ No newline at end of file diff --git a/cloud-dataplane/cloud-dataplane.yaml b/cloud-dataplane/cloud-dataplane.yaml index 5c230e2..6625c14 100644 --- a/cloud-dataplane/cloud-dataplane.yaml +++ b/cloud-dataplane/cloud-dataplane.yaml @@ -173,7 +173,7 @@ components: info: $ref: '#/components/schemas/ConnectCluster.Info' name: - description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`. + description: Unique name of Connect cluster. For Redpanda Cloud, the value is `redpanda`. type: string plugins: items: @@ -1780,6 +1780,7 @@ components: info: title: Redpanda Cloud Data Plane API version: v1 + description: 'Use the Data Plane API to manage topics, ACLs, and connectors within each cluster.' openapi: 3.0.3 paths: /v1/acls: @@ -2359,7 +2360,7 @@ paths: - Cloud Storage /v1/kafka-connect/clusters: get: - description: List connect clusters available for being consumed by the console's kafka-connect service. + description: List Connect clusters available in Console. operationId: KafkaConnectService_ListConnectClusters responses: "200": @@ -2386,7 +2387,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List connect clusters + summary: List Connect clusters tags: - Kafka Connect /v1/kafka-connect/clusters/{cluster_name}: @@ -2394,7 +2395,7 @@ paths: description: Get information about an available Kafka Connect cluster. operationId: KafkaConnectService_GetConnectCluster parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2431,7 +2432,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get connect cluster + summary: Get Connect cluster tags: - Kafka Connect /v1/kafka-connect/clusters/{cluster_name}/connectors: @@ -2729,7 +2730,7 @@ paths: description: Pause the connector and its tasks, which stops messages from processing until the connector is resumed. This call is asynchronous and may take some time to process. operationId: KafkaConnectService_PauseConnector parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2773,7 +2774,7 @@ paths: description: Triggers a connector restart. You must specify whether or not tasks are also restarted, and whether only failed connectors are restarted. operationId: KafkaConnectService_RestartConnector parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2824,7 +2825,7 @@ paths: description: Resume a paused connector and its tasks, and resumes message processing. This call is asynchronous and may take some time to process. If the connector was not paused, this operation does not do anything. operationId: KafkaConnectService_ResumeConnector parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2868,7 +2869,7 @@ paths: description: Gets the current status of the connector, including the state for each of its tasks, error information, etc. operationId: KafkaConnectService_GetConnectorStatus parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2913,7 +2914,7 @@ paths: description: Stops a connector, but does not delete it. All tasks for the connector are shut down completely. This call is asynchronous and may take some time to process. operationId: KafkaConnectService_StopConnector parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2957,7 +2958,7 @@ paths: description: Returns a list of connector topic names. If the connector is inactive, this call returns an empty list. operationId: KafkaConnectService_ListConnectorTopics parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3002,7 +3003,7 @@ paths: description: Resets the set of topic names that the connector is using. operationId: KafkaConnectService_ResetConnectorTopics parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3046,7 +3047,7 @@ paths: description: 'List Kafka Connect cluster secrets. Optional: filter based on secret name and labels.' operationId: SecretService_ListKafkaConnectSecrets parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3110,7 +3111,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Connect Cluster Secrets + summary: List Connect cluster secrets tags: - Secrets post: @@ -3155,7 +3156,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Connect Cluster Secret + summary: Create Connect cluster secret tags: - Secrets /v1/kafka-connect/clusters/{cluster_name}/secrets/{id}: @@ -3163,7 +3164,7 @@ paths: description: Delete a Kafka Connect cluster secret. operationId: SecretService_DeleteKafkaConnectSecret parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3205,7 +3206,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Connect Cluster Secret + summary: Delete Connect cluster secret tags: - Secrets get: @@ -3255,7 +3256,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Connect Cluster Secret + summary: Get Connect cluster secret tags: - Secrets put: @@ -3312,7 +3313,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Connect Cluster Secret + summary: Update Connect cluster secret tags: - Secrets /v1/redpanda-connect/config-schema: @@ -3771,7 +3772,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Secret Scopes + summary: List secret scopes tags: - Secrets /v1/secrets: @@ -3837,7 +3838,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Secrets + summary: List secrets tags: - Secrets post: @@ -3876,7 +3877,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Secret + summary: Create secret tags: - Secrets /v1/secrets/{id}: @@ -3920,7 +3921,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Secret + summary: Delete secret tags: - Secrets get: @@ -3964,7 +3965,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Secret + summary: Get secret tags: - Secrets put: @@ -4015,7 +4016,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Secret + summary: Update secret tags: - Secrets /v1/topics: @@ -4064,7 +4065,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Topics + summary: List topics tags: - Topics post: @@ -4111,7 +4112,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Topic + summary: Create topic tags: - Topics /v1/topics-partitions: @@ -4156,7 +4157,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Add Topic Partitions + summary: Add topic partitions tags: - Topics put: @@ -4200,7 +4201,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set Topic Partitions + summary: Set topic partitions tags: - Topics /v1/topics/{topic_name}: @@ -4244,7 +4245,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Topic + summary: Delete topic tags: - Topics /v1/topics/{topic_name}/configurations: @@ -4289,7 +4290,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Topic Configurations + summary: Get topic configurations tags: - Topics patch: @@ -4342,7 +4343,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Topic Configuration + summary: Update topic configuration tags: - Topics put: @@ -4395,7 +4396,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set Topic Configurations + summary: Set topic configurations tags: - Topics /v1/topics/{topic_name}/partitions: @@ -4447,7 +4448,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Add Topic Partitions + summary: Add topic partitions tags: - Topics put: @@ -4498,7 +4499,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set Topic Partitions + summary: Set topic partitions tags: - Topics /v1/transforms: @@ -4574,7 +4575,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Transforms + summary: List transforms tags: - WASM Transforms put: @@ -4602,7 +4603,7 @@ paths: schema: $ref: '#/components/schemas/TransformMetadata' description: Created - summary: Deploy Transform + summary: Deploy transform tags: - WASM Transforms /v1/transforms/{name}: @@ -4649,7 +4650,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Transform + summary: Delete transform tags: - WASM Transforms get: @@ -4708,7 +4709,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Transform + summary: Get transform tags: - WASM Transforms /v1/users: @@ -4769,7 +4770,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Users + summary: List users tags: - Redpanda Users post: @@ -4835,7 +4836,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create User + summary: Create user tags: - Redpanda Users /v1/users/{name}: @@ -4888,7 +4889,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete User + summary: Delete user tags: - Redpanda Users /v1/users/{user.name}: @@ -4968,7 +4969,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update User + summary: Update user tags: - Redpanda Users security: @@ -4998,5 +4999,5 @@ tags: name: Secrets - description: Manage Redpanda topics. name: Topics - - description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/cloud-dataplane-api/#get-/v1/acls). + - description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/doc/cloud-dataplane/group/endpoint-redpanda-users). name: Redpanda Users diff --git a/cloud-dataplane/x-topics/error-and-status-codes.md b/cloud-dataplane/x-topics/error-and-status-codes.md index 7fb2009..6478599 100644 --- a/cloud-dataplane/x-topics/error-and-status-codes.md +++ b/cloud-dataplane/x-topics/error-and-status-codes.md @@ -1,5 +1,3 @@ -# Data Plane API Error and Status Codes - The Redpanda Cloud API uses HTTP codes to indicate the status of a request. The response payload also includes [additional error codes and descriptions](#error-codes-and-details) that provide more detail about why an operation failed. Example request: diff --git a/cloud-dataplane/x-topics/quickstart.md b/cloud-dataplane/x-topics/quickstart.md index 352dbb7..07ba9d2 100644 --- a/cloud-dataplane/x-topics/quickstart.md +++ b/cloud-dataplane/x-topics/quickstart.md @@ -1,38 +1,45 @@ -# Redpanda Cloud Data Plane API Quickstart - -The following steps describe how to authenticate with the Data Plane API. For more information on the Data Plane API, see the Redpanda Cloud API Overview. +The following steps describe how to authenticate with the Data Plane APIs and create a new topic. For more information on the Data Plane APIs, see the Cloud API Overview. > **Note:** Redpanda Cloud uses a control plane and data plane architecture. To see the available endpoints for managing your clusters, networks, and resource groups, see the Control Plane API Reference. ## Requirements -To use the Data Plane API: +To use the Data Plane APIs: 1. You must be a customer with an existing organization in Redpanda Cloud. 2. You can only use one organization for authentication. -3. You must have a running cluster in Redpanda Cloud. +3. You must have a running cluster in Redpanda Cloud. If you don't have an existing cluster, follow the Control Plane API Quickstart to create one. ### Authenticate to the API from API Explorer -You can issue requests against the Data Plane API from your browser when viewing the API Explorer: +To make API requests in your browser, you must obtain an access token. You can do so by clicking **Get token** on the API endpoint you want to call. -1. In the Redpanda Cloud UI, create a [service account (client)](https://cloud.redpanda.com/organization-iam?tab=service-accounts). Save the client ID and secret. -1. Go to the "Get access token" endpoint and click **Run in API Explorer**. -1. In the request body: - 1. For `grant_type`, select `client_credentials`. - 1. Enter the `client_id` and `client_secret` values you generated using the service account. - 1. For `audience`, select `cloudv2-production.redpanda.cloud`. -1. Click **Send Request** on the code example to the right. +If you successfully retrieve an access token, it is valid for one hour. You can use the same token in requests to both Control Plane and Data Plane API endpoints, for as long as the token is valid. -The Response block should populate with an `access_token` value. Copy the string value without the quotes. To you make your next request on a different endpoint in the API Explorer, add the access token in the Authentication field. +## Create a topic > **Warning:** API requests from this page are executed against your actual environment and data, not a sandbox. -## Create a topic +1. In the page header, click **API Explorer**. +1. If you don't already have the data plane API URL for your target cluster, make a Get Cluster (BYOC, Dedicated) or Get Serverless Cluster (Serverless) request with the Control Plane API. The response contains the data plane API URL. Copy the value of `dataplane_api.url` from the response body, and enter it in the URL field. +1. On the **Choose an operation** dropdown, select **Create topic**. +1. Click **Get token**. You may be prompted to log in to the Redpanda Cloud UI. After you log in, the browser automatically redirects you back to the Create resource group endpoint in the API Explorer. +1. Enter a name for your topic and click **Send request**. +1. Confirm that your topic is successfully created by making a List topics request. + +## Next steps + +The quickest ways to produce to and consume from the topic are to use [`rpk`](https://docs.redpanda.com/redpanda-cloud/manage/rpk/rpk-install/) or the [Redpanda HTTP Proxy](https://docs.redpanda.com/api/doc/http-proxy) (BYOC and Dedicated clusters only). + +For example, to use `rpk` to produce to a topic named `test-topic`, run: -1. If you don't already have the data plane API URL for your target cluster, make a Get Cluster (BYOC, Dedicated) or Get Serverless Cluster (Serverless) request against the Control Plane API. The response contains the Data Plane API URL. Copy the value of `dataplane_api.url` from the response body. -1. Go to **API Servers** in the sidebar and select “\{dataplane_api_url} - Data Plane API”. Paste the URL into the `dataplane_api_url` field. -1. To create a new Redpanda topic, make a Create Topic request. +``` +echo "hello world" | rpk topic produce test-topic +``` +## Suggested reading +- Use the Data Plane APIs to do [common tasks](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-dataplane-api) in your cluster such as create a user or use Redpanda Connect. +- See the [`rpk topic produce`](https://docs.redpanda.com/redpanda-cloud/reference/rpk/rpk-topic/rpk-topic-produce/) reference. +- See the [`rpk topic consume`](https://docs.redpanda.com/redpanda-cloud/reference/rpk/rpk-topic/rpk-topic-consume/) reference. diff --git a/shared/x-topics/about-authentication.md b/shared/x-topics/about-authentication.md index 64aaad5..ad0525f 100644 --- a/shared/x-topics/about-authentication.md +++ b/shared/x-topics/about-authentication.md @@ -1,5 +1,3 @@ -# Authentication - The Cloud API uses the Client Credentials Flow as defined in [Auth 2.0 RFC 6749, section 4.4](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4O). In Redpanda Cloud, you must first create a **service account** through which you can authenticate requests to the Cloud API. The service account is associated with your Redpanda Cloud organization. The service account acts as an OAuth 2.0 client that provides its credentials (client ID and client secret) to the API authentication server. The authentication server grants an access token in return. You can then include the access token in each request to the API. The access token granted to you is associated with a specific Redpanda Cloud organization. If you want to use the API for a different organization, you must acquire a new token through a service account with that organization. diff --git a/shared/x-topics/cloud-api-deprecation-policy.md b/shared/x-topics/cloud-api-deprecation-policy.md index 1983e86..2a89cb0 100644 --- a/shared/x-topics/cloud-api-deprecation-policy.md +++ b/shared/x-topics/cloud-api-deprecation-policy.md @@ -1,5 +1,3 @@ -# Cloud API Deprecation Policy - This document outlines the Cloud API deprecation and versioning policy. As Redpanda introduces improvements, addresses security concerns, and updates the technology stack, it is sometimes necessary to deprecate older versions or features of the Redpanda Cloud API. Redpanda adheres to this policy to maintain a balance between innovation and stability, ensuring the best possible experience for customers and partners. For questions and concerns regarding this policy, contact your Customer Success Manager. You can also post questions in [Redpanda Community Slack](https://redpanda.com/slack). diff --git a/shared/x-topics/cloud-api-overview.md b/shared/x-topics/cloud-api-overview.md index cc7cdac..1dfbf46 100644 --- a/shared/x-topics/cloud-api-overview.md +++ b/shared/x-topics/cloud-api-overview.md @@ -1,5 +1,3 @@ -# Redpanda Cloud API Overview - The Redpanda Cloud API is a collection of REST APIs that allow you to interact with different parts of Redpanda Cloud. You can call the API endpoints directly, or use tools like Terraform or Python scripts to automate cluster management and manage Redpanda Cloud resources. ## Requirements @@ -79,3 +77,4 @@ When an endpoint returns a list containing more items than can be returned in a ## Versioning and deprecation The Cloud API Deprecation Policy outlines the process for phasing out an API version or specific features within an API. See Deprecation Policy for details. +