diff --git a/topics/templates/document-attributes-product.adoc b/topics/templates/document-attributes-product.adoc index 2cd6f857d3..9748ed8a3b 100644 --- a/topics/templates/document-attributes-product.adoc +++ b/topics/templates/document-attributes-product.adoc @@ -7,6 +7,7 @@ :project_name_full: Red Hat Single Sign-On :project_version: 7.4.0.GA +:keycloak_upgrade_version: 9.0.x :project_versionDoc: 7.4 :project_templates_base_url: https://raw.githubusercontent.com/jboss-container-images/redhat-sso-7-openshift-image/sso74-dev/templates :project_latest_image_tag: 1.0 diff --git a/upgrading/topics/rhsso/changes.adoc b/upgrading/topics/rhsso/changes.adoc index 417be153c7..b44d5624dd 100644 --- a/upgrading/topics/rhsso/changes.adoc +++ b/upgrading/topics/rhsso/changes.adoc @@ -1,3 +1,4 @@ +[[_release_changes]] == Changes Review these changes carefully before upgrading. diff --git a/upgrading/topics/rhsso/intro.adoc b/upgrading/topics/rhsso/intro.adoc index e6069a007b..d2ca4a39b8 100644 --- a/upgrading/topics/rhsso/intro.adoc +++ b/upgrading/topics/rhsso/intro.adoc @@ -2,7 +2,7 @@ == Introduction -Red Hat Single Sign-On (RH-SSO) 7.3 is based on the Keycloak project and provides security for your web applications by +Red Hat Single Sign-On (RH-SSO) {project_versionDoc} is based on the Keycloak project and provides security for your web applications by providing Web single sign-on capabilities based on popular standards such as SAML 2.0, OpenID Connect, and OAuth 2.0. The Red Hat Single Sign-On Server can act as a SAML or OpenID Connect-based identity provider, mediating with your enterprise user directory or third-party SSO provider for identity information and your applications using standards-based @@ -14,7 +14,7 @@ RH-SSO instances from a single control point. The upgrade process differs depend implemented. Specific instructions for each mode are provided where applicable. The purpose of this guide is to document the steps that are required to successfully upgrade from -Red Hat Single Sign-On 7.2 to Red Hat Single Sign-On 7.3. +Red Hat Single Sign-On 7.x to Red Hat Single Sign-On {project_versionDoc}. === About Upgrades @@ -28,16 +28,30 @@ that could require rewriting parts of applications or server extensions. Red Hat Single Sign-On periodically provides point releases, which are minor updates that include bug fixes, security fixes, and new features. If you plan to upgrade from one Red Hat Single Sign-On point release to another, for example, -from Red Hat Single Sign-On 7.2 to Red Hat Single Sign-On 7.3, code changes should not be required for applications or +from Red Hat Single Sign-On 7.3 to Red Hat Single Sign-On {project_versionDoc}, code changes should not be required for applications or custom server extensions as long as no private, unsupported, or tech preview APIs are used. ==== Micro Updates -Red Hat Single Sign-On 7 also periodically provides micro releases that contain bug and security fixes. -Micro releases increment the minor release version by the last digit, for example from 7.2.0 to 7.2.1. These release +Red Hat Single Sign-On {project_versionDoc} also periodically provides micro releases that contain bug and security fixes. +Micro releases increment the minor release version by the last digit, for example from {project_versionDoc}.0 to {project_versionDoc}.1. These releases do not require migration and should not impact the server configuration files. The patch management system for ZIP installations can also rollback the patch and server configuration. -A micro release only contains the artifacts that have changed. For example if Red Hat Single Sign-On 7.2.1 contains changes to +A micro release only contains the artifacts that have changed. For example if Red Hat Single Sign-On {project_versionDoc}.1 contains changes to the server and the JavaScript adapter, but not the EAP adapter, only the server and JavaScript adapter are released and require updating. + +=== Migration from Keycloak + +You can migrate to Red Hat Single Sign-On, the supported Red Hat product, from Keycloak, the community project. + +.Prerequisites + +* To learn about new features before the upgrade, review the xref:_release_changes[changes]. +* Verify that you have installed the correct version of Keycloak as a starting point. To migrate to Red Hat Single Sign-On {project_versionDoc}, you need Keycloak {keycloak_upgrade_version}. + +.Procedure + +. Perform the xref:_upgrading_minor[Minor Upgrades] procedure. Although this procedure is labelled *Minor Upgrade*, the same steps apply for this migration. +. Perform the xref:_upgrade_adapters[Adapter Upgrade procedure]. diff --git a/upgrading/topics/rhsso/upgrading.adoc b/upgrading/topics/rhsso/upgrading.adoc index ad1811e4d8..9bddbc4903 100644 --- a/upgrading/topics/rhsso/upgrading.adoc +++ b/upgrading/topics/rhsso/upgrading.adoc @@ -2,12 +2,13 @@ == Upgrading {project_name} Server -The upgrade process for the {project_name} server is different if you are upgrading to a different -minor release or not. +The upgrade or migration process for the {project_name} server depends on the previous version of the software. -If you are upgrading to a new minor release, for example from 7.0.0 to 7.1.0, follow the steps in xref:_upgrading_minor[Minor Upgrades]. +* If you are upgrading to a new minor release, for example from 7.0.0 to 7.1.0, follow the steps in xref:_upgrading_minor[Minor Upgrades]. -If you are upgrading to a new micro release, for example from 7.1.0 to 7.1.1, follow the steps in xref:_upgrading_micro[Micro Upgrades]. +* If you are migrating from Keycloak {keycloak_upgrade_version}, follow the steps in xref:_upgrading_minor[Minor Upgrades]. + +* If you are upgrading to a new micro release, for example from 7.1.0 to 7.1.1, follow the steps in xref:_upgrading_micro[Micro Upgrades]. [[_upgrading_minor]] === Minor Upgrades