ansible-keycloak/README.md

2.0 KiB

Ansible Collection - keycloak

Build Status

Collection to install and configure Keycloak or Red Hat Single Sign-On.

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.9.10.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions.

Installation and Usage

Installing the Collection from Ansible Galaxy

Before using the collection, you need to install it with the Ansible Galaxy CLI:

ansible-galaxy collection install middleware_automation.keycloak

You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: middleware_automation.keycloak

Choosing between Red Hat products and upstream project

The roles supports installing Red Hat Single Sign-On from the Customer Portal, when the following variables are defined:

rhn_username: '<customer_portal_username>'
rhn_password: '<customer_portal_password>'
rhsso_rhn_id: '<sso_product_id>'

where sso_product_id is the ID for the specific Red Hat Single Sign-On version, ie. 101971 will install version 7.5)

Included roles

  • keycloak: role for installing the service. Requires: python3-netaddr
  • keycloak_realm: role for configuring a realm, with clients and users, in an installed service.

License

Apache License v2.0 or later

See LICENCE to view the full text.