mirror of
https://github.com/ansible-middleware/keycloak.git
synced 2026-11-21 14:48:50 +00:00
Merge pull request #425 from hcherukuri/main
Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND
This commit is contained in:
@@ -17,6 +17,27 @@
|
||||
- ansible_facts.services["keycloak.service"]["status"] == "enabled"
|
||||
fail_msg: "Service not running"
|
||||
|
||||
- name: Read Keycloak sysconfig
|
||||
ansible.builtin.slurp:
|
||||
src: /etc/sysconfig/keycloak
|
||||
register: keycloak_sysconfig
|
||||
become: "{{ molecule_prepare_require_privilege_escalation | default(true) }}"
|
||||
|
||||
- name: Decode Keycloak sysconfig
|
||||
ansible.builtin.set_fact:
|
||||
keycloak_sysconfig_text: "{{ keycloak_sysconfig.content | ansible.builtin.b64decode(encoding='utf-8') }}"
|
||||
|
||||
- name: Assert sysconfig defers JAVA_OPTS to Keycloak kc.sh defaults
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- keycloak_sysconfig_text is search('JAVA_OPTS_KC_HEAP=')
|
||||
- keycloak_sysconfig_text is search('JAVA_OPTS_APPEND=')
|
||||
- keycloak_sysconfig_text is not search('(?m)^JAVA_OPTS=')
|
||||
fail_msg: >-
|
||||
Expected JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND (not JAVA_OPTS) in sysconfig.
|
||||
Got:
|
||||
{{ keycloak_sysconfig_text }}
|
||||
|
||||
- name: Set internal envvar
|
||||
ansible.builtin.set_fact:
|
||||
hera_home: "{{ lookup('env', 'HERA_HOME') }}"
|
||||
|
||||
@@ -57,9 +57,11 @@ Role Defaults
|
||||
|`keycloak_quarkus_service_restartsec`| systemd RestartSec | `10s` |
|
||||
|`keycloak_quarkus_jvm_package`| RHEL java package runtime | `java-21-openjdk-headless` |
|
||||
|`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`| Heap memory JVM setting | `-Xms1024m -Xmx2048m` |
|
||||
|`keycloak_quarkus_java_jvm_opts`| Other JVM settings | same as keycloak |
|
||||
|`keycloak_quarkus_java_opts`| JVM arguments; if overridden, it takes precedence over `keycloak_quarkus_java_*` | `{{ keycloak_quarkus_java_heap_opts + ' ' + keycloak_quarkus_java_jvm_opts }}` |
|
||||
|`keycloak_quarkus_java_heap_opts`| Heap memory JVM setting (`JAVA_OPTS_KC_HEAP` when using Keycloak defaults) | `-Xms1024m -Xmx2048m` |
|
||||
|`keycloak_quarkus_java_jvm_opts`| Optional extra JVM flags (`JAVA_OPTS_APPEND` with Keycloak defaults) | `""` |
|
||||
|`keycloak_quarkus_java_opts_use_keycloak_defaults`| Let `kc.sh` apply upstream `JAVA_OPTS` (recommended) | `true` |
|
||||
|`keycloak_quarkus_java_append_opts`| JGroups and extra JVM flags appended after Keycloak defaults | JGroups bind/external settings |
|
||||
|`keycloak_quarkus_java_opts`| Full `JAVA_OPTS` when `keycloak_quarkus_java_opts_use_keycloak_defaults` is `false` | combined heap, JGroups, and `java_jvm_opts` |
|
||||
|`keycloak_quarkus_additional_env_vars` | List of additional env variables of { key: str, value: str} to be put in sysconfig file, see https://www.keycloak.org/server/all-config | `[]` |
|
||||
|`keycloak_quarkus_frontend_url`| Deprecated, use `keycloak_quarkus_hostname` instead. | |
|
||||
|`keycloak_quarkus_admin_url`| Deprecated, use `keycloak_quarkus_hostname_admin` instead. | |
|
||||
|
||||
@@ -47,15 +47,17 @@ keycloak_quarkus_jgroups_bind_address: "{{ ansible_facts['default_ipv4']['addres
|
||||
keycloak_quarkus_jgroups_external_addr: "{{ keycloak_quarkus_jgroups_bind_address }}"
|
||||
keycloak_quarkus_jgroups_external_port: "{{ keycloak_quarkus_jgroups_port }}"
|
||||
keycloak_quarkus_java_heap_opts: "-Xms1024m -Xmx2048m"
|
||||
keycloak_quarkus_java_jvm_opts: >
|
||||
-XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=256m -Dfile.encoding=UTF-8 -Dsun.stdout.encoding=UTF-8
|
||||
-Dsun.err.encoding=UTF-8 -Dstdout.encoding=UTF-8 -Dstderr.encoding=UTF-8 -XX:+ExitOnOutOfMemoryError
|
||||
-Djava.security.egd=file:/dev/urandom -XX:+UseParallelGC -XX:GCTimeRatio=4
|
||||
-XX:AdaptiveSizePolicyWeight=90 -XX:FlightRecorderOptions=stackdepth=512
|
||||
# Optional extra JVM flags appended after Keycloak's kc.sh defaults (see JAVA_OPTS_APPEND).
|
||||
keycloak_quarkus_java_jvm_opts: ""
|
||||
keycloak_quarkus_jgroups_opts: >
|
||||
-Djgroups.bind.address={{ keycloak_quarkus_jgroups_bind_address }}
|
||||
-Djgroups.external_port={{ keycloak_quarkus_jgroups_external_port }}
|
||||
-Djgroups.external_addr={{ keycloak_quarkus_jgroups_external_addr }}
|
||||
# When true, sysconfig sets JAVA_OPTS_KC_HEAP / JAVA_OPTS_APPEND so kc.sh applies upstream JAVA_OPTS
|
||||
# (including security-related defaults). Set false to set JAVA_OPTS explicitly via keycloak_quarkus_java_opts.
|
||||
keycloak_quarkus_java_opts_use_keycloak_defaults: true
|
||||
keycloak_quarkus_java_append_opts: >-
|
||||
{{ (keycloak_quarkus_jgroups_opts ~ ' ' ~ keycloak_quarkus_java_jvm_opts) | regex_replace('\s+', ' ') | trim }}
|
||||
keycloak_quarkus_java_opts: "{{ ' '.join((keycloak_quarkus_jgroups_opts, keycloak_quarkus_java_heap_opts, keycloak_quarkus_java_jvm_opts)) }}"
|
||||
keycloak_quarkus_additional_env_vars: []
|
||||
|
||||
|
||||
@@ -226,15 +226,27 @@ argument_specs:
|
||||
description: "Heap memory JVM setting"
|
||||
type: "str"
|
||||
keycloak_quarkus_java_jvm_opts:
|
||||
default: >
|
||||
-XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=256m -Dfile.encoding=UTF-8 -Dsun.stdout.encoding=UTF-8 -Dsun.err.encoding=UTF-8
|
||||
-Dstdout.encoding=UTF-8 -Dstderr.encoding=UTF-8 -XX:+ExitOnOutOfMemoryError -Djava.security.egd=file:/dev/urandom -XX:+UseParallelGC
|
||||
-XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -XX:FlightRecorderOptions=stackdepth=512
|
||||
description: "Other JVM settings"
|
||||
default: ""
|
||||
description: >-
|
||||
Optional JVM flags appended via JAVA_OPTS_APPEND when
|
||||
keycloak_quarkus_java_opts_use_keycloak_defaults is true
|
||||
type: "str"
|
||||
keycloak_quarkus_java_opts_use_keycloak_defaults:
|
||||
default: true
|
||||
description: >-
|
||||
When true, sysconfig sets JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND so
|
||||
Keycloak kc.sh applies upstream JAVA_OPTS defaults. When false, sets
|
||||
JAVA_OPTS from keycloak_quarkus_java_opts instead.
|
||||
type: "bool"
|
||||
keycloak_quarkus_java_append_opts:
|
||||
default: >-
|
||||
{{ (keycloak_quarkus_jgroups_opts ~ ' ' ~ keycloak_quarkus_java_jvm_opts) | regex_replace('\s+', ' ') | trim }}
|
||||
description: "JVM flags appended after Keycloak defaults (JGroups and java_jvm_opts)"
|
||||
type: "str"
|
||||
keycloak_quarkus_java_opts:
|
||||
default: "{{ ' '.join((keycloak_quarkus_jgroups_opts, keycloak_quarkus_java_heap_opts, keycloak_quarkus_java_jvm_opts)) }}"
|
||||
description: "JVM arguments, by default heap_opts + jvm_opts, if overriden it takes precedence over them"
|
||||
description: >-
|
||||
Full JAVA_OPTS string used when keycloak_quarkus_java_opts_use_keycloak_defaults is false
|
||||
type: "str"
|
||||
keycloak_quarkus_additional_env_vars:
|
||||
default: "[]"
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
{% if keycloak_quarkus_java_opts_use_keycloak_defaults | default(true) | bool %}
|
||||
JAVA_OPTS_KC_HEAP="{{ keycloak_quarkus_java_heap_opts }}"
|
||||
{% if keycloak_quarkus_java_append_opts | trim | length > 0 %}
|
||||
JAVA_OPTS_APPEND="{{ keycloak_quarkus_java_append_opts }}"
|
||||
{% endif %}
|
||||
{% else %}
|
||||
JAVA_OPTS="{{ keycloak_quarkus_java_opts }}"
|
||||
{% endif %}
|
||||
@@ -7,7 +7,7 @@ KC_BOOTSTRAP_ADMIN_PASSWORD='{{ keycloak_quarkus_bootstrap_admin_password }}'
|
||||
{% endif %}
|
||||
PATH="{{ keycloak_quarkus_java_home | default(keycloak_sys_pkg_java_home, true) }}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
||||
JAVA_HOME="{{ keycloak_quarkus_java_home | default(keycloak_sys_pkg_java_home, true) }}"
|
||||
JAVA_OPTS="{{ keycloak_quarkus_java_opts }}"
|
||||
{% include 'java-sysconfig.j2' %}
|
||||
|
||||
# Custom ENV variables
|
||||
{% for env in keycloak_quarkus_additional_env_vars %}
|
||||
|
||||
@@ -7,7 +7,7 @@ KC_BOOTSTRAP_ADMIN_PASSWORD='{{ keycloak_quarkus_bootstrap_admin_password }}'
|
||||
{% endif %}
|
||||
PATH="{{ keycloak_quarkus_java_home | default(keycloak_sys_pkg_java_home, true) }}/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
|
||||
JAVA_HOME="{{ keycloak_quarkus_java_home | default(keycloak_sys_pkg_java_home, true) }}"
|
||||
JAVA_OPTS="{{ keycloak_quarkus_java_opts }}"
|
||||
{% include 'java-sysconfig.j2' %}
|
||||
|
||||
# Custom ENV variables
|
||||
{% for env in keycloak_quarkus_additional_env_vars %}
|
||||
|
||||
Reference in New Issue
Block a user