-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] update the Using the User Operator section #2944
Conversation
Signed-off-by: prmellor <pmellor@redhat.com>
Can one of the admins verify this patch? |
Signed-off-by: prmellor <pmellor@redhat.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One nit about empty line. But LGTM otherwise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good. I left a couple of minor comments.
Signed-off-by: prmellor <pmellor@redhat.com>
@ppatierno any further comments? |
Signed-off-by: prmellor <pmellor@redhat.com>
* update the using the user operator section Signed-off-by: prmellor <pmellor@redhat.com> * review edits JS Signed-off-by: prmellor <pmellor@redhat.com> * review edits DL Signed-off-by: prmellor <pmellor@redhat.com> * change order of additional deployment options Signed-off-by: prmellor <pmellor@redhat.com>
Signed-off-by: prmellor pmellor@redhat.com
Documentation
The presentation of the content in the_Using the User Operator_ section of the Using Guide was a little confusing.
In this PR, I've reworked to minimize the content and reflect a logical order.
The Operators are introduced earlier in the guide, so this section is just about using the operator to manage users.
Removed
using -uo
context as no longer neededOld structure
6. Using the User Operator
6.1. Mutual TLS authentication
6.1.1. When to use mutual TLS authentication for clients
6.2. Creating a Kafka user with mutual TLS authentication
6.3. SCRAM-SHA authentication
6.3.1. Supported SCRAM credentials
6.3.2. When to use SCRAM-SHA authentication for clients
6.4. Creating a Kafka user with SCRAM SHA authentication
6.5. Editing a Kafka user
6.6. Deleting a Kafka user
6.7. Kafka User resource
6.7.1. Authentication
6.7.2. Authorization
6.7.3. User quotas
New structure
6. Using the User Operator
6.1. Securing user access to Kafka
6.1.1. User authentication
6.1.2. User authorization
6.1.3. User quotas
6.2. Configuring a Kafka user
Checklist
Please go through this checklist and make sure all applicable tasks have been done
./design