Update docs for main

Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core
2026-09-21 12:18:04 +00:00
parent a0c0bf5433
commit 1c16fffb90
5 changed files with 474 additions and 446 deletions
+450 -437
View File
File diff suppressed because it is too large Load Diff
+5
View File
@@ -9,6 +9,11 @@ This changelog describes changes after version 0.2.6.
v3.1.2-devel
============
Bugfixes
--------
- Issue#421 Remove default setting of JAVA_OPTS and restrict to JAVA_OPTS_KC_HEAP and JAVA_OPTS_APPEND `#425 <https://github.com/ansible-middleware/keycloak/pull/425>`_
v3.1.1
======
+5 -3
View File
@@ -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. | |
+13 -5
View File
@@ -247,16 +247,24 @@
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">None</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_heap_opts</span></code></p></td>
<td class="text-left"><p>Heap memory JVM setting</p></td>
<td class="text-left"><p>Heap memory JVM setting (<code class="docutils literal notranslate"><span class="pre">JAVA_OPTS_KC_HEAP</span></code> when using Keycloak defaults)</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">-Xms1024m</span> <span class="pre">-Xmx2048m</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_jvm_opts</span></code></p></td>
<td class="text-left"><p>Other JVM settings</p></td>
<td class="text-left"><p>same as keycloak</p></td>
<td class="text-left"><p>Optional extra JVM flags (<code class="docutils literal notranslate"><span class="pre">JAVA_OPTS_APPEND</span></code> with Keycloak defaults)</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_opts_use_keycloak_defaults</span></code></p></td>
<td class="text-left"><p>Let <code class="docutils literal notranslate"><span class="pre">kc.sh</span></code> apply upstream <code class="docutils literal notranslate"><span class="pre">JAVA_OPTS</span></code> (recommended)</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_append_opts</span></code></p></td>
<td class="text-left"><p>JGroups and extra JVM flags appended after Keycloak defaults</p></td>
<td class="text-left"><p>JGroups bind/external settings</p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_opts</span></code></p></td>
<td class="text-left"><p>JVM arguments; if overridden, it takes precedence over <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_*</span></code></p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak_quarkus_java_heap_opts</span> <span class="pre">+</span> <span class="pre">'</span> <span class="pre">'</span> <span class="pre">+</span> <span class="pre">keycloak_quarkus_java_jvm_opts</span> <span class="pre">}}</span></code></p></td>
<td class="text-left"><p>Full <code class="docutils literal notranslate"><span class="pre">JAVA_OPTS</span></code> when <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_java_opts_use_keycloak_defaults</span></code> is <code class="docutils literal notranslate"><span class="pre">false</span></code></p></td>
<td class="text-left"><p>combined heap, JGroups, and <code class="docutils literal notranslate"><span class="pre">java_jvm_opts</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_additional_env_vars</span></code></p></td>
<td class="text-left"><p>List of additional env variables of { key: str, value: str} to be put in sysconfig file, see https://www.keycloak.org/server/all-config</p></td>
+1 -1
View File
File diff suppressed because one or more lines are too long