guillaume
/
ansible-keycloak
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rework docs, add python requirements

main
Guido Grazioli 2022-01-27 11:59:35 +01:00
parent 44f0952afe
commit 11fb2cc43b
No known key found for this signature in database
GPG Key ID: 22C8C31EF2BC093B
3 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -29,6 +29,23 @@ collections:
- name: middleware_automation.keycloak - name: middleware_automation.keycloak
``` ```
The keycloak collection also depends on the following python packages to be present on the controller host:
* netaddr
A requirement file is provided to install:
pip install -r requirements.txt
### Included roles
* [`keycloak`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md): role for installing the service.
* [`keycloak_realm`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md): role for configuring a realm, user federation(s), clients and users, in an installed service.
## Usage
### Install Playbook ### Install Playbook
`playbooks/keycloak.yml` installs the upstream(Keycloak) based on the defined variables. `playbooks/keycloak.yml` installs the upstream(Keycloak) based on the defined variables.
@ -80,10 +97,6 @@ keycloak_rhsso_enable: True
zip_file_local_path: <rhsso zip file on Ansible control node local path> zip_file_local_path: <rhsso zip file on Ansible control node local path>
``` ```
### Install role
* [`keycloak`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak/README.md): role for installing the service. _Requires: python3-netaddr_
### Example installation command ### Example installation command
Execute the following command from the source root directory Execute the following command from the source root directory
@ -106,10 +119,6 @@ ansible-playbook -i <ansible_hosts> -e @rhn-creds.yml playbooks/keycloak.yml -e
`playbooks/keycloak-realm.yml` creates provided realm, user federation(s), client(s), client role(s) and client user(s) if they don't exist. `playbooks/keycloak-realm.yml` creates provided realm, user federation(s), client(s), client role(s) and client user(s) if they don't exist.
### Config role
* [`keycloak_realm`](https://github.com/ansible-middleware/keycloak/blob/main/roles/keycloak_realm/README.md): role for configuring a realm, user federation(s), clients and users, in an installed service.
### Example configuration command ### Example configuration command
Execute the following command from the source root directory Execute the following command from the source root directory
@ -131,5 +140,5 @@ ansible-playbook -i <ansible_hosts> playbooks/keycloak-realm.yml -e keycloak_adm
Apache License v2.0 or later Apache License v2.0 or later
See [LICENCE](LICENSE) to view the full text. See [LICENSE](LICENSE) to view the full text.

6
requirements.txt 100644
View File

@ -0,0 +1,6 @@
#################################################
# python dependencies required to be installed
# on the controller host with:
# pip install -r requirements.txt
#
netaddr

4
roles/keycloak/README.md
View File

@ -91,8 +91,8 @@ Dependencies
The roles depends on: The roles depends on:
* the redhat_csp_download role from [middleware_automation.redhat_csp_download](https://github.com/ansible-middleware/redhat-csp-download) collection if Red Hat Single Sign-on zip have to be downloaded from RHN. * the `redhat_csp_download` role from [middleware_automation.redhat_csp_download](https://github.com/ansible-middleware/redhat-csp-download) collection if Red Hat Single Sign-on zip have to be downloaded from RHN.
* the wildfly_driver role from [middleware_automation.wildfly](https://github.com/ansible-middleware/wildfly) collection * the `wildfly_driver` role from [middleware_automation.wildfly](https://github.com/ansible-middleware/wildfly) collection
Example Playbook Example Playbook