From 042089d1000d15b820b881eb141a658fcdd1d49e Mon Sep 17 00:00:00 2001 From: Guido Grazioli Date: Tue, 15 Feb 2022 10:14:44 +0100 Subject: [PATCH] READMEs updated by helper scripts --- galaxy.yml | 4 ++-- roles/keycloak/README.md | 23 +++++++++++++++++++++++ roles/keycloak/tasks/install.yml | 2 +- roles/keycloak_realm/README.md | 19 ++++++++++++------- 4 files changed, 38 insertions(+), 10 deletions(-) diff --git a/galaxy.yml b/galaxy.yml index 8f3f444..9e8f58f 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: middleware_automation name: keycloak -version: "0.2.4" +version: "0.2.5" readme: README.md authors: - Romain Pelisse @@ -16,7 +16,7 @@ tags: - sso dependencies: "middleware_automation.redhat_csp_download": ">=1.2.1" - "middleware_automation.wildfly": ">=0.0.4" + "middleware_automation.wildfly": ">=0.0.6" repository: https://github.com/ansible-middleware/keycloak documentation: https://github.com/ansible-middleware/keycloak homepage: https://github.com/ansible-middleware/keycloak diff --git a/roles/keycloak/README.md b/roles/keycloak/README.md index 3dffb47..60c183a 100644 --- a/roles/keycloak/README.md +++ b/roles/keycloak/README.md @@ -69,6 +69,29 @@ Role Defaults |`keycloak_version`| keycloak.org package version | `15.0.2` | |`keycloak_rhsso_version`| RHSSO version | `7.5.0` | |`keycloak_dest`| Installation root path | `/opt/keycloak` | +|`keycloak_download_url` | Download URL for keycloak | `https://github.com/keycloak/keycloak/releases/download/{{ keycloak_version }}/{{ keycloak_archive }}` | +|`keycloak_rhn_url` | Base download URI for customer portal | `https://access.redhat.com/jbossnetwork/restricted/softwareDownload.html?softwareId=` | + + +* Miscellaneous configuration + +| Variable | Description | Default | +|:---------|:------------|:--------| +|`keycloak_archive` | keycloak install archive filename | `keycloak-{{ keycloak_version }}.zip` | +|`keycloak_download_url_9x` | Download URL for keycloak (deprecated) | `https://downloads.jboss.org/keycloak/{{ keycloak_version }}/{{ keycloak_archive }}` | +|`keycloak_installdir` | Installation path | `{{ keycloak_dest }}/keycloak-{{ keycloak_version }}` | +|`keycloak_rhsso_archive` | Red Hat SSO install archive filename | `rh-sso-{{ keycloak_rhsso_version }}-server-dist.zip` | +|`keycloak_rhsso_installdir`| Installation path for Red Hat SSO | `{{ keycloak_dest }}/rh-sso-{{ keycloak_rhsso_version | regex_replace('^([0-9])\.([0-9]*).*', '\1.\2') }}` | +|`keycloak_rhsso_download_url`| Full download URI for Red Hat SSO | `{{ keycloak_rhn_url }}{{ rhsso_rhn_id }}` | +|`keycloak_jboss_home` | Installation work directory | `{{ keycloak_rhsso_installdir if keycloak_rhsso_enable else keycloak_installdir }}` | +|`keycloak_config_dir` | Path for configuration | `{{ keycloak_jboss_home }}/standalone/configuration` | +|`keycloak_config_path_to_standalone_xml` | Custom path for configuration | `{{ keycloak_jboss_home }}/standalone/configuration/{{ keycloak_config_standalone_xml }}` | +|`keycloak_auth_realm` | Name for rest authentication realm | `master` | +|`keycloak_auth_client` | Authentication client for configuration REST calls | `admin-cli` | +|`keycloak_force_install` | Remove pre-existing versions of service | `False` | +|`keycloak_url` | URL for configuration rest calls | `http://{{ keycloak_host }}:{{ keycloak_http_port }}` | +|`keycloak_management_url` | URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port }}` | +|`rhsso_rhn_id` | Customer Portal product ID for Red Hat SSO | `{{ rhsso_rhn_ids[keycloak_rhsso_version] }}` | Role Variables diff --git a/roles/keycloak/tasks/install.yml b/roles/keycloak/tasks/install.yml index a5fd1eb..2ca47f3 100644 --- a/roles/keycloak/tasks/install.yml +++ b/roles/keycloak/tasks/install.yml @@ -63,7 +63,7 @@ register: archive_path ## download to controller -- name: Check load download archive path +- name: Check local download archive path stat: path: "{{ lookup('env', 'PWD') }}" register: local_path diff --git a/roles/keycloak_realm/README.md b/roles/keycloak_realm/README.md index e5d57b7..cf147b5 100644 --- a/roles/keycloak_realm/README.md +++ b/roles/keycloak_realm/README.md @@ -9,13 +9,18 @@ Role Defaults | Variable | Description | Default | |:---------|:------------|:---------| -|`keycloak_admin_user` | Administration console user account | `admin` | -|`keycloak_host` | hostname | `localhost` | -|`keycloak_http_port` | HTTP port | `8080` | -|`keycloak_https_port` | TLS HTTP port | `8443` | -|`keycloak_auth_realm` | Name of the main authentication realm | `master` | -|`keycloak_rhsso_enable` | Define service is an upstream(Keycloak) or RHSSO | `master` | - +|`keycloak_admin_user`| Administration console user account | `admin` | +|`keycloak_host`| hostname | `localhost` | +|`keycloak_http_port`| HTTP port | `8080` | +|`keycloak_https_port`| TLS HTTP port | `8443` | +|`keycloak_auth_realm`| Name of the main authentication realm | `master` | +|`keycloak_rhsso_enable`| Define service is an upstream(Keycloak) or RHSSO | `master` | +|`keycloak_management_http_port`| Management port | `9990` | +|`keycloak_auth_client`| Authentication client for configuration REST calls | `admin-cli` | +|`keycloak_client_public`| Configure a public realm client | `True` | +|`keycloak_client_web_origins`| Web origins for realm client | `+` | +|`keycloak_url`| URL for configuration rest calls | `http://{{ keycloak_host }}:{{ keycloak_http_port }}` | +|`keycloak_management_url`| URL for management console rest calls | `http://{{ keycloak_host }}:{{ keycloak_management_http_port }}` | Role Variables