Add User resource docs #773
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
I've added extra links to the CRD reference. |
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
| === Create a new user without any ACLs | ||
|
|
||
| - *Use case*: You want to create and manage user credentials (authentication) without managing ACLs. Use this option If you have a separate process to manage ACLs or if you're working in an environment where access control is handled externally. | ||
| - *What happens when deleted*: The user is deleted, but ACLs for that user will remain in the cluster. |
There was a problem hiding this comment.
Found this a bit confusing--isn't the whole point of this use case that you are not using ACLs for this user? So if you delete a user, why state ACLs remain in the cluster when the use case is that you are not creating any for that user? Is this in the case that someone else has assigned ACLs to this user?
There was a problem hiding this comment.
Maybe say What happens when the user is deleted:
There was a problem hiding this comment.
It’s more about what happens when the User resource is deleted in Kubernetes. It might not be obvious that if ACLs aren’t defined in the User resource they remain in the cluster even after the resource is deleted.
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Joyce Fee <[email protected]>
|
Just a nit could we have a direct link to the User and UserList CRDs? https://deploy-preview-773--redpanda-docs-preview.netlify.app/24.3/reference/k-crd/#k8s-api-github.aaakk.us.kg-redpanda-data-redpanda-operator-operator-api-redpanda-v1alpha2-user |
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/kubernetes/security/authentication/k-user-controller.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]>
Co-authored-by: Paulo Borges <[email protected]> Co-authored-by: Joyce Fee <[email protected]>
Description
Resolves https://github.com/redpanda-data/documentation-private/issues/2655
Review deadline: 21 October
Examples are provided by the acceptance tests in the source code: https://github.com/redpanda-data/redpanda-operator/blob/main/acceptance/features/user-crds.feature
Related: redpanda-data/redpanda-operator#256
Page previews
Preview: https://deploy-preview-773--redpanda-docs-preview.netlify.app/24.3/manage/kubernetes/security/authentication/k-user-controller/
Checks