Skip to content

Commit 2cdbf3b

Browse files
author
Kat Batuigas
committed
Minor edits
1 parent fbdd1dc commit 2cdbf3b

File tree

3 files changed

+54
-48
lines changed

3 files changed

+54
-48
lines changed

cloud-controlplane/cloud-controlplane.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5690,7 +5690,7 @@ tags:
56905690
name: Resource Groups
56915691
- description: Manage [Redpanda Serverless](https://docs.redpanda.com/redpanda-cloud/get-started/cloud-overview/#redpanda-cloud-cluster-types) clusters. For detailed steps, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/).
56925692
name: Serverless Clusters
5693-
- description: Manage Redpanda Serverless Private Links.
5693+
- description: Manage Redpanda Serverless private links.
56945694
name: Serverless Private Links
56955695
- description: See available Redpanda Serverless regions.
56965696
name: Serverless Regions

cloud-controlplane/x-topics/quickstart.md

Lines changed: 49 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,16 @@ 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-
{
42-
"resource_group": {
43-
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
44-
"name": "test-resource-group",
45-
...
46-
}
47-
}
48-
```
40+
41+
```
42+
{
43+
"resource_group": {
44+
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
45+
"name": "test-resource-group",
46+
...
47+
}
48+
}
49+
```
4950
5051
1. In the operation dropdown, select **Create network**.
5152
@@ -54,41 +55,44 @@ If you successfully retrieve an access token, it is valid for one hour.
5455
1. Include the ID of the resource group you created in the previous step.
5556
5657
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`.
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-
```
58+
59+
60+
```
61+
{
62+
"operation": {
63+
"id": "d3505t2rmm68sqlgj4u0",
64+
"metadata": {
65+
"@type": "type.googleapis.com/redpanda.api.controlplane.v1.CreateNetworkMetadata",
66+
"network_id": "d3505ta2691o0l3484ng"
67+
},
68+
"state": "STATE_IN_PROGRESS",
69+
...
70+
}
71+
}
72+
```
7073
7174
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.
7275
7376
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:
74-
**AWS:**
75-
```bash
76-
rpk cloud byoc aws apply --redpanda-id=<metadata.cluster_id>
77-
```
7877
79-
**Azure:**
80-
```bash
81-
rpk cloud byoc azure apply --redpanda-id=<metadata.cluster_id> --subscription-id=<redpanda-cluster-azure-subscription-id>
82-
```
78+
**AWS:**
79+
```bash
80+
rpk cloud byoc aws apply --redpanda-id=<metadata.cluster_id>
81+
```
8382
84-
**GCP:**
85-
```bash
86-
rpk cloud byoc gcp apply --redpanda-id=<metadata.cluster_id> --project-id=<gcp-project-id>
87-
```
83+
**Azure:**
84+
```bash
85+
rpk cloud byoc azure apply --redpanda-id=<metadata.cluster_id> --subscription-id=<redpanda-cluster-azure-subscription-id>
86+
```
87+
88+
**GCP:**
89+
```bash
90+
rpk cloud byoc gcp apply --redpanda-id=<metadata.cluster_id> --project-id=<gcp-project-id>
91+
```
8892
8993
### Serverless
9094
91-
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-controlplane/explorer)
95+
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-controlplane/explorer).
9296
9397
1. In the **Choose an operation** dropdown, select **Create resource group**.
9498
@@ -99,15 +103,16 @@ If you successfully retrieve an access token, it is valid for one hour.
99103
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.
100104
101105
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.
102-
```
103-
{
104-
"resource_group": {
105-
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
106-
"name": "test-resource-group",
107-
...
108-
}
109-
}
110-
```
106+
107+
```
108+
{
109+
"resource_group": {
110+
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
111+
"name": "test-resource-group",
112+
...
113+
}
114+
}
115+
```
111116
112117
1. In the operation dropdown, scroll to **Serverless Clusters** and select [**Create Serverless cluster**](/api/doc/cloud-controlplane/explorer/operation/operation-serverlessclusterservice_createserverlesscluster).
113118

cloud-dataplane/x-topics/quickstart.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
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](#topic-cloud-api-overview).
1+
The following steps describe how to authenticate with the Data Plane APIs and create a new topic.
22

3-
> **Note:** Redpanda Cloud uses a control plane and data plane architecture. To view the available endpoints for managing your clusters, networks, and resource groups, see the [Control Plane API Reference](/api/doc/cloud-controlplane).
3+
> **Note:** Redpanda Cloud uses a control plane and data plane architecture. To view the available endpoints for managing your clusters, networks, and resource groups, see the [Control Plane API Reference](/api/doc/cloud-controlplane). For more information on the Data Plane APIs, see the [Cloud API Overview](#topic-cloud-api-overview).
44
55
## Requirements
66

@@ -25,7 +25,8 @@ If you successfully retrieve an access token, it is valid for one hour. You can
2525
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-dataplane/explorer).
2626

2727
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.
28-
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.
28+
29+
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.
2930

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

0 commit comments

Comments
 (0)