Skip to content

Configuring providers guide#10401

Merged
stianst merged 1 commit intokeycloak:mainfrom
pedroigor:issue-10400
Feb 24, 2022
Merged

Configuring providers guide#10401
stianst merged 1 commit intokeycloak:mainfrom
pedroigor:issue-10400

Conversation

@pedroigor
Copy link
Copy Markdown
Contributor

Closes #10400

@thomasdarimont
Copy link
Copy Markdown
Contributor

LGTM

@tanadeau
Copy link
Copy Markdown

One of the questions I had in one of the GitHub discussions was if and how you could pass SPI config via environment variables, and the answer was yes via KC_SPI_.... Since this mentions the config format, perhaps a mention of that would be helpful.

@dasniko
Copy link
Copy Markdown
Contributor

dasniko commented Feb 23, 2022

Sounds good to me, but adding a hint for the env var format KC_SPI_... like @tanadeau already mentioned, would be good.

Additionally, perhaps an admonition or something similar to make clear, that just setting config values for a provider is done with runtime config and setting/enabling/disabling a provider is done at buildtime would make things more obviously to customers, as I already see confusion at users with the buildtime/runtime configs now used in Keycloak.

Comment thread docs/guides/src/main/server/configuration-provider.adoc Outdated
Comment thread docs/guides/src/main/server/configuration-provider.adoc Outdated
Comment thread docs/guides/src/main/server/configuration-provider.adoc Outdated
@pedroigor
Copy link
Copy Markdown
Contributor Author

@danielFesenmeyer @tanadeau The different configuration sources are covered in the Configuration Guide.

Not sure if we should explain here how to use env vars. Would make sense to include a link to the configuration guide in the References section?

@pedroigor
Copy link
Copy Markdown
Contributor Author

Additionally, perhaps an admonition or something similar to make clear, that just setting config values for a provider is done with runtime config and setting/enabling/disabling a provider is done at buildtime would make things more obviously to customers, as I already see confusion at users with the buildtime/runtime configs now used in Keycloak.

@dasniko I tried to make it obvious by providing examples using the appropriate command as well as a bit of text explaining the reason. But if you are asking is because it is not yet clear. Do you have any suggestions on how to make this clear?

Co-authored-by: Stian Thorgersen <[email protected]>

Closes keycloak#10400
@dasniko
Copy link
Copy Markdown
Contributor

dasniko commented Feb 23, 2022

I tried to make it obvious by providing examples using the appropriate command as well as a bit of text explaining the reason. But if you are asking is because it is not yet clear. Do you have any suggestions on how to make this clear?

@pedroigor For me, it's clear. But I notice some difficutlies for users in other forums to cope with now buildtime and runtime configs, as this is a new approach. Nothing special for the SPI config, but general config approach. Even when using the new config guide, people don't see that there are build and run configs. Sad, but true.

@pedroigor
Copy link
Copy Markdown
Contributor Author

@dasniko Yes, you are right. And we are trying since the beginning to make the build/runtime concepts less painful. Not an easy task, but I hope we can continuously improve the UX and make the build step more natural when configuring the server.

@tanadeau
Copy link
Copy Markdown

@pedroigor, just adding an environment example with the example you already have would be very helpful.

KC_SPI_CONNECTIONS_HTTP_CLIENT_DEFAULT_CONNECTION_POOL_SIZE

@pedroigor
Copy link
Copy Markdown
Contributor Author

@pedroigor, just adding an environment example with the example you already have would be very helpful.

KC_SPI_CONNECTIONS_HTTP_CLIENT_DEFAULT_CONNECTION_POOL_SIZE

I see. As I mentioned before, I would like to avoid duplicating information in guides. We kinda have that covered in the configuration guide. Formatting options to their corresponding env format should be trivial if you read that guide?

@stianst stianst merged commit 9297a5e into keycloak:main Feb 24, 2022
@pedroigor
Copy link
Copy Markdown
Contributor Author

@dasniko Could you please give your thoughts about #10451?

@pedroigor pedroigor added this to the 18.0.0 milestone Mar 11, 2022
@pedroigor pedroigor self-assigned this Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

Configuring providers guide

5 participants