Update tag for User Service

[kbatuigas]

Give that we are about to expose IAM endpoints in the Control Plane, which also has the concepts/ entities for users, roles, etc, we can update the OpenAPI spec to specify that the endpoints here are used to interact with users within the data plane.

As of now there is an "unofficial" consensus that we refer to the users, etc in the control plane as "Control Plane Users" etc - that is, we add the qualifier "control plane" - see also Slack thread So I think the quickest solution for the time being, while we hash it out or perhaps get Product's guidance, is to just also use the label or qualifier "data plane" here.

cc @sago2k8

[weeco]

@kbatuigas @sago2k8 Eventually we should come up with something better. This API should/will become available for self-hosted users where the concept of Dataplane / Controlplane doesn't exist (or irrelevant to them). For this audience the terminology will be confusing. I'm still in favour of separating the docs more between controlplane and dataplane as suggested in Slack

[sago2k8]

@kbatuigas @sago2k8 Eventually we should come up with something better. This API should/will become available for self-hosted users where the concept of Dataplane / Controlplane doesn't exist (or irrelevant to them). For this audience the terminology will be confusing. I'm still in favour of separating the docs more between controlplane and dataplane as suggested in Slack

I agree with this, should we keep it as User no prefix ? The risk is low (imo) since we have different documentation files

[kbatuigas]

@kbatuigas @sago2k8 Eventually we should come up with something better. This API should/will become available for self-hosted users where the concept of Dataplane / Controlplane doesn't exist (or irrelevant to them). For this audience the terminology will be confusing. I'm still in favour of separating the docs more between controlplane and dataplane as suggested in Slack

@weeco @sago2k8 Yup, the split is underway: redpanda-data/docs#929 This should be merged this week.

Previews of split reference:

• Control Plane API
• Data Plane API

I need to merge a couple of recent commits from cloudv2/console, but this is more or less what we'll have in the docs. You'll see though that the "Data Plane" descriptor is only in the page title and the overview section. I think it's better to also add it to this User service so that in the event a reader stumbles onto this with no other context, they'll at least know which plane and which type of users this API interacts with.

I do agree that we can do more to explain control plane vs data plane. We have a little bit in the Cloud docs overview and Cloud API overviews, but definitely with regards to "users" and "roles" we have to flesh that out more. It's a conversation we've (Michele and I from Docs) have started with Denis, Mo, Santi because of Cloud RBAC and the introduction of the IAM endpoints in the Control Plane. But that's still ongoing and we've yet to finalize the best "story" behind these concepts.

But in the meantime, adding the respective CP vs DP descriptors at least to the services helps to wave a flag.

[kbatuigas]

@weeco Do you know of the timeline for when this API will be available to self-hosted? I don't have any heads up on this from Core, so it's not something we've factored into yet on the Docs side.