middleware_automation.keycloak Release Notes
+middleware_automation.keycloak Release Notes
This changelog describes changes after version 0.2.6.
v2.2.0-devel
+v2.2.0-devel
Major Changes
+Major Changes
Add support for configuration key store #189
Minor Changes
+Minor Changes
v2.1.2
+v2.1.2
Release Summary
+Release Summary
Internal release, documentation or test changes only.
v2.1.1
-Minor Changes
+v2.1.1
+Minor Changes
Bugfixes
+Bugfixes
v2.1.0
-Major Changes
+v2.1.0
+Major Changes
Implement infinispan TCPPING discovery protocol #159
Minor Changes
+Minor Changes
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
Bugfixes
+Bugfixes
v2.0.1
-Minor Changes
+v2.0.1
+Minor Changes
Bugfixes
+Bugfixes
keycloak_quarkus: template requires lowercase boolean values #138
v2.0.0
-Minor Changes
+v2.0.0
+Minor Changes
Breaking Changes / Porting Guide
+Breaking Changes / Porting Guide
v1.3.0
-Major Changes
+v1.3.0
+Major Changes
Run service as
keycloak_service_user#106
Minor Changes
+Minor Changes
Bugfixes
+Bugfixes
keycloak_quarkus: fix validation failure upon port configuration change #113
v1.2.8
-Minor Changes
+v1.2.8
+Minor Changes
Bugfixes
+Bugfixes
v1.2.7
-Minor Changes
+v1.2.7
+Minor Changes
v1.2.6
-Minor Changes
+v1.2.6
+Minor Changes
Bugfixes
+Bugfixes
Handle WFLYCTL0117 when background validation millis is 0 #90
v1.2.5
-Minor Changes
+v1.2.5
+Minor Changes
v1.2.4
-Minor Changes
+v1.2.4
+Minor Changes
Bugfixes
+Bugfixes
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
v1.1.1
-Bugfixes
+v1.1.1
+Bugfixes
keycloak-quarkus: fix
cache-config-filepath in keycloak.conf.j2 template #53
v1.1.0
-Minor Changes
+v1.1.0
+Minor Changes
Breaking Changes / Porting Guide
+Breaking Changes / Porting Guide
Rename variables from
infinispan_prefix tokeycloak_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
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_templateparameter 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
Bugfixes
+Bugfixes
Set
keycloak_frontend_urldefault 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_patchesistrue#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.
- Installation options
- Service configuration +
- High-availability
- Hostname configuration
- Database configuration
- Remote caches configuration -
- Install options
- Miscellaneous configuration
- Vault SPI
keycloak.org package version
24.0.3
keycloak_quarkus_offline_install
Perform an offline install
False
keycloak_quarkus_version
keycloak.org package version
23.0.7
keycloak_quarkus_dest
Installation root path
/opt/keycloak
keycloak_quarkus_download_url
Download URL for keycloak
https://github.com/keycloak/keycloak/releases/download/{{ keycloak_quarkus_version }}/{{ keycloak_quarkus_archive }}
keycloak_quarkus_ha_enabled
Enable auto configuration for database backend, clustering and remote caches on infinispan
False
keycloak_quarkus_ha_discovery
Discovery protocol for HA cluster members
TCPPING
keycloak_quarkus_db_enabled
Enable auto configuration for database backend
True if keycloak_quarkus_ha_enabled is True, else False
keycloak_quarkus_admin_user
keycloak_quarkus_admin_user
Administration console user account
admin
keycloak_quarkus_bind_address
keycloak_quarkus_bind_address
Address for binding service ports
0.0.0.0
keycloak_quarkus_host
keycloak_quarkus_host
Hostname for the Keycloak server
localhost
keycloak_quarkus_port
keycloak_quarkus_port
The port used by the proxy when exposing the hostname
-1
keycloak_quarkus_path
keycloak_quarkus_path
This should be set if proxy uses a different context-path for Keycloak
keycloak_quarkus_http_port
keycloak_quarkus_http_port
HTTP listening port
8080
keycloak_quarkus_https_port
keycloak_quarkus_https_port
TLS HTTP listening port
8443
keycloak_quarkus_ajp_port
keycloak_quarkus_ajp_port
AJP port
8009
keycloak_quarkus_jgroups_port
jgroups cluster tcp port
7800
keycloak_quarkus_service_user
Posix account username
keycloak
systemd RestartSec
10s
keycloak_quarkus_service_pidfile
Pid file path for service
/run/keycloak.pid
keycloak_quarkus_jvm_package
keycloak_quarkus_jvm_package
RHEL java package runtime
java-17-openjdk-headless
keycloak_quarkus_java_home
keycloak_quarkus_java_home
JAVA_HOME of installed JRE, leave empty for using specified keycloak_quarkus_jvm_package RPM path
None
keycloak_quarkus_java_heap_opts
keycloak_quarkus_java_heap_opts
Heap memory JVM setting
-Xms1024m -Xmx2048m
keycloak_quarkus_java_jvm_opts
keycloak_quarkus_java_jvm_opts
Other JVM settings
same as keycloak
keycloak_quarkus_java_opts
keycloak_quarkus_java_opts
JVM arguments; if overriden, it takes precedence over keycloak_quarkus_java_*
{{ keycloak_quarkus_java_heap_opts + ' ' + keycloak_quarkus_java_jvm_opts }}
keycloak_quarkus_frontend_url
keycloak_quarkus_frontend_url
Set the base URL for frontend URLs, including scheme, host, port and path
keycloak_quarkus_admin_url
keycloak_quarkus_admin_url
Set the base URL for accessing the administration console, including scheme, host, port and path
keycloak_quarkus_http_relative_path
keycloak_quarkus_http_relative_path
Set the path relative to / for serving resources. The path must start with a /
/
keycloak_quarkus_http_enabled
keycloak_quarkus_http_enabled
Enable listener on HTTP port
True
keycloak_quarkus_https_key_file_enabled
keycloak_quarkus_https_key_file_enabled
Enable listener on HTTPS port
False
keycloak_quarkus_key_file
keycloak_quarkus_key_file
The file path to a private key in PEM format
{{ keycloak.home }}/conf/server.key.pem
keycloak_quarkus_cert_file
keycloak_quarkus_cert_file
The file path to a server certificate or certificate chain in PEM format
{{ keycloak.home }}/conf/server.crt.pem
keycloak_quarkus_https_key_store_enabled
keycloak_quarkus_https_key_store_enabled
Enable configuration of HTTPS via a key store
False
keycloak_quarkus_key_store_file
keycloak_quarkus_key_store_file
Deprecated, use keycloak_quarkus_https_key_store_file instead.
keycloak_quarkus_key_store_password
keycloak_quarkus_key_store_password
Deprecated, use keycloak_quarkus_https_key_store_password instead.
keycloak_quarkus_https_key_store_file
keycloak_quarkus_https_key_store_file
The file path to the key store
{{ keycloak.home }}/conf/key_store.p12
keycloak_quarkus_https_key_store_password
keycloak_quarkus_https_key_store_password
Password for the key store
""
keycloak_quarkus_https_trust_store_enabled
keycloak_quarkus_https_trust_store_enabled
Enable configuration of the https trust store
False
keycloak_quarkus_https_trust_store_file
keycloak_quarkus_https_trust_store_file
The file path to the trust store
{{ keycloak.home }}/conf/trust_store.p12
keycloak_quarkus_https_trust_store_password
keycloak_quarkus_https_trust_store_password
Password for the trust store
""
keycloak_quarkus_proxy_headers
keycloak_quarkus_proxy_headers
Parse reverse proxy headers (forwarded or xforwarded)
""
keycloak_quarkus_config_key_store_file
keycloak_quarkus_config_key_store_file
Path to the configuration key store; only used if keycloak_quarkus_keystore_password is not empty
{{ keycloak.home }}/conf/conf_store.p12 if keycloak_quarkus_keystore_password!=’’, else ‘’
{{ keycloak.home }}/conf/conf_store.p12 if keycloak_quarkus_keystore_password != '', else ''
keycloak_quarkus_config_key_store_password
Password of the configuration key store; if non-empty, keycloak_quarkus_db_pass will be saved to the key store at keycloak_quarkus_config_key_store_file (instead of being written to the configuration file in clear text
keycloak_quarkus_config_key_store_password
Password of the configuration keystore; if non-empty, keycloak_quarkus_db_pass will be saved to the keystore at keycloak_quarkus_config_key_store_file instead of being written to the configuration file in clear text
""
keycloak_quarkus_configure_firewalld
Ensure firewalld is running and configure keycloak ports
False
keycloak_quarkus_configure_iptables
Ensure iptables is configured for keycloak ports
False
High-availability
+Variable |
+Description |
+Default |
+
|---|---|---|
|
+Enable auto configuration for database backend, clustering and remote caches on infinispan |
+
|
+
|
+Discovery protocol for HA cluster members |
+
|
+
|
+Enable auto configuration for database backend |
+
|
+
|
+jgroups cluster tcp port |
+
|
+
|
+Whether systemd unit should wait for keycloak port before returning |
+
|
+
|
+Whether systemd unit should wait for service to be up in logs |
+
|
+
|
+How long to wait for service to be alive (seconds) |
+
|
+
|
+Activation delay for service systemd unit (seconds) |
+
|
+
Install options
-Variable |
-Description |
-Default |
-
|---|---|---|
|
-Perform an offline install |
-
|
-
|
-keycloak.org package version |
-
|
-
|
-Installation root path |
-
|
-
|
-Download URL for keycloak |
-
|
-
|
-Ensure firewalld is running and configure keycloak ports |
-
|
-