How to import a realm in Keycloak and exit

Question

I have followed the Keycloak admin guide to export and import realms using standalone.sh it does work but it starts the server and does not exit.

This is a problem for me because I want to automate this process via executing an Ansible playbook and so I can't because the task never ends.

I found a workaround in Ansible by using async and wait_for but was hoping for a better way that does not require using the Admin REST API.

- name: Stop keycloak
  service:
    name: keycloak
    state: stopped
- name: Import realm into Keycloak
  shell: "{{keycloak_home}}/bin/standalone.sh -Dkeycloak.migration.action=import -Dkeycloak.migration.provider=dir -Dkeycloak.migration.dir=master -Dkeycloak.migration.usersExportStrategy=SAME_FILE -Dkeycloak.migration.realmName=master"
  async: 30
  poll: 0
- name: Wait for Keycloak to be started and listen on port 8080
  wait_for:
    host: 0.0.0.0
    port: 8080
    delay: 10
- name: Restart keycloak
  service:
    name: keycloak
    state: restarted

Answer 1

You can do it with Keycloak Admin CLI.

Authenticate once before running any command (see section Authenticating on the link above), for example:

$ kcadm.sh config credentials --server http://localhost:8080/auth --realm demorealm --user admin --password admin

Commands for full export/import example (see section Realm operations > Updating a realm):

$ kcadm.sh get realms/demorealm > demorealm.json
$ vi demorealm.json
$ kcadm.sh update realms/demorealm -f demorealm.json

Can do partial export/import as well using commands like: kcadm.sh create partial-export | partialImport ....