docs(docs): config options and keycloak concepts #289
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: prmellor <[email protected]>
There was a problem hiding this comment.
Pull request overview
This pull request enhances the Strimzi Kafka OAuth documentation by adding comprehensive configuration reference tables, introducing a dedicated guide for Keycloak Authorization Services concepts, and improving clarity throughout existing documentation sections.
- Added three configuration reference tables for broker, client, and KeycloakAuthorizer options
- Created new documentation explaining how Kafka authorization maps to Keycloak Authorization Services
- Reorganized and clarified token validation sections with new subsection on JWKS caching behavior
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 10 comments.
| File | Description |
|---|---|
examples/kubernetes/README.md |
Updated reference link to metrics example and added link to new Keycloak authorization guide |
examples/kubernetes/README-keycloak-authorization.md |
New comprehensive guide explaining Keycloak Authorization Services integration, resource/scope mapping, and permissions model for Kafka |
README.md |
Major documentation improvements including reorganized headings, new JWKS caching section, comprehensive configuration reference tables, and terminology consistency updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: prmellor <[email protected]>
mstruk
requested changes
Dec 8, 2025
Contributor
mstruk
left a comment
mstruk
left a comment
There was a problem hiding this comment.
Very nice, I only found two small issues. Thanks.
Signed-off-by: prmellor <[email protected]>
Signed-off-by: prmellor <[email protected]>
Author
|
Thanks for the review @mstruk |
mstruk
approved these changes
Dec 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation
This pull request updates the
README.md. The changes include reorganizing sections, clarifying configuration steps, adding new subsections, and enhancing explanations for key features such as JWKS caching and local JWT validation.