-
Notifications
You must be signed in to change notification settings - Fork 225
feat(helm-chart): add IdP via internal keycloak guide #7426
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
base: main
Are you sure you want to change the base?
Conversation
3a2de2f to
7c25d0a
Compare
ThorbenLindhauer
left a comment
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.
Thanks for creating the guide, it's very clear and I was able to make things work in a local setup. I have a few suggestions below, as usual they are up for debate :)
...oyment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Add your external IdP to Keycloak | ||
|
|
||
| Configure Keycloak to use your external identity provider by following the [Configure an external IdP using Keycloak](/self-managed/components/management-identity/configuration/configure-external-identity-provider.md) guide. |
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.
Maybe we can give it as a follow-up to the docs team to move the linked guide into a central/reference location (as it's not specific to Management Identity anymore).
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.
Yeah this ended up being more generalised 🤔
@giorgionaps consideration for docs team followup
...oyment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md
Show resolved
Hide resolved
...oyment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md
Outdated
Show resolved
Hide resolved
...oyment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md
Show resolved
Hide resolved
...oyment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md
Outdated
Show resolved
Hide resolved
...oyment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md
Outdated
Show resolved
Hide resolved
...oyment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md
Show resolved
Hide resolved
e30cbff to
5473a9e
Compare
bkenez
left a comment
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.
Done - moved the guide to be second-to-last in the section (just above troubleshooting).
bkenez
left a comment
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.
Done - added clarification that mappers should be configured in the Camunda realm (default: camunda-platform).
bkenez
left a comment
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.
Done - added username as the suggested name for the username mapper.
bkenez
left a comment
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.
Done - added brief explanations for each mapper type (attribute mappers, username mapper, and hardcoded group mapper) to help readers understand what each configuration does.
bkenez
left a comment
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.
Done - added a tip explaining the direct group authorization alternative using the groups-claim feature, which is enabled by default with the internal Keycloak Helm chart setup.
bkenez
left a comment
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.
Done - added a note clarifying that hardcoded group mappers grant access to all external IdP users, with a link to Keycloak docs for more granular access control options.
bkenez
left a comment
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.
Done - removed the generic 'Understanding the two identity systems' section and moved the link to the 'Next steps' section instead.
ThorbenLindhauer
left a comment
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.
Thanks for making the adjustments. Looks overall fine, except one comment about the group/mapping rule topic. Please see below.
...oyment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md
Outdated
Show resolved
Hide resolved
e6e41c3 to
01616bd
Compare
|
@giorgionaps Please review this once @bkenez confirms it is ready for a TW review (I think there is one outstanding technical review comment) 🙏 |
ThorbenLindhauer
left a comment
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.
Thanks, looks good now!
|
@giorgionaps ready for TW review! |
Description
Epic: #4613
Closes: #7108
Adds a coument explaining how to set up the helm chart using the internal Keycloak to broker an external IdP.
Essentially a bridge document between the internal keycloak guide and the external IdP integration, with some additional steps on how to configure groups/roles.
When should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
{type}(scope): {description}commit message(s)/docsdirectory (version 8.9)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.