Update docs for main

Signed-off-by: ansible-middleware-core <ansible-middleware-core@redhat.com>
This commit is contained in:
ansible-middleware-core
2026-10-05 23:23:47 +00:00
parent f51b854ca3
commit 83d255885f
5 changed files with 448 additions and 446 deletions
+441 -440
View File
File diff suppressed because it is too large Load Diff
+1
View File
@@ -18,6 +18,7 @@ Minor Changes
Bugfixes
--------
- Fix health check URL to use localhost with protocol and port `#429 <https://github.com/ansible-middleware/keycloak/pull/429>`_
- 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
+2 -2
View File
@@ -65,8 +65,8 @@ Role Defaults
|`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. | |
|`keycloak_quarkus_health_check_url`| Full URL (including scheme, host, path, fragment etc.) used for health check endpoint; keycloak_quarkus_hostname will NOT be prepended; helpful when health checks should happen against http port, but keycloak_quarkus_hostname uses https scheme per default | `{{ keycloak_quarkus_hostname ~ keycloak_quarkus_http_relative_path.rstrip('/') ~ '/' ~ keycloak_quarkus_health_check_url_path }}` |
|`keycloak_quarkus_health_check_url_path`| Path to the health check endpoint; keycloak_quarkus_hostname will be prepended automatically; Note that keycloak_quarkus_health_check_url takes precedence over this property | `realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration` |
|`keycloak_quarkus_health_check_url`| Full URL for the health check endpoint, targets localhost | Composed from `keycloak_quarkus_http_enabled`, `keycloak_quarkus_http_port`/`keycloak_quarkus_https_port`, and `keycloak_quarkus_http_relative_path` |
|`keycloak_quarkus_health_check_url_path`| Path appended to the health check URL | `realms/{{ keycloak_quarkus_master_realm }}/.well-known/openid-configuration` |
|`keycloak_quarkus_proxy_headers`| Parse reverse proxy headers (`forwarded` or `xforwarded`) | `""` |
|`keycloak_quarkus_config_key_store_file`| Path to the configuration key store; only used if `keycloak_quarkus_config_key_store_password` is not empty | `{{ keycloak.home }}/conf/conf_store.p12` if `keycloak_quarkus_config_key_store_password != ''`, else `''` |
|`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 | `""` |
+3 -3
View File
@@ -279,11 +279,11 @@
<td class="text-left"><p></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_health_check_url</span></code></p></td>
<td class="text-left"><p>Full URL (including scheme, host, path, fragment etc.) used for health check endpoint; keycloak_quarkus_hostname will NOT be prepended; helpful when health checks should happen against http port, but keycloak_quarkus_hostname uses https scheme per default</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">{{</span> <span class="pre">keycloak_quarkus_hostname</span> <span class="pre">~</span> <span class="pre">keycloak_quarkus_http_relative_path.rstrip('/')</span> <span class="pre">~</span> <span class="pre">'/'</span> <span class="pre">~</span> <span class="pre">keycloak_quarkus_health_check_url_path</span> <span class="pre">}}</span></code></p></td>
<td class="text-left"><p>Full URL for the health check endpoint, targets localhost</p></td>
<td class="text-left"><p>Composed from <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_enabled</span></code>, <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_port</span></code>/<code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_https_port</span></code>, and <code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_http_relative_path</span></code></p></td>
</tr>
<tr class="row-even"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_health_check_url_path</span></code></p></td>
<td class="text-left"><p>Path to the health check endpoint; keycloak_quarkus_hostname will be prepended automatically; Note that keycloak_quarkus_health_check_url takes precedence over this property</p></td>
<td class="text-left"><p>Path appended to the health check URL</p></td>
<td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">realms/{{</span> <span class="pre">keycloak_quarkus_master_realm</span> <span class="pre">}}/.well-known/openid-configuration</span></code></p></td>
</tr>
<tr class="row-odd"><td class="text-left"><p><code class="docutils literal notranslate"><span class="pre">keycloak_quarkus_proxy_headers</span></code></p></td>
+1 -1
View File
File diff suppressed because one or more lines are too long