From 6b7c6f6222f011de6823212ad82c77f655eb8539 Mon Sep 17 00:00:00 2001 From: Jan Lieskovsky Date: Mon, 21 Jan 2019 21:09:55 +0100 Subject: [PATCH] [KEYCLOAK-9361] Consolidate the Tutorials DB migration section Signed-off-by: Jan Lieskovsky --- openshift/topics/advanced_concepts.adoc | 2 +- openshift/topics/tutorials.adoc | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/openshift/topics/advanced_concepts.adoc b/openshift/topics/advanced_concepts.adoc index 4ee9ff5c19..96c36fddcc 100644 --- a/openshift/topics/advanced_concepts.adoc +++ b/openshift/topics/advanced_concepts.adoc @@ -228,7 +228,7 @@ $ oc new-app --template={project_templates_version}-https \ ---- [[advanced-concepts-sso-hostname-spi-setup]] -=== Customizing Hostname for the {project_name} Server +=== Customizing the Hostname for {project_name} Server The hostname SPI introduced a flexible way to configure the hostname for the {project_name} server. There are two built-in providers. The first is `request`, which uses the request headers to determine the hostname. This is the *default setting* for {project_openshift_product_name} image. The second is `fixed`, which allows configuring a fixed hostname. The latter makes sure that only valid hostnames can be used and allows internal applications to invoke {project_name} server through an alternative URL. diff --git a/openshift/topics/tutorials.adoc b/openshift/topics/tutorials.adoc index a135f7de1f..70d57e7929 100644 --- a/openshift/topics/tutorials.adoc +++ b/openshift/topics/tutorials.adoc @@ -41,7 +41,7 @@ Use the xref:sso-administrator-setup[credentials of the {project_name} administr == Tutorials [[upgrading-sso-db-from-previous-version]] -=== Example Workflow: Updating Existing Database when Migrating {project_openshift_product_name} Image to a new version +=== Example Workflow: Updating Existing Database to Migrate to New {project_openshift_product_name} Image Version [IMPORTANT] ==== * Rolling updates from previous versions of {project_openshift_product_name} to version {project_version} are not supported as databases and caches are not backward compatible. @@ -581,10 +581,10 @@ $ oc scale --replicas=1 dc/sso deploymentconfig "sso" scaled ---- -==== Migrating The Entire {project_name} Server Database Across The Environments +=== Example Workflow: Migrating The {project_name} Server's Database Across Environments This tutorial focuses on migrating the Red Hat Single Sign-On server database from one environment to another or migrating to a different database. It assumes steps described in xref:Preparing-SSO-Authentication-for-OpenShift-Deployment[Preparing {project_name} Authentication for OpenShift Deployment] section have been performed already. -===== Deploying the {project_name} MySQL Application Template +==== Deploying the {project_name} MySQL Application Template . Log in to the OpenShift web console and select the _sso-app-demo_ project space. . Click *Add to project* to list the default image streams and templates. @@ -611,7 +611,7 @@ This example workflow uses a self-generated CA to provide an end-to-end workflow For production environments, Red Hat recommends that you use an SSL certificate purchased from a verified Certificate Authority. ==== -===== (Optional) Creating additional {project_name} link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.2/html-single/server_administration_guide/#core_concepts_and_terms[realm and users] to be also exported +==== (Optional) Creating additional {project_name} link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.2/html-single/server_administration_guide/#core_concepts_and_terms[realm and users] to be also exported When performing link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.2/html-single/server_administration_guide/#export_import[{project_name} {project_version} server database export] only {project_name} realms and users currently present in the database will be exported. If the exported JSON file should include also additional {project_name} realms and users, these need to be created first: @@ -621,7 +621,7 @@ When performing link:https://access.redhat.com/documentation/en-us/red_hat_singl Upon their creation xref:sso-export-the-database[the database can be exported.] [[sso-export-the-database]] -===== Export the {project_name} database as a JSON file on the OpenShift pod +==== Export the {project_name} database as a JSON file on the OpenShift pod . Get the {project_name} deployment config and scale it down to zero. + @@ -665,7 +665,7 @@ $ oc logs sso-4-ejr0k | grep 'Export' 09:24:59,998 INFO [org.keycloak.services] (ServerService Thread Pool -- 57) KC-SERVICES0035: Export finished successfully ---- -===== Retrieve and import the exported JSON file +==== Retrieve and import the exported JSON file . Retrieve the JSON file of the {project_name} database from the pod. +