Skip to content

Fix cache option defaults in help - #22708

Merged
stianst merged 1 commit into
keycloak:mainfrom
vmuzikar:fix-cache-docs
Aug 28, 2023
Merged

Fix cache option defaults in help#22708
stianst merged 1 commit into
keycloak:mainfrom
vmuzikar:fix-cache-docs

Conversation

@vmuzikar

Copy link
Copy Markdown
Contributor

We could change the description based on the profile used but this approach would be problematic with the generated docs. So kept it simple for now and added just a text note there.

Closes #22707

@vmuzikar
vmuzikar requested review from a team as code owners August 25, 2023 07:14

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.

A bit lengthy and strange to add the extra Note at the end.

I'd suggest something along the lines of:

By default in production mode, a 'ispn' cache is used to create a cluster between multiple server nodes. By default in development mode, a local cache disables clustering and is intended for development and testing purposes.

Looking at the docs:

image

It's says ispn is the default, but not sure how we can easily change that since there's two different defaults, maybe we just live with it as is for now

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Changed per your suggestion.

It's says ispn is the default, but not sure how we can easily change that since there's two different defaults, maybe we just live with it as is for now

Yeah, doesn't seem simple enough to do. We could probably do it as a follow-up as it concerns more than just cache option.

@ghost ghost added the flaky-test label Aug 25, 2023

@ghost ghost left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Unreported flaky test detected, please review

@ghost

ghost commented Aug 25, 2023

Copy link
Copy Markdown

Unreported flaky test detected

If the below flaky tests below are affected by the changes, please review and update the changes accordingly. Otherwise, a maintainer should report the flaky tests prior to merging the PR.

org.keycloak.testsuite.ui.account2.LinkedAccountsTest#linkAccountTest

Keycloak CI - Account Console IT (firefox)

org.openqa.selenium.NoSuchElementException: 
Unable to locate element: #social\-kc\-to\-kc\-account
For documentation on this error, please visit: http://seleniumhq.org/exceptions/no_such_element.html
Build info: version: '3.14.0', revision: 'aacccce0', time: '2018-08-02T20:19:58.91Z'
System info: host: 'fv-az344-249', ip: '10.1.0.186', os.name: 'Linux', os.arch: 'amd64', os.version: '5.15.0-1041-azure', java.version: '17.0.8'
...

Report flaky test

Closes keycloak#22707

Co-authored-by: Stian Thorgersen <stianst@gmail.com>
@stianst
stianst merged commit 1811c39 into keycloak:main Aug 28, 2023
@vmuzikar
vmuzikar deleted the fix-cache-docs branch August 28, 2023 10:09
vmuzikar added a commit to vmuzikar/keycloak that referenced this pull request Aug 28, 2023
Closes keycloak#22707

Co-authored-by: Stian Thorgersen <stianst@gmail.com>

(cherry picked from commit 1811c39)
stianst pushed a commit that referenced this pull request Aug 28, 2023
Closes #22707

Co-authored-by: Stian Thorgersen <stianst@gmail.com>

(cherry picked from commit 1811c39)
This was referenced Sep 4, 2023
@stianst stianst mentioned this pull request Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

start-dev by default starts with cache local, but docs state otherwise

2 participants