From 1cfe2b7ca80a2b4b876c4c9783799a13f4a8f89f Mon Sep 17 00:00:00 2001 From: ansible-middleware-core Date: Thu, 25 Jun 2026 03:21:40 +0000 Subject: [PATCH] Update docs for main Signed-off-by: ansible-middleware-core --- main/CHANGELOG.html | 816 +++++++++--------- main/_sources/CHANGELOG.rst.txt | 5 + .../keycloak_identity_provider.rst.txt | 73 +- main/plugins/keycloak_identity_provider.html | 73 +- main/searchindex.js | 2 +- 5 files changed, 492 insertions(+), 477 deletions(-) diff --git a/main/CHANGELOG.html b/main/CHANGELOG.html index ef278d7..1b43315 100644 --- a/main/CHANGELOG.html +++ b/main/CHANGELOG.html @@ -51,6 +51,7 @@
  • Changelog
    • v3.0.10-devel
    • v3.0.9 @@ -304,260 +305,261 @@
      -

      middleware_automation.keycloak Release Notes

      +

      middleware_automation.keycloak Release Notes

      This changelog describes changes after version 0.2.6.

      -

      v3.0.10-devel

      +

      v3.0.10-devel

      -

      Major Changes

      +

      Major Changes

      • Fixing linting issues #357

      +
      +

      Minor Changes

      +
        +
      • AMW-571 keycloak_identity_provider hide_on_login_page not working #356

      • +
      +
      -

      v3.0.9

      +

      v3.0.9

      -

      Bugfixes

      +

      Bugfixes

      • AMW-551 Providing correct rhbk version #344

      -

      v3.0.8

      +

      v3.0.8

      -

      v3.0.7

      -
      -

      Major Changes

      +

      v3.0.7

      +
      +

      Major Changes

      • Migrate Keycloak modules from the community.general collection to Keycloak collection. #341

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Fix molecule tests #339

      -

      v3.0.6

      -
      -

      Major Changes

      +

      v3.0.6

      +
      +

      Major Changes

      • AMW-540 Fix the upstream collection requirements with common v1.2.4 #337

      -

      v3.0.5

      -
      -

      Minor Changes

      +

      v3.0.5

      +
      +

      Minor Changes

      • AMW-528 Deployment fails in keycloak_quarkus due to missing escalation variables #335

      -

      v3.0.4

      -
      -

      Major Changes

      +

      v3.0.4

      +
      +

      Major Changes

      • AMW-467 Download keycloak binary from password protected HTTP location #321

      • v26.4.x compability #317

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • AMW-518 Validating arguments against arg spec ‘main’ fails unexpectedly. #324

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Removing parseable from lint file as Additional properties are not allowed #319

      -

      v3.0.3

      -
      -

      Major Changes

      +

      v3.0.3

      +
      +

      Major Changes

      • Update to keycloak 26.3.0 #293

      • ansible-core 2.19 compatibility #310

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • Allow to install provider jars from remote paths #303

      • Declared proxy_mode as deprecated, updated quarkus and realm readme #306

      • Fix config_key_store_file description to match variable name #308

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • keycloak collection CI label is showing no status #312

      • keycloak_realm: allow secret in keycloak_clients #304

      • @@ -674,9 +682,9 @@
      -

      v3.0.2

      -
      -

      Minor Changes

      +

      v3.0.2

      +
      +

      Minor Changes

      • New checksum property for keycloak_quarkus_providers #280

      • New parameter to set the jgroups host IP address #281

      • @@ -684,8 +692,8 @@
      • Update keycloak/RHBK to v26.2.4 #283

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Fix keycloak_quarkus_force_install parameter being ignored by install #296

      • Fix alternate download location being ignored (JBossNeworkAPI always used) #298

      • @@ -696,39 +704,39 @@
      -

      v3.0.1

      -
      -

      Minor Changes

      +

      v3.0.1

      +
      +

      Minor Changes

      • Version update to 26.0.8 / rhbk 26.0.11 #277

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Trigger rebuild handler on envvars file change #276

      -

      v3.0.0

      -
      -

      Minor Changes

      +

      v3.0.0

      +
      +

      Minor Changes

      • Add theme cache invalidation handler #252

      • keycloak_realm: change url variables to defaults #268

      -

      Breaking Changes / Porting Guide

      +

      Breaking Changes / Porting Guide

      • Bump major and ansible-core versions #266

      • Rename parameters to follow upstream #270

      • Update for keycloak v26 #254

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Access token lifespan is too short for ansible run #251

      • Load environment vars during kc rebuild #274

      • @@ -737,47 +745,47 @@
      -

      New Modules

      +

      New Modules

      • middleware_automation.keycloak.keycloak_realm - Allows administration of Keycloak realm via Keycloak API

      -

      v2.4.3

      -
      -

      Minor Changes

      +

      v2.4.3

      +
      +

      Minor Changes

      • Update keycloak to 24.0.5 #241

      -

      v2.4.2

      -
      -

      Minor Changes

      +

      v2.4.2

      +
      +

      Minor Changes

      • New parameter keycloak_quarkus_download_path #239

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Add wait_for_port number parameter #237

      -

      v2.4.1

      +

      v2.4.1

      -

      Release Summary

      +

      Release Summary

      Internal release, documentation or test changes only.

      -

      v2.4.0

      -
      -

      Major Changes

      +

      v2.4.0

      +
      +

      Major Changes

      • Enable by default health check on restart #234

      • Update minimum ansible-core version > 2.15 #232

      • @@ -785,16 +793,16 @@
      -

      v2.3.0

      -
      -

      Major Changes

      +

      v2.3.0

      +
      +

      Major Changes

      • Allow for custom providers hosted on maven repositories #223

      • Restart handler strategy behaviour #231

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • Add support for policy files #225

      • Allow to add extra custom env vars in sysconfig file #229

      • @@ -803,52 +811,52 @@
      • proxy-header enhancement #227

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • kc.sh build uses configured jdk #211

      -

      v2.2.2

      -
      -

      Minor Changes

      +

      v2.2.2

      +
      +

      Minor Changes

      • Copying of key material for TLS configuration #210

      • Validate certs parameter for JDBC driver downloads #207

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Turn off controller privilege escalation #209

      -

      v2.2.1

      -
      -

      Release Summary

      +

      v2.2.1

      +
      +

      Release Summary

      Internal release, documentation or test changes only.

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • JDBC provider: fix clause in argument validation #204

      -

      v2.2.0

      -
      -

      Major Changes

      +

      v2.2.0

      +
      +

      Major Changes

      • Support java keystore for configuration of sensitive options #189

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • Add wait_for_port and wait_for_log systemd unit logic #199

      • Customize jdbc driver downloads, optional authentication #202

      • @@ -861,24 +869,24 @@
      -

      v2.1.2

      -
      -

      Release Summary

      +

      v2.1.2

      +
      +

      Release Summary

      Internal release, documentation or test changes only.

      -

      v2.1.1

      -
      -

      Minor Changes

      +

      v2.1.1

      +
      +

      Minor Changes

      • Add reverse proxy_headers config, supersedes proxy_mode #187

      • Debian/Ubuntu compatibility #178

      • Use keycloak_realm as default for sub-entities #180

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Fix permissions on controller-side downloaded artifacts #184

      • JVM args moved to JAVA_OPTS envvar (instead of JAVA_OPTS_APPEND) #186

      • @@ -888,46 +896,46 @@
      -

      v2.1.0

      -
      -

      Major Changes

      +

      v2.1.0

      +
      +

      Major Changes

      • Implement infinispan TCPPING discovery protocol #159

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • Set enable-recovery when xa transactions are enabled #167

      • keycloak_quarkus: Allow configuring log rotate options in quarkus configuration #161

      • keycloak_quarkus: sticky-session for infinispan routes #163

      -
      -

      Breaking Changes / Porting Guide

      +
      +

      Breaking Changes / Porting Guide

      • keycloak_quarkus: renamed infinispan host list configuration #157

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • keycloak_quarkus: fix custom JAVA_HOME parameter name #171

      -

      v2.0.2

      -
      -

      Minor Changes

      +

      v2.0.2

      +
      +

      Minor Changes

      • keycloak_quarkus: Add support for sqlserver jdbc driver #148

      • keycloak_quarkus: allow configuration of hostname-strict-backchannel #152

      • keycloak_quarkus: systemd restart behavior #145

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • keycloak_quarkus: Use keycloak_quarkus_java_opts #154

      • keycloak_quarkus: allow ports <1024 (e.g. :443) in systemd unit #150

      • @@ -935,32 +943,32 @@
      -

      v2.0.1

      -
      -

      Minor Changes

      +

      v2.0.1

      +
      +

      Minor Changes

      • keycloak_quarkus: add hostname-strict parameter #139

      • keycloak_quarkus: update to version 23.0.1 #133

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • keycloak_quarkus: template requires lowercase boolean values #138

      -

      v2.0.0

      -
      -

      Minor Changes

      +

      v2.0.0

      +
      +

      Minor Changes

      • Add new parameter for port offset configuration #124

      • Update Keycloak to version 22.0.5 #122

      -
      -

      Breaking Changes / Porting Guide

      +
      +

      Breaking Changes / Porting Guide

      • Add support for more http-related configs #115

      • Update minimum ansible-core version > 2.14 #119

      • @@ -969,39 +977,39 @@
      -

      v1.3.0

      -
      -

      Major Changes

      +

      v1.3.0

      +
      +

      Major Changes

      • Run service as keycloak_service_user #106

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • keycloak_quarkus: Update Keycloak to version 22.0.3 #112

      • keycloak_quarkus: fix admin console redirect when running locally #111

      • keycloak_quarkus: skip proxy config if keycloak_quarkus_proxy_mode is none #109

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • keycloak_quarkus: fix validation failure upon port configuration change #113

      -

      v1.2.8

      -
      -

      Minor Changes

      +

      v1.2.8

      +
      +

      Minor Changes

      • keycloak_quarkus: set openjdk 17 as default #103

      • keycloak_quarkus: update to version 22.0.1 #107

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Fix incorrect checks for keycloak_jgroups_subnet #98

      • Undefine keycloak_db_valid_conn_sql default #91

      • @@ -1010,9 +1018,9 @@
      -

      v1.2.7

      -
      -

      Minor Changes

      +

      v1.2.7

      +
      +

      Minor Changes

      • Allow to override jgroups subnet #93

      • keycloak-quarkus: update keycloakx to v21.1.1 #92

      • @@ -1020,26 +1028,26 @@
      -

      v1.2.6

      -
      -

      Minor Changes

      +

      v1.2.6

      +
      +

      Minor Changes

      • Add profile features enabling/disabling #87

      • Improve service restart behavior configuration #88

      • Update default xa_datasource_class value for mariadb jdbc configuration #89

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Handle WFLYCTL0117 when background validation millis is 0 #90

      -

      v1.2.5

      -
      -

      Minor Changes

      +

      v1.2.5

      +
      +

      Minor Changes

      • Add configuration for database connection pool validation #85

      • Allow to configure administration endpoint URL #86

      • @@ -1049,16 +1057,16 @@
      -

      v1.2.4

      -
      -

      Minor Changes

      +

      v1.2.4

      +
      +

      Minor Changes

      • Add sqlserver to keycloak role jdbc configurations #78

      • Add configurability for XA transactions #73

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Fix deprecation warning for ipaddr #77

      • Fix undefined facts when offline patching sso #71

      • @@ -1066,30 +1074,30 @@
      -

      v1.2.1

      -
      -

      Minor Changes

      +

      v1.2.1

      +
      +

      Minor Changes

      • Allow to setup keycloak HA cluster without remote cache store #68

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Pass attributes to realm clients #69

      -

      v1.2.0

      -
      -

      Major Changes

      +

      v1.2.0

      +
      +

      Major Changes

      • Provide config for multiple modcluster proxies #60

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • Allow to configure TCPPING for cluster discovery #62

      • Drop community.general from dependencies #61

      • @@ -1099,18 +1107,18 @@
      -

      v1.1.1

      -
      -

      Bugfixes

      +

      v1.1.1

      +
      +

      Bugfixes

      • keycloak-quarkus: fix cache-config-file path in keycloak.conf.j2 template #53

      -

      v1.1.0

      -
      -

      Minor Changes

      +

      v1.1.0

      +
      +

      Minor Changes

      • Update keycloak to 18.0.2 - sso to 7.6.1 #46

      • Variable keycloak_no_log controls ansible no_log parameter (for debugging purposes) #47

      • @@ -1118,38 +1126,38 @@
      • keycloak_quarkus: variable to enable development mode #45

      -
      -

      Breaking Changes / Porting Guide

      +
      +

      Breaking Changes / Porting Guide

      • Rename variables from infinispan_ prefix to keycloak_infinispan_ #42

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • keycloak_quarkus: fix /var/log/keycloak symlink to keycloak log directory #44

      -

      v1.0.7

      -
      -

      Breaking Changes / Porting Guide

      +

      v1.0.7

      +
      +

      Breaking Changes / Porting Guide

      • keycloak_quarkus: use absolute path for certificate files #39

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • keycloak_quarkus: use become for tasks that will otherwise fail #38

      -

      v1.0.6

      -
      -

      Bugfixes

      +

      v1.0.6

      +
      +

      Bugfixes

      • keycloak_quarkus: add selected java to PATH in systemd unit #34

      • keycloak_quarkus: set logfile path correctly under keycloak home #35

      • @@ -1157,81 +1165,81 @@
      -

      v1.0.5

      -
      -

      Minor Changes

      +

      v1.0.5

      +
      +

      Minor Changes

      • Update config options: keycloak and quarkus #32

      -

      v1.0.4

      -
      -

      Release Summary

      +

      v1.0.4

      +
      +

      Release Summary

      Internal release, documentation or test changes only.

      -

      v1.0.3

      -
      -

      Major Changes

      +

      v1.0.3

      +
      +

      Major Changes

      • New role for installing keycloak >= 17.0.0 (quarkus) #29

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • Add keycloak_config_override_template parameter for passing a custom xml config template #30

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Make sure systemd unit starts with selected java JVM #31

      -

      v1.0.2

      -
      -

      Minor Changes

      +

      v1.0.2

      +
      +

      Minor Changes

      • Make keycloak_admin_password a default with assert (was: role variable) #26

      • Simplify dependency install logic and reduce play execution time #19

      -
      -

      Bugfixes

      +
      +

      Bugfixes

      • Set keycloak_frontend_url default according to other defaults #25

      -

      v1.0.1

      -
      -

      Release Summary

      +

      v1.0.1

      +
      +

      Release Summary

      Minor enhancements, bug and documentation fixes.

      -
      -

      Major Changes

      +
      +

      Major Changes

      • Apply latest cumulative patch of RH-SSO automatically when new parameter keycloak_rhsso_apply_patches is true #18

      -
      -

      Minor Changes

      +
      +

      Minor Changes

      • Clustered installs now perform database initialization on first node to avoid locking issues #17

      -

      v1.0.0

      -
      -

      Release Summary

      +

      v1.0.0

      +
      +

      Release Summary

      This is the first stable release of the middleware_automation.keycloak collection.

      diff --git a/main/_sources/CHANGELOG.rst.txt b/main/_sources/CHANGELOG.rst.txt index d57d3fe..f741722 100644 --- a/main/_sources/CHANGELOG.rst.txt +++ b/main/_sources/CHANGELOG.rst.txt @@ -14,6 +14,11 @@ Major Changes - Fixing linting issues `#357 `_ +Minor Changes +------------- + +- AMW-571 keycloak_identity_provider hide_on_login_page not working `#356 `_ + v3.0.9 ====== diff --git a/main/_sources/plugins/keycloak_identity_provider.rst.txt b/main/_sources/plugins/keycloak_identity_provider.rst.txt index e1b710e..0fe82b5 100644 --- a/main/_sources/plugins/keycloak_identity_provider.rst.txt +++ b/main/_sources/plugins/keycloak_identity_provider.rst.txt @@ -355,27 +355,6 @@ Parameters
      -
      -
      -
      -

      hide_on_login_page

      - -

      aliases: hideOnLoginPage

      -

      - boolean -

      -
      -
      -

      If hidden, login with this provider is possible only if requested explicitly, for example using the kc_idp_hint parameter.

      -

      Choices:

      -
        -
      • false

      • -
      • true

      • -
      - -
      - -

      issuer

      @@ -388,7 +367,7 @@ Parameters

      The issuer identifier for the issuer of the response. If not provided, no validation is performed.

      - +

      jwksUrl

      @@ -401,7 +380,7 @@ Parameters

      URL where identity provider keys in JWK format are stored. See JWK specification for more details.

      - +

      logoutUrl

      @@ -414,7 +393,7 @@ Parameters

      End session endpoint to use to logout user from external IDP.

      - +

      nameIDPolicyFormat

      @@ -427,7 +406,7 @@ Parameters

      Specifies the URI reference corresponding to a name identifier format.

      - +

      principalType

      @@ -440,7 +419,7 @@ Parameters

      Way to identify and track external users from the assertion.

      - +

      singleLogoutServiceUrl

      @@ -453,7 +432,7 @@ Parameters

      The URL that must be used to send logout requests.

      - +

      singleSignOnServiceUrl

      @@ -466,7 +445,7 @@ Parameters

      The URL that must be used to send authentication requests (SAML AuthnRequest).

      - +
      @@ -481,7 +460,7 @@ Parameters

      Default sync mode for all mappers. The sync mode determines when user data is synced using the mappers.

      - +

      tokenUrl

      @@ -494,7 +473,7 @@ Parameters

      The Token URL.

      - +

      useJwksUrl

      @@ -513,7 +492,7 @@ Parameters
      - +

      userInfoUrl

      @@ -526,7 +505,7 @@ Parameters

      The User Info URL.

      - +

      validateSignature

      @@ -546,7 +525,7 @@ Parameters
      - +

      connection_timeout

      @@ -560,7 +539,7 @@ Parameters

      Default: 10

      - +
      @@ -575,7 +554,7 @@ Parameters

      Friendly name for identity provider.

      - +

      enabled

      @@ -594,7 +573,7 @@ Parameters
      - +
      @@ -609,6 +588,28 @@ Parameters

      Alias of authentication flow, which is triggered after first login with this identity provider.

      + +
      +
      +
      +
      +

      hide_on_login

      + +

      aliases: hideOnLogin, hide_on_login_page

      +

      + boolean +

      +
      +
      +

      If hidden, login with this provider is possible only if requested explicitly, for example using the kc_idp_hint parameter.

      +

      Choices:

      +
        +
      • false

      • +
      • true

      • +
      + +
      +
      diff --git a/main/plugins/keycloak_identity_provider.html b/main/plugins/keycloak_identity_provider.html index 7690834..c5712c2 100644 --- a/main/plugins/keycloak_identity_provider.html +++ b/main/plugins/keycloak_identity_provider.html @@ -454,27 +454,6 @@ To check whether it is installed, run -
      -
      -
      -

      hide_on_login_page

      - -

      aliases: hideOnLoginPage

      -

      - boolean -

      -
      -
      -

      If hidden, login with this provider is possible only if requested explicitly, for example using the kc_idp_hint parameter.

      -

      Choices:

      -
        -
      • false

      • -
      • true

      • -
      - -
      - -

      issuer

      @@ -487,7 +466,7 @@ To check whether it is installed, run +

      jwksUrl

      @@ -500,7 +479,7 @@ To check whether it is installed, run +

      logoutUrl

      @@ -513,7 +492,7 @@ To check whether it is installed, run +

      nameIDPolicyFormat

      @@ -526,7 +505,7 @@ To check whether it is installed, run +

      principalType

      @@ -539,7 +518,7 @@ To check whether it is installed, run +

      singleLogoutServiceUrl

      @@ -552,7 +531,7 @@ To check whether it is installed, run +

      singleSignOnServiceUrl

      @@ -565,7 +544,7 @@ To check whether it is installed, run +
      @@ -580,7 +559,7 @@ To check whether it is installed, run +

      tokenUrl

      @@ -593,7 +572,7 @@ To check whether it is installed, run +

      useJwksUrl

      @@ -612,7 +591,7 @@ To check whether it is installed, run +

      userInfoUrl

      @@ -625,7 +604,7 @@ To check whether it is installed, run +

      validateSignature

      @@ -645,7 +624,7 @@ To check whether it is installed, run +

      connection_timeout

      @@ -659,7 +638,7 @@ To check whether it is installed, run Default: 10

      - +
      @@ -674,7 +653,7 @@ To check whether it is installed, run +

      enabled

      @@ -693,7 +672,7 @@ To check whether it is installed, run +
      @@ -708,6 +687,28 @@ To check whether it is installed, run