From aaae00ad3adb000c2f39290420088ba70715d045 Mon Sep 17 00:00:00 2001 From: Guido Grazioli Date: Mon, 20 Dec 2021 15:54:24 +0100 Subject: [PATCH] Update documentation --- roles/keycloak/README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/roles/keycloak/README.md b/roles/keycloak/README.md index ca28b3c..43727c2 100644 --- a/roles/keycloak/README.md +++ b/roles/keycloak/README.md @@ -10,31 +10,55 @@ Role Defaults | Variable | Description | Default | |:---------|:------------|:---------| |`keycloak_ha_enabled`| enable auto configuration for database backend, clustering and remote caches on infinispan | `False` | +|`keycloak_db_enabled`| enable auto configuration for database backend | `True` if keycloak_ha_enabled is True, else `False` | |`keycloak_admin_user`| Administration console user account | `admin` | - +|`keycloak_bind_address`| address for binding service ports | `0.0.0.0` +|`keycloak_host`| hostname | `localhost` +|`keycloak_http_port`| HTTP port | `8080` +|`keycloak_https_port`| TLS HTTP port | `8443` +|`keycloak_management_http_port`| management port | `9990` +|`keycloak_management_https_port`| TLS management port | `9993` +|`keycloak_java_opts`| | `-Xms1024m -Xmx20480m -XX:MaxPermSize=768m` Role Variables -------------- -The following are a set of required variables for the role: +The following are a set of _required_ variables for the role: | Variable | Description | |:---------|:------------| |`keycloak_admin_password`| Password for the administration console user account | -The following variables are required when keycloak_ha_enabled is True: + +The following variables are _required_ only when keycloak_ha_enabled is True: | Variable | Description | Default | |:---------|:------------|:---------| |`keycloak_modcluster_url` | URL for the modcluster reverse proxy | `localhost` | -|`postgres_jdbc_url` | URL for the postgres backend database | `jdbc:postgresql://localhost:5432/keycloak` | -|`postgres_db_user` | username for connecting to postgres | `keycloak-user` | -|`postgres_db_pass` | password for connecting to postgres | `keycloak-pass` | +|`keycloak_jdbc_engine` | backend database flavour when db is enabled: [ postgres, mariadb ] | `postgres` | |`infinispan_url` | URL for the infinispan remote-cache server | `localhost:11122` | |`infinispan_user` | username for connecting to infinispan | `supervisor` | |`infinispan_pass` | password for connecting to infinispan | `supervisor` | +The following variables are _required_ only when keycloak_db_enabled is True and keycloak_jdbc_engine is postgres: + +| Variable | Description | Default | +|:---------|:------------|:---------| +|`postgres_jdbc_url` | URL for the postgres backend database | `jdbc:postgresql://localhost:5432/keycloak` | +|`postgres_db_user` | username for connecting to postgres | `keycloak-user` | +|`postgres_db_pass` | password for connecting to postgres | `keycloak-pass` | + + +The following variables are _required_ only when keycloak_db_enabled is True and keycloak_jdbc_engine is mariadb: + +| Variable | Description | Default | +|:---------|:------------|:---------| +|`mariadb_jdbc_url` | URL for the mariadb backend database | `jdbc:mariadb://localhost:3306/keycloak` | +|`mariadb_db_user` | username for connecting to mariadb | `keycloak-user` | +|`mariadb_db_pass` | password for connecting to mariadb | `keycloak-pass` | + + Dependencies ------------