Service ID Keycloak

Location

• Staging: gode
• Production: adaba

License

No license.

Description of the service

Keycloak provides authentication for OpenMRS IDs. A Keycloak docker container built from the keycloak folder of openmrs-contrib-itsm-id is published within Docker Hub as openmrsinfra/openmrs-id-keycloak.

Postfix is used to relay emails from Atlassian to users' actual email addresses. A postfix docker container built from the postfix folder of openmrs-contrib-itsm-id is published within Docker Hub as openmrsinfra/openmrs-id-postfix. Only email from Atlassian email servers to [email protected], where username is a valid OpenMRS ID in LDAP will be forwarded to the corresponding user email within LDAP. This allows account management and self-service password resets for Atlassian services (wiki, issues, etc.).

How to access it

Keycloak is dockerized and is hosted at https://id-new.openmrs.org/ until OpenMRS ID legacy software is retired.

How to restart it

cd /root/docker/id-new
docker-compose down && \
  docker-compose up -d

How to setup

Via ansible/docker compose apps.

Production backups and restores

Backup

Check Backups-Strategy to understand how to download or upload backups files from/to AWS S3.

TODO: describe steps to generate a new backup of Keycloak here

Restore

TODO: need to describe steps how to restore Keycloak db from backup here

• Using slapcat/slapadd is not recommended and can lead to inconsistencies.

Logs

cd /root/docker/id-new
docker-compose logs -f

Troubleshooting

TBD