8000 Removal of of cli options for the cache stacks by ruchikajha95 · Pull Request #54901 · keycloak/keycloak · GitHub
[go: up one dir, main page]

Skip to content

Removal of of cli options for the cache stacks - #54901

Merged
ahus1 merged 6 commits into
keycloak:mainfrom
ruchikajha95:iss-54598/Remove-deprecated-cache-stack-CLI-options
Nov 12, 2026
Merged

ahus1 merged 6 commits into
keycloak:mainfrom
ruchikajha95:iss-54598/Remove-deprecated-cache-stack-CLI-options

Conversation

@ruchikajha95
Copy link
Copy Markdown
Contributor

Closes #54598

@ahus1 ahus1 left a comment
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for this PR. There might have been a slight misunderstanding when setting up the issue:

This states to remove the deprecated stacks.

Completely remove the deprecated cache-stack CLI options from Keycloak 27.x, leaving only jdbc-ping as the available built-in stack options

What I probably had in mind: "Completely remove the cache-stack CLI option", which would mean no longer specifying --cache-stack on the CLI. The "escape hatch" for people who want to use their own stack would then be to put it into the caching XML file.

Please remove those extra parts, or we can discuss it in more details in our team planning meeting.

Removing those extra parts would then need some touch-up on the migration guide.

@ruchikajha95
ruchikajha95 force-pushed the iss-54598/Remove-deprecated-cache-stack-CLI-options branch from 44dc441 to 2b80b1f Compare November 10, 2026 16:44
@ruchikajha95
ruchikajha95 requested review from ahus1 and a balanced review from Copilot November 11, 2026 09:57
Copilot AI 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.

🔵 Needs a closer look

All seven changed help snapshots are truncated after Cache even though the CLI still prints later sections, causing full-output approval tests to fail.

No open issues 🎉

What changed in this PR

Removes the --cache-stack option from Keycloak as a follow-up to #54598. Default clustering continues to use jdbc-ping, while custom stacks are configured through cache XML.

Changes:

  • Removes stack option definitions, runtime mapping, validation and compatibility metadata.
  • Updates affected tests, CLI help snapshots and operator configuration handling.
  • Documents the removal and the migration path for custom stacks.
File Description
testsuite/​integration-arquillian/​tests/​base/​src/​main/​java/​org/​keycloak/​testsuite/​arquillian/​containers/​AbstractQuarkusDeployableContainer.java Stops passing the stack CLI argument.
quarkus/​tests/​integration/​src/​test/​resources/​org/​keycloak/​it/​cli/​dist/​approvals/​cli/​help/​HelpCommandDistTest.testUpdateCompatibilityMetadataHelpAll.approved.txt Updates metadata full-help expectations.
quarkus/​tests/​integration/​src/​test/​resources/​org/​keycloak/​it/​cli/​dist/​approvals/​cli/​help/​HelpCommandDistTest.testUpdateCompatibilityMetadataHelp.approved.txt Updates metadata help expectations.
quarkus/​tests/​integration/​src/​test/​resources/​org/​keycloak/​it/​cli/​dist/​approvals/​cli/​help/​HelpCommandDistTest.testUpdateCompatibilityCheckHelpAll.approved.txt Updates compatibility-check full-help expectations.
quarkus/​tests/​integration/​src/​test/​resources/​org/​keycloak/​it/​cli/​dist/​approvals/​cli/​help/​HelpCommandDistTest.testUpdateCompatibilityCheckHelp.approved.txt Updates compatibility-check help expectations.
quarkus/​tests/​integration/​src/​test/​resources/​org/​keycloak/​it/​cli/​dist/​approvals/​cli/​help/​HelpCommandDistTest.testStartOptimizedHelpAll.approved.txt Updates optimized-start full-help expectations.
quarkus/​tests/​integration/​src/​test/​resources/​org/​keycloak/​it/​cli/​dist/​approvals/​cli/​help/​HelpCommandDistTest.testStartOptimizedHelp.approved.txt Updates optimized-start help expectations.
quarkus/​tests/​integration/​src/​test/​resources/​org/​keycloak/​it/​cli/​dist/​approvals/​cli/​help/​HelpCommandDistTest.testStartHelp.approved.txt Updates start help expectations.
quarkus/​tests/​integration/​src/​test/​java/​org/​keycloak/​it/​cli/​dist/​ClusterConfigDistTest.java Removes obsolete stack validation tests.
quarkus/​runtime/​src/​test/​java/​org/​keycloak/​quarkus/​runtime/​configuration/​ConfigurationTest.java Removes the stack mapping assertion.
quarkus/​runtime/​src/​test/​java/​org/​keycloak/​quarkus/​runtime/​cli/​UpdateCompatibilityPicocliTest.java Removes stack compatibility checks.
quarkus/​runtime/​src/​test/​java/​org/​keycloak/​quarkus/​runtime/​cli/​PicocliTest.java Uses default discovery in pool-size validation.
quarkus/​runtime/​src/​main/​java/​org/​keycloak/​quarkus/​runtime/​configuration/​mappers/​DatabasePropertyMappers.java Simplifies the JDBC discovery check.
quarkus/​runtime/​src/​main/​java/​org/​keycloak/​quarkus/​runtime/​configuration/​mappers/​CachingPropertyMappers.java Removes stack mapping and revises TLS help wording.
quarkus/​config-api/​src/​main/​java/​org/​keycloak/​config/​CachingOptions.java Removes the stack enum and option definition.
operator/​src/​test/​java/​org/​keycloak/​operator/​testsuite/​unit/​PodTemplateTest.java Uses cache configuration files for environment precedence testing.
operator/​src/​main/​java/​org/​keycloak/​operator/​controllers/​KeycloakRealmImportJobDependentResource.java Removes stack-specific environment filtering.
model/​infinispan/​src/​main/​java/​org/​keycloak/​spi/​infinispan/​impl/​embedded/​JGroupsConfigurator.java Removes stack overrides and unsupported-stack errors.
model/​infinispan/​src/​main/​java/​org/​keycloak/​spi/​infinispan/​impl/​embedded/​DefaultCacheEmbeddedConfigProviderFactory.java Removes the stack configuration constant.
model/​infinispan/​src/​main/​java/​org/​keycloak/​infinispan/​compatibility/​CachingEmbeddedMetadataProvider.java Stops recording the stack configuration key.
docs/​guides/​server/​update-compatibility.adoc Removes the stack option from recreate-update triggers.
docs/​documentation/​upgrading/​topics/​changes/​changes-27_0_0.adoc Documents option removal and custom-stack migration.

Review effort: Balanced

@ruchikajha95
ruchikajha95 force-pushed the iss-54598/Remove-deprecated-cache-stack-CLI-options branch from 07d20fc to a199872 Compare November 11, 2026 14:48
ruchikajha95 and others added 5 commits November 11, 2026 14:51
Closes keycloak#54598
Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
Closes keycloak#54598

Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
Closes keycloak#54598

Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com>
@ruchikajha95
ruchikajha95 force-pushed the iss-54598/Remove-deprecated-cache-stack-CLI-options branch from 5749a8a to ef220e9 Compare November 11, 2026 14:51
…d after cleanup

Closes keycloak#54598

Signed-off-by: Ruchika <ruchika.jha1@ibm.com>
@ahus1
ahus1 marked this pull request as ready for review November 12, 2026 09:19
@ahus1
ahus1 requested review from a team as code owners November 12, 2026 09:19
Copilot AI balanced review requested due to automatic review settings November 12, 2026 09:19
@ahus1
ahus1 merged commit 30a1f3e into keycloak:main Nov 12, 2026
111 of 129 checks passed
Copilot AI 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.

🟢 Approval recommended

No active review issues remain for the removal of --cache-stack and its supporting configuration.

No open issues 🎉

Review effort: Balanced

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.

Remove deprecated cache-stack CLI options completely

3 participants

0