8000 JPA spi example added by psytester · Pull Request #11110 · keycloak/keycloak · GitHub
[go: up one dir, main page]

Skip to content

JPA spi example added - #11110

Merged
stianst merged 4 commits into
keycloak:mainfrom
psytester:patch-1
Aug 26, 2022
Merged

stianst merged 4 commits into
keycloak:mainfrom
psytester:patch-1

Conversation

@psytester
@psytester psytester commented Apr 5, 2022 •
Copy link
Copy Markdown
Contributor

Added: how to configure spi for JPA migration settings

Closes discussions #11099 as found solution in issue #10871

@stianst stianst left a comment •
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should rather document this in the configuring the database guide. I thought it was already covered somewhere, but probably mistaken

@psytester
Copy link
Copy Markdown
Contributor Author

@stianst what do you expect here? Should I rebuild the PR and add the extension into database guide or do you wait for a review of @DGuhr / @pedroigor?

@stianst
stianst commented Apr 26, 2022
Copy link
Copy Markdown
Contributor

@psytester if you update the PR to add a section to https://github.com/keycloak/keycloak/blob/main/docs/guides/src/main/server/db.adoc instead of the provider config guide that'd be great.

@pedroigor
Copy link
Copy Markdown
Contributor

@psytester Thanks. Can you please update the database guide as suggested by Stian?

I'm also wondering if it makes sense to provide some configuration options instead of using the SPI configuration? Not sure because of the upcoming changes to storage though.

@DGuhr DGuhr left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  • I also think the right place would be a setting the migration strategy for JPA section in the db guide instead.
  • I also think it makes sense to have the config exposed in a more convenient way, e.g. db-migration-strategy, but i would suggest to handle this as a follow up. Created #11678 to discuss this further

@psytester
Copy link
Copy Markdown
Contributor Author

Change is done.

Which magic does add the chapter "Relevant options" to the page to show config parameter and they possible values in a table? https://www.keycloak.org/server/db

pedroigor
pedroigor previously approved these changes Jun 14, 2022
Added: how to configure JPA migration
moved JPA config to db.adoc
@DGuhr
DGuhr commented Jun 15, 2022
Copy link
Copy Markdown
Contributor

@psytester Sorry for reaching back late. The magic is in the first lines:

... includedOptions="db db-* transaction-xa-enabled"

but this magic does not work for SPI-settings so-far, as they are not wrapped in the new configuration layer (it only works for configuration we have a mapper for, and as the SPIs are loaded differently (not "wrapped" by this layer), they can't be rendered in the section atm. That said, there's #11678 to change this, but I have not gotten an answer there so-far from the store team and at the moment we are restructuring the config into its own package in #12435 so I hesitate to change sth before this is done.

@pedroigor this opens up a kind-of interesting question, that is, can and should we include the spi options into the docs "relevant options" table another way?

Apart from that i'll also approve here for now, as it should help ppl nevertheless :) thanks.

DGuhr
DGuhr previously approved these changes Jun 15, 2022
@stianst
stianst merged commit ae54fa8 into keycloak:main Aug 26, 2022
@pedroigor
Copy link
Copy Markdown
Contributor

@stianst The example is now wrong after the new store integration. The options should use legacy instead of quarkus as the provider ir.

@psytester
Copy link
Copy Markdown
Contributor Author

use legacy instead of quarkus as the provider.

Was my first thought too

@pedroigor
Copy link
Copy Markdown
Contributor

@psytester #14038

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.

4 participants

0