Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
For overwrite, do all deletes, then all adds.
Minor UI enhancements. Fix 2 JPA bugs. General cleanup. Documentation.
- Loading branch information
Showing
20 changed files
with
302 additions
and
528 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
220 changes: 120 additions & 100 deletions
220
docbook/auth-server-docs/reference/en/en-US/modules/export-import.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Original file line | Diff line number | Diff line change |
|---|---|---|---|
| @@ -1,114 +1,134 @@ | |||
| <chapter id="export-import"> | <chapter id="export-import"> | ||
| <title>Export and Import</title> | <title>Export and Import</title> | ||
| <para> | <section> | ||
| Export/import is useful especially if you want to migrate your whole Keycloak database from one environment to another or migrate to different database (For example from MySQL to Oracle). | <title>Startup export/import</title> | ||
| You can trigger export/import at startup of Keycloak server and it's configurable with System properties right now. The fact it's done at server startup means that no-one can access Keycloak UI or REST endpoints | <para> | ||
| and edit Keycloak database on the fly when export or import is in progress. Otherwise it could lead to inconsistent results. | Export/import is useful especially if you want to migrate your whole Keycloak database from one environment to another or migrate to different database (For example from MySQL to Oracle). | ||
| </para> | You can trigger export/import at startup of Keycloak server and it's configurable with System properties right now. The fact it's done at server startup means that no-one can access Keycloak UI or REST endpoints | ||
| <para> | and edit Keycloak database on the fly when export or import is in progress. Otherwise it could lead to inconsistent results. | ||
| You can export/import your database either to: | </para> | ||
| <itemizedlist> | <para> | ||
| <listitem>Directory on local filesystem</listitem> | You can export/import your database either to: | ||
| <listitem>Single JSON file on your filesystem</listitem> | <itemizedlist> | ||
| </itemizedlist> | <listitem>Directory on local filesystem</listitem> | ||
| <listitem>Single JSON file on your filesystem</listitem> | |||
| </itemizedlist> | |||
|
|
|
||
| When importing using the "dir" strategy, note that the files need to follow the naming convention specified below. | When importing using the "dir" strategy, note that the files need to follow the naming convention specified below. | ||
| If you are importing files which were previously exported, the files already follow this convention. | If you are importing files which were previously exported, the files already follow this convention. | ||
| <itemizedlist> | <itemizedlist> | ||
| <listitem>{REALM_NAME}-realm.json, such as "acme-roadrunner-affairs-realm.json" for the realm named "acme-roadrunner-affairs"</listitem> | <listitem>{REALM_NAME}-realm.json, such as "acme-roadrunner-affairs-realm.json" for the realm named "acme-roadrunner-affairs"</listitem> | ||
| <listitem>{REALM_NAME}-users-{INDEX}.json, such as "acme-roadrunner-affairs-users-0.json" for the first users file of the realm named "acme-roadrunner-affairs"</listitem> | <listitem>{REALM_NAME}-users-{INDEX}.json, such as "acme-roadrunner-affairs-users-0.json" for the first users file of the realm named "acme-roadrunner-affairs"</listitem> | ||
| </itemizedlist> | </itemizedlist> | ||
| </para> | </para> | ||
| <para> | <para> | ||
| If you import to Directory, you can specify also the number of users to be stored in each JSON file. So if you have | If you import to Directory, you can specify also the number of users to be stored in each JSON file. So if you have | ||
| very large amount of users in your database, you likely don't want to import them into single file as the file might be very big. | very large amount of users in your database, you likely don't want to import them into single file as the file might be very big. | ||
| Processing of each file is done in separate transaction as exporting/importing all users at once could also lead to memory issues. | Processing of each file is done in separate transaction as exporting/importing all users at once could also lead to memory issues. | ||
| </para> | </para> | ||
| <para> | <para> | ||
| To export into unencrypted directory you can use: | To export into unencrypted directory you can use: | ||
| <programlisting><![CDATA[ | <programlisting><![CDATA[ | ||
| bin/standalone.sh -Dkeycloak.migration.action=export | bin/standalone.sh -Dkeycloak.migration.action=export | ||
| -Dkeycloak.migration.provider=dir -Dkeycloak.migration.dir=<DIR TO EXPORT TO> | -Dkeycloak.migration.provider=dir -Dkeycloak.migration.dir=<DIR TO EXPORT TO> | ||
| ]]></programlisting> | ]]></programlisting> | ||
| And similarly for import just use <literal>-Dkeycloak.migration.action=import</literal> instead of <literal>export</literal> . | And similarly for import just use <literal>-Dkeycloak.migration.action=import</literal> instead of <literal>export</literal> . | ||
| </para> | </para> | ||
| <para> | <para> | ||
| To export into single JSON file you can use: | To export into single JSON file you can use: | ||
| <programlisting><![CDATA[ | <programlisting><![CDATA[ | ||
| bin/standalone.sh -Dkeycloak.migration.action=export | bin/standalone.sh -Dkeycloak.migration.action=export | ||
| -Dkeycloak.migration.provider=singleFile -Dkeycloak.migration.file=<FILE TO EXPORT TO> | -Dkeycloak.migration.provider=singleFile -Dkeycloak.migration.file=<FILE TO EXPORT TO> | ||
| ]]></programlisting> | ]]></programlisting> | ||
| </para> | </para> | ||
| <para> | <para> | ||
| Here's an example of importing: | Here's an example of importing: | ||
| <programlisting><![CDATA[ | <programlisting><![CDATA[ | ||
| bin/standalone.sh -Dkeycloak.migration.action=import | bin/standalone.sh -Dkeycloak.migration.action=import | ||
| -Dkeycloak.migration.provider=singleFile -Dkeycloak.migration.file=<FILE TO IMPORT> | -Dkeycloak.migration.provider=singleFile -Dkeycloak.migration.file=<FILE TO IMPORT> | ||
| -Dkeycloak.migration.strategy=OVERWRITE_EXISTING | -Dkeycloak.migration.strategy=OVERWRITE_EXISTING | ||
| ]]></programlisting> | ]]></programlisting> | ||
| </para> | </para> | ||
| <para> | <para> | ||
| Other available options are: | Other available options are: | ||
| <variablelist> | <variablelist> | ||
| <varlistentry> | <varlistentry> | ||
| <term>-Dkeycloak.migration.realmName</term> | <term>-Dkeycloak.migration.realmName</term> | ||
| <listitem> | <listitem> | ||
| <para> | <para> | ||
| can be used if you want to export just one specified realm instead of all. | can be used if you want to export just one specified realm instead of all. | ||
| If not specified, then all realms will be exported. | If not specified, then all realms will be exported. | ||
| </para> | </para> | ||
| </listitem> | </listitem> | ||
| </varlistentry> | </varlistentry> | ||
| <varlistentry> | <varlistentry> | ||
| <term>-Dkeycloak.migration.usersExportStrategy</term> | <term>-Dkeycloak.migration.usersExportStrategy</term> | ||
| <listitem> | <listitem> | ||
| <para> | <para> | ||
| can be used to specify for Directory providers to specify where to import users. | can be used to specify for Directory providers to specify where to import users. | ||
| Possible values are: | Possible values are: | ||
| <itemizedlist> | <itemizedlist> | ||
| <listitem>DIFFERENT_FILES - Users will be exported into more different files according to maximum number of users per file. This is default value</listitem> | <listitem>DIFFERENT_FILES - Users will be exported into more different files according to maximum number of users per file. This is default value</listitem> | ||
| <listitem>SKIP - exporting of users will be skipped completely</listitem> | <listitem>SKIP - exporting of users will be skipped completely</listitem> | ||
| <listitem>REALM_FILE - All users will be exported to same file with realm (So file like "foo-realm.json" with both realm data and users)</listitem> | <listitem>REALM_FILE - All users will be exported to same file with realm (So file like "foo-realm.json" with both realm data and users)</listitem> | ||
| <listitem>SAME_FILE - All users will be exported to same file but different than realm (So file like "foo-realm.json" with realm data and "foo-users.json" with users)</listitem> | <listitem>SAME_FILE - All users will be exported to same file but different than realm (So file like "foo-realm.json" with realm data and "foo-users.json" with users)</listitem> | ||
| </itemizedlist> | </itemizedlist> | ||
| </para> | </para> | ||
| </listitem> | </listitem> | ||
| </varlistentry> | </varlistentry> | ||
| <varlistentry> | <varlistentry> | ||
| <term>-Dkeycloak.migration.usersPerFile</term> | <term>-Dkeycloak.migration.usersPerFile</term> | ||
| <listitem> | <listitem> | ||
| <para> | <para> | ||
| can be used to specify number of users per file (and also per DB transaction). | can be used to specify number of users per file (and also per DB transaction). | ||
| It's 5000 by default. It's used only if usersExportStrategy is DIFFERENT_FILES | It's 5000 by default. It's used only if usersExportStrategy is DIFFERENT_FILES | ||
| </para> | </para> | ||
| </listitem> | </listitem> | ||
| </varlistentry> | </varlistentry> | ||
| <varlistentry> | <varlistentry> | ||
| <term>-Dkeycloak.migration.strategy</term> | <term>-Dkeycloak.migration.strategy</term> | ||
| <listitem> | <listitem> | ||
| <para> | <para> | ||
| is used during import. It can be used to specify how to proceed if realm with same name | is used during import. It can be used to specify how to proceed if realm with same name | ||
| already exists in the database where you are going to import data. Possible values are: | already exists in the database where you are going to import data. Possible values are: | ||
| <itemizedlist> | <itemizedlist> | ||
| <listitem>IGNORE_EXISTING - Ignore importing if realm of this name already exists</listitem> | <listitem>IGNORE_EXISTING - Ignore importing if realm of this name already exists</listitem> | ||
| <listitem>OVERWRITE_EXISTING - Remove existing realm and import it again with new data from JSON file. | <listitem>OVERWRITE_EXISTING - Remove existing realm and import it again with new data from JSON file. | ||
| If you want to fully migrate one environment to another and ensure that the new environment will contain same data | If you want to fully migrate one environment to another and ensure that the new environment will contain same data | ||
| like the old one, you can specify this. | like the old one, you can specify this. | ||
| </listitem> | </listitem> | ||
| </itemizedlist> | </itemizedlist> | ||
| </para> | </para> | ||
| </listitem> | </listitem> | ||
| </varlistentry> | </varlistentry> | ||
| </variablelist> | </variablelist> | ||
| </para> | </para> | ||
| <para> | <para> | ||
| When importing realm files that weren't exported before, the option <literal>keycloak.import</literal> can be used. If more than one realm | When importing realm files that weren't exported before, the option <literal>keycloak.import</literal> can be used. If more than one realm | ||
| file needs to be imported, a comma separated list of file names can be specified. This is more appropriate than the cases before, as this | file needs to be imported, a comma separated list of file names can be specified. This is more appropriate than the cases before, as this | ||
| will happen only after the master realm has been initialized. Examples: | will happen only after the master realm has been initialized. Examples: | ||
| <itemizedlist> | <itemizedlist> | ||
| <listitem>-Dkeycloak.import=/tmp/realm1.json</listitem> | <listitem>-Dkeycloak.import=/tmp/realm1.json</listitem> | ||
| <listitem>-Dkeycloak.import=/tmp/realm1.json,/tmp/realm2.json</listitem> | <listitem>-Dkeycloak.import=/tmp/realm1.json,/tmp/realm2.json</listitem> | ||
| </itemizedlist> | </itemizedlist> | ||
| </para> | </para> | ||
|
|
</section> | ||
| <section> | |||
| <title>Admin console export/import</title> | |||
| <para> | |||
| Import of most resources can be performed from the admin console. | |||
| Exporting resources will be supported in future versions. | |||
| </para> | |||
| <para> | |||
| The files created during a "startup" export can be used to import from | |||
| the admin UI. This way, you can export from one realm and import to | |||
| another realm. Or, you can export from one server and import to another. | |||
| </para> | |||
| <warning> | |||
| <para> | |||
| The admin console import allows you to "overwrite" resources if you choose. | |||
| Use this feature with caution, especially on a production system. | |||
| </para> | |||
| </warning> | |||
| </section> | |||
| </chapter> | </chapter> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.