Use Cloud API for RBAC #211
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
|
||
| [,bash] | ||
| ---- | ||
| curl "https://api.redpanda.com/v1alpha1/role-bindings?filter.role_name=<role-name>&filter.scope.resource_type=SCOPE_RESOURCE_TYPE_CLUSTER" \ |
There was a problem hiding this comment.
This endpoint has multiple filters available. Are there certain filters that we want to call out or provide examples for in the docs? We should base these on the most relevant and helpful use cases.
There was a problem hiding this comment.
Kat this is good however @Mateoc is working on v1, could we write the docs only for iamv1 so customers go only to the v1
|
|
||
| === Get role binding | ||
|
|
||
| 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. |
There was a problem hiding this comment.
| 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. | |
| 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-[`/v1role-bindings/\{id}`] endpoint, passing the role binding ID as a parameter. |
this is an example
kbatuigas
force-pushed
the
DOC-1012-Cloud-Add-RBAC-to-Use-the-Control-Plane-API-doc
branch
from
32b8b1b to
1bbdecb
Compare
|
This is blocked until we can get the imported specs (redpanda-data/docs#986) corrected so that v1beta2 versus v1 endpoints are clearly indicated (we don't support versioned API docs yet), and data plane specs are updated to the v1 endpoints. |
|
Status update: @sago2k8 has helped to unblock this PR on the control plane side - redpanda-data/docs#986 now includes updated tag names for v1beta2 to more clearly indicate the beta endpoints. Investigating a way to group the tags as v1 versus v1beta2 so that v1 endpoints are listed in the reference first, but not a blocker for this PR. Just need @sago2k8 's and Docs team approval before end of this week. |
Co-authored-by: Santiago Jimenez Giraldo <[email protected]>
Co-authored-by: Santiago Jimenez Giraldo <[email protected]>
|
@kbatuigas please make sure to add a blurb to What's New that Cloud API is now GA |
|
The beta tag still needs to be removed from the top-level Cloud API index page. |
|
@kbatuigas In the Cloud Overview here, will you please remove Cloud API from the list of features in beta? |
|
@kbatuigas please also doublecheck for |
|
This is ready to merge as soon as updated specs (redpanda-data/docs#986) are in. |
kbatuigas
deleted the
DOC-1012-Cloud-Add-RBAC-to-Use-the-Control-Plane-API-doc
branch
.## Description
This pull request adds new documentation for managing RBAC (Role-Based Access Control) in the control plane. The changes include instructions for listing role bindings, getting role bindings, getting user details, creating role bindings, and creating service accounts.
New RBAC management documentation:
Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline: 27 Feb 2025
Page previews
Use Control Plane API with BYOC > Manage RBAC
Checks