libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases Packages Activity Actions

Remove inaccurate statement about master realm imports

Browse source 
This is supported since 26.0.0

Closes #34301

Signed-off-by: maxhov <14804474+maxhov@users.noreply.github.com>
This commit is contained in:
Max Hovens 2024-10-31 12:23:35 +01:00 committed by GitHub
parent db780ed6c7
commit 4e540fa2a7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/guides/server/importExport.adoc
View file

@ -16,7 +16,7 @@ The default count of users per file and per transaction is fifty.
Increasing this to a larger number leads to an exponentially increasing execution time. Increasing this to a larger number leads to an exponentially increasing execution time.
==== ====
All {project_name} nodes need to be stopped prior to using `kc.[sh|bat] import | export` commands. This ensures that the resulting operations will have no consistency issues with concurrent requests. All {project_name} nodes need to be stopped prior to using `kc.[sh|bat] import | export` commands. This ensures that the resulting operations will have no consistency issues with concurrent requests.
It also ensures that running an import or export command from the same machine as a server instance will not result in port or other conflicts. It also ensures that running an import or export command from the same machine as a server instance will not result in port or other conflicts.
== Providing options for database connection parameters == Providing options for database connection parameters
@ -31,7 +31,7 @@ As default, {project_name} will re-build automatically for the `export` and `imp
If you have built an optimized version of {project_name} with the `build` command as outlined in <@links.server id="configuration"/>, use the command line option `--optimized` to have {project_name} skip the build check for a faster startup time. If you have built an optimized version of {project_name} with the `build` command as outlined in <@links.server id="configuration"/>, use the command line option `--optimized` to have {project_name} skip the build check for a faster startup time.
When doing this, remove the build time options from the command line and keep only the runtime options. When doing this, remove the build time options from the command line and keep only the runtime options.
NOTE: if you do not use `--optimized` keep in mind that an `import` or `export` command will implicitly create or update an optimized image for you - if you are running the command from the same machine as a server instance, this may impact the next start of your server. NOTE: if you do not use `--optimized` keep in mind that an `import` or `export` command will implicitly create or update an optimized image for you - if you are running the command from the same machine as a server instance, this may impact the next start of your server.
== Exporting a Realm to a Directory == Exporting a Realm to a Directory
@ -130,8 +130,6 @@ realms and potentially lose state between server restarts.
To re-create realms you should explicitly run the `import` command prior to starting the server. To re-create realms you should explicitly run the `import` command prior to starting the server.
Importing the `master` realm is not supported because as it is a very sensitive operation.
== Importing and Exporting by using the Admin Console == Importing and Exporting by using the Admin Console
You can also import and export a realm using the Admin Console. This functionality is You can also import and export a realm using the Admin Console. This functionality is
@ -148,7 +146,7 @@ To export a realm using the Admin Console, perform these steps:
. Click *Realm settings* in the menu. . Click *Realm settings* in the menu.
. Point to the *Action* menu in the top right corner of the realm settings screen, and select *Partial export*. . Point to the *Action* menu in the top right corner of the realm settings screen, and select *Partial export*.
+ +
A list of resources appears along with the realm configuration. A list of resources appears along with the realm configuration.
. Select the resources you want to export. . Select the resources you want to export.
. Click *Export*. . Click *Export*.
@ -162,7 +160,7 @@ In a similar way, you can import a previously exported realm. Perform these step
. Click *Realm settings* in the menu. . Click *Realm settings* in the menu.
. Point to the *Action* menu in the top right corner of the realm settings screen, and select *Partial import*. . Point to the *Action* menu in the top right corner of the realm settings screen, and select *Partial import*.
+ +
A prompt appears where you can select the file you want to import. Based on this file, you see the resources you can import along with the realm settings. A prompt appears where you can select the file you want to import. Based on this file, you see the resources you can import along with the realm settings.
. Click *Import*. . Click *Import*.