You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: cloud-controlplane/x-topics/quickstart.md
+55-19Lines changed: 55 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
-
The following steps describe how to authenticate with the Control Plane API and create a new Redpanda cluster. For more information on the Control Plane API, see the [Cloud API Overview](#topic-cloud-api-overview).
1
+
The following steps describe how to authenticate with the Control Plane API and create a new Redpanda cluster.
2
2
3
3
> **Note:** Redpanda Cloud uses a control plane and data plane architecture.
4
-
To view 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](/api/doc/cloud-dataplane).
4
+
To view 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](/api/doc/cloud-dataplane). For more information on the Control Plane API, see the [Cloud API Overview](#topic-cloud-api-overview).
5
5
6
6
## Requirements
7
7
@@ -10,42 +10,67 @@ To use the Control Plane API:
10
10
1. You must be a customer with an existing organization in Redpanda Cloud.
11
11
2. You can only use one organization for authentication.
12
12
13
-
**BYOC only**: To create a BYOC cluster, [install or update`rpk`](https://docs.redpanda.com/redpanda-cloud/manage/rpk/rpk-install).
13
+
**BYOC only**: BYOC clusters require running the `rpk cloud byoc` command to install and start the Redpanda Cloud agent service. See [Install or Update`rpk`](https://docs.redpanda.com/redpanda-cloud/manage/rpk/rpk-install).
14
14
15
15
### Authenticate to the API from API Explorer
16
16
17
17
The API Explorer lets you interact with the API directly from the documentation. You can quickly explore available endpoints and try requests without setting up your own test environment.
18
18
19
19
To make Cloud 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.
20
20
21
-
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.
21
+
If you successfully retrieve an access token, it is valid for one hour.
22
22
23
23
> **Warning:** API requests from the API Explorer are executed against your actual environment and data, not a sandbox.
24
24
25
25
## Create a new cluster
26
26
27
27
### BYOC or Dedicated
28
28
29
-
1. In the subheader, open **API Explorer**.
29
+
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-controlplane/explorer).
30
30
31
31
1. In the **Choose an operation** dropdown, select **Create resource group**.
32
32
33
33
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.
34
34
35
35
1. Prepare your Create resource group request.
36
36
37
-
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.
37
+
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.
38
38
39
-
1.Click **Send request**. If successful, the response returns a resource group ID. Pass this ID when you make a Create network request.
39
+
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
40
41
-
1. In the dropdown, select **Create network**.
41
+
```json
42
+
{
43
+
"resource_group": {
44
+
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
45
+
"name": "test-resource-group",
46
+
...
47
+
}
48
+
}
49
+
```
50
+
51
+
1. In the operation dropdown, select **Create network**.
42
52
43
53
1. Prepare your Create network request.
44
54
45
55
1. Include the ID of the resource group you created in the previous step.
46
-
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`.
47
-
48
-
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.
56
+
57
+
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`.
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.
49
74
50
75
1. For BYOC, run `rpk cloud byoc` in the shell, passing the `metadata.cluster_id` from the Create cluster response as a flag:
51
76
@@ -64,24 +89,35 @@ If you successfully retrieve an access token, it is valid for one hour. You can
64
89
65
90
### Serverless
66
91
67
-
1. In the subheader, open **API Explorer**.
92
+
1. In the subheader of this page, open [**API Explorer**](/api/doc/cloud-controlplane/explorer)
68
93
69
94
1. In the **Choose an operation** dropdown, select **Create resource group**.
70
95
71
96
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.
72
97
73
98
1. Prepare your Create resource group request.
74
99
75
-
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.
76
-
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.
100
+
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.
101
+
102
+
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.
77
103
78
-
1. In the dropdown, select **Create Serverless cluster**.
104
+
```json
105
+
{
106
+
"resource_group": {
107
+
"id": "d61b4c7f-95da-4d62-a237-9fd9f20a0c19",
108
+
"name": "test-resource-group",
109
+
...
110
+
}
111
+
}
112
+
```
79
113
80
-
1.Prepare your Create Serverless cluster request.
114
+
1. In the operation dropdown, scroll to **Serverless Clusters** and select [**Create Serverless cluster**](/api/doc/cloud-controlplane/explorer/operation/operation-serverlessclusterservice_createserverlesscluster).
81
115
82
-
1. Make a Get Serverless Regions request to see available regions.
83
-
1. In the request body, use the resource group ID and desired cloud region.
84
-
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`.
116
+
1. Prepare your Create Serverless cluster request.
117
+
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.
119
+
120
+
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`.
0 commit comments