From 2cbe476c52e027d4f224818e52e330c4e409f0d0 Mon Sep 17 00:00:00 2001 From: Steven Hawkins Date: Thu, 22 Aug 2024 02:37:07 -0400 Subject: [PATCH] fix: adding consistent language for the non-server commands (#32317) closes: #29200 Signed-off-by: Steve Hawkins --- docs/guides/server/bootstrap-admin-recovery.adoc | 5 +++++ docs/guides/server/importExport.adoc | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/docs/guides/server/bootstrap-admin-recovery.adoc b/docs/guides/server/bootstrap-admin-recovery.adoc index 2ad99c677b..457bcc4401 100644 --- a/docs/guides/server/bootstrap-admin-recovery.adoc +++ b/docs/guides/server/bootstrap-admin-recovery.adoc @@ -28,6 +28,11 @@ The `bootstrap-admin` command can be executed even before the first-ever start o Additionally, it is strongly recommended to use the dedicated command with the same options that the {project_name} server is started with (e.g., `db` options). +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. + +NOTE: if you do not use `--optimized` keep in mind that an `bootstrap-admin` 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. + === Create an admin user To create a temporary admin user, execute the following command: diff --git a/docs/guides/server/importExport.adoc b/docs/guides/server/importExport.adoc index 2100656d4f..ac21142981 100644 --- a/docs/guides/server/importExport.adoc +++ b/docs/guides/server/importExport.adoc @@ -16,6 +16,9 @@ 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. ==== +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. + == Providing options for database connection parameters When using the `export` and the `import` commands below, {project_name} needs to know how to connect to the database where the information about realms, clients, users and other entities is stored. @@ -28,6 +31,8 @@ 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. 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. + == Exporting a Realm to a Directory To export a realm, you can use the `export` command. Your {project_name} server instance must not be started when invoking this command.