Skip to content

Commit 32b8b1b

Browse files
committed
Update xrefs, minor edits
1 parent 2fdebe1 commit 32b8b1b

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

modules/manage/partials/controlplane-api.adoc

+25-19
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
:tag-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--ClusterService
2-
:tag-networks: api:ROOT:cloud-controlplane-api.adoc#tag--NetworkService
3-
:tag-operations: api:ROOT:cloud-controlplane-api.adoc#tag--OperationService
4-
:tag-resource-groups: api:ROOT:cloud-controlplane-api.adoc#tag--ResourceGroupService
5-
:tag-serverless-regions: api:ROOT:cloud-controlplane-api.adoc#tag--ServerlessRegionService
6-
:tag-serverless-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--ServerlessClusterService
1+
:tag-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--Clusters
2+
:tag-networks: api:ROOT:cloud-controlplane-api.adoc#tag--Networks
3+
:tag-operations: api:ROOT:cloud-controlplane-api.adoc#tag--Operations
4+
:tag-resource-groups: api:ROOT:cloud-controlplane-api.adoc#tag--Resource-Groups
5+
:tag-serverless-regions: api:ROOT:cloud-controlplane-api.adoc#tag--Serverless-Regions
6+
:tag-serverless-clusters: api:ROOT:cloud-controlplane-api.adoc#tag--Serverless-Clusters
7+
:tag-role-bindings: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Role-Bindings
8+
:tag-users: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Users
9+
:tag-service-accounts: api:ROOT:cloud-controlplane-api.adoc#tag--Control-Plane-Service-Accounts
710

811
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.
912

@@ -13,18 +16,21 @@ See xref:api:ROOT:cloud-controlplane-api.adoc[Control Plane API] for the full AP
1316

1417
The Control Plane API is one central API that allows you to provision clusters, networks, and resource groups.
1518

16-
The Control Plane API consists of the following endpoints:
19+
The Control Plane API consists of the following endpoint groups:
1720

1821
ifndef::env-serverless[]
19-
* pass:a,m[xref:{tag-clusters}[ClusterService\]]
20-
* pass:a,m[xref:{tag-networks}[NetworkService\]]
22+
* pass:a,m[xref:{tag-clusters}[Clusters\]]
23+
* pass:a,m[xref:{tag-networks}[Networks\]]
2124
endif::[]
22-
* pass:a,m[xref:{tag-operations}[OperationService\]]
23-
* pass:a,m[xref:{tag-resource-groups}[ResourceGroupService\]]
25+
* pass:a,m[xref:{tag-operations}[Operations\]]
26+
* pass:a,m[xref:{tag-resource-groups}[Resource Groups\]]
2427
ifdef::env-serverless[]
25-
* pass:a,m[xref:{tag-serverless-clusters}[ServerlessClusterService\]]
26-
* pass:a,m[xref:{tag-serverless-regions}[ServerlessRegionService\]]
28+
* pass:a,m[xref:{tag-serverless-clusters}[Serverless Clusters\]]
29+
* pass:a,m[xref:{tag-serverless-regions}[Serverless Regions\]]
2730
endif::[]
31+
* pass:a,m[xref:{tag-role-bindings}[Control Plane Role Bindings\]]
32+
* pass:a,m[xref:{tag-users}[Control Plane Users\]]
33+
* pass:a,m[xref:{tag-service-accounts}[Control Plane Service Accounts\]]
2834

2935
// For serverless, show this section at the end of the doc
3036
ifndef::env-serverless[]
@@ -353,22 +359,22 @@ endif::[]
353359

354360
== Manage RBAC
355361

356-
The available endpoints for managing xref:security:authorization/rbac.adoc[RBAC configurations], for example assigning xref:security:authorization/rbac.adoc#predefined-roles[roles] to a users and service accounts in the control plane, contain the version string `v1alpha1` in the path.
362+
The endpoints for managing xref:security:authorization/rbac.adoc[RBAC configurations], for example assigning xref:security:authorization/rbac.adoc#predefined-roles[roles] to a users and service accounts in the control plane, contain the version string `v1alpha1` in the path.
357363

358364
=== List role bindings
359365

360366
To see role assignments for IAM user and service accounts, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/role-bindings[`/v1alpha1/role-bindings`] endpoint.
361367

362368
[,bash]
363369
----
364-
curl "https://api.redpanda.com/v1alpha1/role-bindings?filter.role_name=<role-name>&filter.scope.resource_type=SCOPE_RESOURCE_TYPE_CLUSTER" \
370+
curl https://api.redpanda.com/v1alpha1/role-bindings?filter.role_name=<role-name>&filter.scope.resource_type=SCOPE_RESOURCE_TYPE_CLUSTER \
365371
-H "Authorization: Bearer <token>" \
366372
-H "Content-Type: application/json"
367373
----
368374

369375
=== Get role binding
370376

371-
To see roles assignments for a specific IAM account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/role-bindings/-id-[`/v1alpha1/role-bindings/\{id}`] endpoint.
377+
To see roles assignments for a specific IAM account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/role-bindings/-id-[`/v1alpha1/role-bindings/\{id}`] endpoint, passing the role binding ID as a parameter.
372378

373379
[,bash]
374380
----
@@ -379,7 +385,7 @@ curl "https://api.redpanda.com/v1alpha1/role-bindings/<role-binding-id> \
379385

380386
=== Get user
381387

382-
To see details of an IAM user account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/users/-id-[`/v1alpha1/users/\{id}`] endpoint.
388+
To see details of an IAM user account, make a GET request to the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1alpha1/users/-id-[`/v1alpha1/users/\{id}`] endpoint, passing the user account ID as a parameter.
383389

384390
[,bash]
385391
----
@@ -390,7 +396,7 @@ curl "https://api.redpanda.com/v1alpha1/users/<user-account-id> \
390396

391397
=== Create role binding
392398

393-
To assign a role to an IAM user or service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1alpha1/role-bindings[`/v1alpha1/role-bindings`] endpoint. Specify the role and resource scope in the request body.
399+
To assign a role to an IAM user or service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1alpha1/role-bindings[`/v1alpha1/role-bindings`] endpoint. Specify the role and scope, which includes the specific resource ID and an optional resource type, in the request body.
394400

395401
[,bash]
396402
----
@@ -411,7 +417,7 @@ curl -X POST "https://api.redpanda.com/v1alpha1/role-bindings" \
411417

412418
NOTE: Service accounts are assigned the Admin role for all resources in the organization.
413419

414-
To create a new service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1alpha1/service-accounts[`/v1alpha1/service-accounts`] endpoint.
420+
To create a new service account, make a POST request to the xref:api:ROOT:cloud-controlplane-api.adoc#post-/v1alpha1/service-accounts[`/v1alpha1/service-accounts`] endpoint, with a service account name and optional description in the request body.
415421

416422
[,bash]
417423
----

0 commit comments

Comments
 (0)