Skip to content

Commit f1305e5

Browse files
committed
Updated quarkus and realm readme, declared proxy_mode as deprecated
Updated argument_specs and declared keycloak_quarkus_proxy_mode as deprecated
1 parent fa87c00 commit f1305e5

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

roles/keycloak_quarkus/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Role Defaults
6060
|`keycloak_quarkus_java_heap_opts`| Heap memory JVM setting | `-Xms1024m -Xmx2048m` |
6161
|`keycloak_quarkus_java_jvm_opts`| Other JVM settings | same as keycloak |
6262
|`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 }}` |
63-
|`keycloak_quarkus_additional_env_vars` | List of additional env variables of { key: str, value: str} to be put in sysconfig file | `[]` |
63+
|`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 | `[]` |
6464
|`keycloak_quarkus_frontend_url`| Deprecated, use `keycloak_quarkus_hostname` instead. | |
6565
|`keycloak_quarkus_admin_url`| Deprecated, use `keycloak_quarkus_hostname_admin` instead. | |
6666
|`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 | `` |
@@ -166,7 +166,7 @@ Role Defaults
166166
|`keycloak_quarkus_log_format`| Set a format specific to file log entries | `%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n` |
167167
|`keycloak_quarkus_log_target`| Set the destination of the keycloak log folder link | `/var/log/keycloak` |
168168
|`keycloak_quarkus_log_max_file_size`| Set the maximum log file size before a log rotation happens; A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. If no suffix is given, assume bytes. | `10M` |
169-
|`keycloak_quarkus_log_max_backup_index`| Set the maximum number of archived log files to keep" | `10` |
169+
|`keycloak_quarkus_log_max_backup_index`| Set the maximum number of archived log files to keep | `10` |
170170
|`keycloak_quarkus_log_file_suffix`| Set the log file handler rotation file suffix. When used, the file will be rotated based on its suffix; Note: If the suffix ends with `.zip` or `.gz`, the rotation file will also be compressed. | `.yyyy-MM-dd.zip` |
171171

172172

@@ -183,7 +183,7 @@ Role Defaults
183183
|`keycloak_quarkus_master_realm` | Name for rest authentication realm | `master` |
184184
|`keycloak_auth_client` | Authentication client for configuration REST calls | `admin-cli` |
185185
|`keycloak_quarkus_force_install` | Remove pre-existing versions of service | `False` |
186-
|`keycloak_quarkus_proxy_mode`| The proxy address forwarding mode if the server is behind a reverse proxy | `edge` |
186+
|`keycloak_quarkus_proxy_mode`| The proxy address forwarding mode if the server is behind a reverse proxy (deprecated) | `none` |
187187
|`keycloak_quarkus_start_dev`| Whether to start the service in development mode (start-dev) | `False` |
188188
|`keycloak_quarkus_transaction_xa_enabled`| Whether to use XA transactions | `True` |
189189
|`keycloak_quarkus_spi_sticky_session_encoder_infinispan_should_attach_route`| If the route should be attached to cookies to reflect the node that owns a particular session. If false, route is not attached to cookies and we rely on the session affinity capabilities from reverse proxy | `True` |

roles/keycloak_quarkus/defaults/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ keycloak_quarkus_hostname_backchannel_dynamic: false
105105
keycloak_quarkus_proxy_headers: ""
106106

107107
# deprecated: proxy address forwarding mode if the server is behind a reverse proxy. [none, edge, reencrypt, passthrough]
108-
keycloak_quarkus_proxy_mode: edge
108+
keycloak_quarkus_proxy_mode: none
109109

110110
# disable xa transactions
111111
keycloak_quarkus_transaction_xa_enabled: true

roles/keycloak_quarkus/meta/argument_specs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,9 +344,9 @@ argument_specs:
344344
Set the log file handler rotation file suffix. When used, the file will be rotated based on its suffix. Note: If the suffix ends
345345
with .zip or .gz, the rotation file will also be compressed.
346346
keycloak_quarkus_proxy_mode:
347-
default: 'edge'
347+
default: 'none'
348348
type: "str"
349-
description: "The proxy address forwarding mode if the server is behind a reverse proxy. Set to 'none' if not using a proxy"
349+
description: "The proxy address forwarding mode if the server is behind a reverse proxy. Set to 'none' as it is deprecated according to Keycloak documentation"
350350
keycloak_quarkus_proxy_headers:
351351
default: ""
352352
type: "str"

roles/keycloak_realm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The following variables are available for creating clients:
4444
|`keycloak_client_users` | List of user/role mappings for a client | `[]` |
4545

4646

47-
The following variable are available for creating user federation:
47+
The following variables are available for creating user federation:
4848

4949
| Variable | Description | Default |
5050
|:---------|:------------|:---------|

0 commit comments

Comments
 (0)