Skip to content

Conversation

@adombeck
Copy link
Contributor

This adds documentation on how to use the generic OIDC broker with Keycloak.

UDENG-8809

@adombeck adombeck force-pushed the docs-keycloak branch 3 times, most recently from d724096 to d588d03 Compare January 20, 2026 22:37
@adombeck adombeck marked this pull request as ready for review January 20, 2026 22:50
@adombeck adombeck mentioned this pull request Jan 21, 2026
2 tasks
@adombeck adombeck requested a review from edibotopic January 21, 2026 20:38
Copy link
Contributor

@edibotopic edibotopic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Adrian. It's great to have this broker and use-case in the docs. Mostly minor suggestions, although I think a path needs to be fixed in one command.

It made me wonder should we add Keycloak and other Identity and Access Management tools that are supported through the OIDC broker to this reference page in the docs:

Image

In that case, perhaps we would need to change the name from "cloud providers" to something more generic. Maybe a separate discussion and PR.

Another question is whether we should highlight the availability of the generic broker and the keycloak example on the homepage?

Image

@adombeck
Copy link
Contributor Author

Thanks for the great review, as always!

It made me wonder should we add Keycloak and other Identity and Access Management tools that are supported through the OIDC broker to this reference page in the docs:

Yes, I think we should! I pushed a commit which adds it to that doc and to the home page.

In that case, perhaps we would need to change the name from "cloud providers" to something more generic.

Agreed. I changed it to "identity provider" for now. What do you think about that?

@edibotopic
Copy link
Contributor

edibotopic commented Jan 22, 2026

Agreed. I changed it to "identity provider" for now. What do you think about that?

--- Sounds good to me @adombeck .

Copy link
Contributor

@edibotopic edibotopic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Excellent work.

We currently only document how to use the generic OIDC broker with
Keycloak. Let's also explain on the install-authd page how to install
the broker corresponding to Keycloak, for consistency.

If we later want to document how to use other identity providers with
the generic OIDC broker, we can add more tabs which also correspond to
the authd-oidc broker.
... except when at the beginning of a sentence, then it's uppercase.
That's how it's done in the snap documentation, so we should do the
same.
It's the more technically correct term and also applies to Keycloak,
which we now support and is not necessarily cloud-based.
@adombeck adombeck merged commit 02d3524 into canonical:main Jan 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants