Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/idealista/keycloak_role
ansible role for keycloak
https://github.com/idealista/keycloak_role
ansible-role debian keycloak
Last synced: 28 days ago
JSON representation
ansible role for keycloak
- Host: GitHub
- URL: https://github.com/idealista/keycloak_role
- Owner: idealista
- License: apache-2.0
- Created: 2020-12-14T12:58:20.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-03T12:40:15.000Z (about 2 years ago)
- Last Synced: 2023-03-05T18:38:57.729Z (almost 2 years ago)
- Topics: ansible-role, debian, keycloak
- Language: Jinja
- Homepage:
- Size: 93.8 KB
- Stars: 0
- Watchers: 11
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Keycloak Ansible role
[](https://travis-ci.com/idealista/keycloak_role)
[](https://galaxy.ansible.com/idealista/keycloak_role)
This ansible role installs [Keycloak](https://www.keycloak.org/) in a Debian environment. It has been tested for the following Debian versions:
* Buster
This role has been generated using the [cookiecutter](https://github.com/cookiecutter/cookiecutter) tool, you can generate a similar role that fits your needs using the this [cookiecutter template](https://github.com/idealista/cookiecutter-ansible-role).
- [Getting Started](#getting-started)
- [Prerequisities](#prerequisities)
- [Installing](#installing)
- [Usage](#usage)
- [Testing](#testing)
- [Built With](#built-with)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Contributing](#contributing)
## Getting Started
These instructions will get you a copy of the role for your Ansible playbook. Once launched, it will install Keycloak in a Debian system.
### Prerequisities
Ansible 2.9.9 version installed. Inventory destination should be a Debian environment with Java installed. You can install it with this [ansible role](https://github.com/idealista/java_role).
Molecule 3.x.x version installed.
For testing purposes, [Molecule](https://molecule.readthedocs.io/) with [Docker](https://www.docker.com/) as driver and [Goss](https://github.com/aelsabbahy/goss) as verifier.
### Installing
Create or add to your roles dependency file (e.g requirements.yml):
```
- src: idealista.keycloak_role
version: 1.0.0
name: keycloak_role
```
Install the role with ansible-galaxy command:
```
ansible-galaxy install -p roles -r requirements.yml -f
```
Use in a playbook:
```
---
- hosts: someserver
roles:
- role: keycloak_role
```
## Usage
Look to the [defaults](defaults/main.yml) properties file to see the possible configuration properties, it is very likely that you will not need to override any variables.
This role only supports one datasource for now. In our test, we used postgresql.
`confluence_jdbc_origin` allow jdbc driver installation from maven or direct download. Valid values `url` or `maven`
To add a datasource, set `keycloak_jdbc_install: false` to `true`, and fill the required varaibles.
## Testing
### Install dependencies
```sh
$ pipenv sync
```
For more information read the [pipenv docs](ipenv-fork.readthedocs.io/en/latest/).
### Testing
```sh
$ pipenv run molecule test
```
For testing purposes, postgresql is used as an external database. You can install it with this [ansible role](https://github.com/idealista/postgresql_role).
## Built With
## Versioning
For the versions available, see the [tags on this repository](https://github.com/idealista/keycloak_role/tags).
Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.
## Authors
* **Idealista** - *Work with* - [idealista](https://github.com/idealista)
See also the list of [contributors](https://github.com/idealista/keycloak_role/contributors) who participated in this project.
## License
This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details.
## Contributing
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.