Skip to content

Commit 60d8828

Browse files
author
Kat Batuigas
committed
Apply suggestions from automated review
1 parent d1a87f3 commit 60d8828

File tree

2 files changed

+37
-40
lines changed

2 files changed

+37
-40
lines changed

‎cloud-controlplane/x-topics/quickstart.md‎

Lines changed: 36 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,15 @@ If you successfully retrieve an access token, it is valid for one hour.
3737
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.
3838

3939
1. In the request panel, click **Send request**. If successful, the response returns a resource group ID. Copy the ID and use it later when you make a Create network request.
40-
41-
```json
42-
{
43-
"resource_group": {
44-
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
45-
"name": "test-resource-group",
46-
...
47-
}
48-
}
49-
```
40+
```
41+
{
42+
"resource_group": {
43+
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
44+
"name": "test-resource-group",
45+
...
46+
}
47+
}
48+
```
5049
5150
1. In the operation dropdown, select **Create network**.
5251
@@ -55,33 +54,33 @@ If you successfully retrieve an access token, it is valid for one hour.
5554
1. Include the ID of the resource group you created in the previous step.
5655
5756
1. Click **Send request**. Note that this endpoint returns a long-running operation. The response returns a network ID in `metadata.network_id`. Copy the ID and pass it later when you call the Create cluster endpoint. To check the operation state, make a [**Get operation**](/api/doc/cloud-controlplane/explorer/operation/operation-operationservice_getoperation) request with the `operation.id`.
58-
59-
```json
60-
{
61-
"operation": {
62-
"id": "d3505t2rmm68sqlgj4u0",
63-
"metadata": {
64-
"@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata",
65-
"network_id": "d3505ta2691o0l3484ng"
66-
},
67-
"state": "STATE_IN_PROGRESS",
68-
...
69-
}
70-
}
71-
```
57+
```
58+
{
59+
"operation": {
60+
"id": "d3505t2rmm68sqlgj4u0",
61+
"metadata": {
62+
"@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata",
63+
"network_id": "d3505ta2691o0l3484ng"
64+
},
65+
"state": "STATE_IN_PROGRESS",
66+
...
67+
}
68+
}
69+
```
7270
7371
1. When the Create network operation is complete, make a [Create cluster](/api/doc/cloud-controlplane/explorer/operation/operation-clusterservice_createcluster) request. Use the resource group and network IDs you just created. Note that this endpoint also returns a long-running operation.
7472
75-
1. For BYOC, run `rpk cloud byoc` in the shell, passing the `metadata.cluster_id` from the Create cluster response as a flag:
76-
73+
1. For BYOC, run `rpk cloud byoc <cloud-provider> apply` in the shell, passing the `metadata.cluster_id` from the Create cluster response as a flag:
7774
**AWS:**
7875
```bash
7976
rpk cloud byoc aws apply --redpanda-id=<metadata.cluster_id>
8077
```
78+
8179
**Azure:**
8280
```bash
8381
rpk cloud byoc azure apply --redpanda-id=<metadata.cluster_id> --subscription-id=<redpanda-cluster-azure-subscription-id>
8482
```
83+
8584
**GCP:**
8685
```bash
8786
rpk cloud byoc gcp apply --redpanda-id=<metadata.cluster_id> --project-id=<gcp-project-id>
@@ -100,29 +99,28 @@ If you successfully retrieve an access token, it is valid for one hour.
10099
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.
101100

102101
1. In the request panel, click **Send request**. If successful, the response returns a resource group ID. Copy the ID and use it later when you make a Create Serverless cluster request.
103-
104-
```json
105-
{
106-
"resource_group": {
107-
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
108-
"name": "test-resource-group",
109-
...
110-
}
111-
}
112-
```
102+
```
103+
{
104+
"resource_group": {
105+
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
106+
"name": "test-resource-group",
107+
...
108+
}
109+
}
110+
```
113111
114112
1. In the operation dropdown, scroll to **Serverless Clusters** and select [**Create Serverless cluster**](/api/doc/cloud-controlplane/explorer/operation/operation-serverlessclusterservice_createserverlesscluster).
115113
116114
1. Prepare your Create Serverless cluster request.
117115
118-
1. In the request body, use the resource group ID. You can use `us-east-1` for the Serverless region if you don't require a specific region for your cluster.
116+
1. In the request body, use the resource group ID and enter a [serverless region](https://docs.redpanda.com/redpanda-cloud/reference/tiers/serverless-regions/) (for example, `us-east-1`).
119117
120118
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**](/api/doc/cloud-controlplane/explorer/operation/operation-operationservice_getoperation) request with the `operation.id`.
121119
122120
## Next steps: try the Data Plane APIs
123121
124122
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.
125-
1. From the value of `dataplane_api.url` in the response body, save the subdomain (the part between ``https://` and `.cloud.redpanda.com`).
123+
1. From the value of `dataplane_api.url` in the response body, save the subdomain (the part between `https://` and `.cloud.redpanda.com`).
126124
1. From the **Redpanda APIs** selector, go to **Cloud Data Plane API**.
127125
1. Select an operation, for example **Create topic** or **List users**.
128126
1. In the URL field, add the data plane API URL. You can now make Data Plane API requests to your target cluster.

‎cloud-dataplane/x-topics/quickstart.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ If you successfully retrieve an access token, it is valid for one hour. You can
2424

2525
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-dataplane/explorer).
2626

27-
1. If you don't already have the data plane API URL for your target cluster, make a [Get Cluster](/api/doc/cloud-controlplane/explorer/operation/operation-clusterservice_getcluster) (BYOC, Dedicated) or [Get Serverless Cluster](/api/doc/cloud-controlplane/explorer/operation/operation-serverlessclusterservice_createserverlesscluster) (Serverless) request with the Control Plane API. The response contains the data plane API URL.
28-
27+
1. If you don't already have the data plane API URL for your target cluster, make a [Get Cluster](/api/doc/cloud-controlplane/explorer/operation/operation-clusterservice_getcluster) (BYOC, Dedicated) or [Get Serverless Cluster](/api/doc/cloud-controlplane/explorer/operation/operation-serverlessclusterservice_getserverlesscluster) (Serverless) request with the Control Plane API. The response contains the data plane API URL.
2928
From the `dataplane_api.url` value in the response, extract only the subdomain (the part between `https://` and `.cloud.redpanda.com`). Enter this value in the Data Plane API URL field.
3029

3130
1. In the **Choose an operation** dropdown, select **Create topic**.

0 commit comments

Comments
 (0)