Skip to content
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

Merged
merged 4 commits into from
May 12, 2020

Conversation

PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented May 4, 2020

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

  • 4 files
  • Replication of 2 files (using x-refs to other locations instead)
  • using -uo context as no longer needed

Old 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

  • Update/write design documentation in ./design
  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md

Signed-off-by: prmellor <pmellor@redhat.com>
@strimzi-ci
Copy link

Can one of the admins verify this patch?
Run tests: @strimzi-ci run tests

Signed-off-by: prmellor <pmellor@redhat.com>
Copy link
Member

@scholzj scholzj left a 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.

Copy link
Member

@d-laing d-laing left a 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.

documentation/modules/proc-configuring-kafka-user.adoc Outdated Show resolved Hide resolved
documentation/modules/proc-configuring-kafka-user.adoc Outdated Show resolved Hide resolved
Signed-off-by: prmellor <pmellor@redhat.com>
@PaulRMellor
Copy link
Contributor Author

@ppatierno any further comments?

Signed-off-by: prmellor <pmellor@redhat.com>
@PaulRMellor PaulRMellor added sme-review-done ready for merge Label for PRs which are ready for merge and removed sme-review-needed labels May 12, 2020
@scholzj scholzj merged commit e7d200a into strimzi:master May 12, 2020
klalafaryan pushed a commit to klalafaryan/strimzi-kafka-operator that referenced this pull request Oct 21, 2020
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation peer-review-done ready for merge Label for PRs which are ready for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants