Separate migration changes for 16 into separate file (#1354)

This commit is contained in:
Stian Thorgersen 2022-01-04 13:51:35 +01:00 committed by GitHub
parent 0e33c973c4
commit 0f95c118ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 35 additions and 34 deletions

View file

@ -0,0 +1,34 @@
= WildFly 25 upgrade
WildFly 25 deprecates the legacy security subsystem that among other things was used to configure TLS. Due to the amount of changes we are not able to provide migration scripts as we have done in the past.
We recommend that rather than copying configuration files from previous versions of Keycloak that you start with the default configuration files provided in Keycloak 16 and apply the relevant changes.
Configuration for the Keycloak subsystem can be copied directly.
For more information around the Elytron subsystem refer to the https://docs.wildfly.org/25/WildFly_Elytron_Security.html[WildFly documentation].
We are really sorry for this inconvenience and understand this will make it significantly harder for everyone to upgrade to Keycloak 16, but we simply have not been able to find an alternative approach.
One thing worth pointing out is the switch to Quarkus distribution, which we plan to make fully supported in Keycloak 17, will make it significantly easier to configure and upgrade Keycloak.
For more information on WildFly 25 refer to the https://www.wildfly.org/news/2021/10/05/WildFly25-Final-Released/[WildFly 25 release notes].
= Proxy environment variables
{project_name} now respects the standard `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables for outgoing
HTTP requests. This change could lead to unexpected use of a proxy server if you have for example the `HTTP_PROXY` variable defined but have no
explicit proxy mappings specified in your SPI configuration. To prevent {project_name} from using those environment variables,
you can explicitly create a no proxy route for all requests as `.*;NO_PROXY`.
For more details, see the link:{installguide_link}#_proxy_env_vars[related chapter in the {installguide_name}].
= Deprecated features in the {project_operator}
With this release, we have deprecated and/or marked as unsupported some features in the {project_operator}. This
concerns the Backup CRD and the operator managed Postgres Database. For more details, please see the
link:{installguide_link}#_operator_production_usage[related chapter in the {installguide_name}].
= Keycloak Operator examples including unsupported Metrics extension
Previously, an unsupported metrics extension was added in the example for the creation of the Keycloak CR by the {project_operator}. This has been removed.

View file

@ -2,40 +2,7 @@
=== Migrating to 16.0.0 === Migrating to 16.0.0
==== WildFly 25 upgrade include::changes-16_0_0.adoc[leveloffset=3]
WildFly 25 deprecates the legacy security subsystem that among other things was used to configure TLS. Due to the amount of changes we are not able to provide migration scripts as we have done in the past.
We recommend that rather than copying configuration files from previous versions of Keycloak that you start with the default configuration files provided in Keycloak 16 and apply the relevant changes.
Configuration for the Keycloak subsystem can be copied directly.
For more information around the Elytron subsystem refer to the https://docs.wildfly.org/25/WildFly_Elytron_Security.html[WildFly documentation].
We are really sorry for this inconvenience and understand this will make it significantly harder for everyone to upgrade to Keycloak 16, but we simply have not been able to find an alternative approach.
One thing worth pointing out is the switch to Quarkus distribution, which we plan to make fully supported in Keycloak 17, will make it significantly easier to configure and upgrade Keycloak.
For more information on WildFly 25 refer to the https://www.wildfly.org/news/2021/10/05/WildFly25-Final-Released/[WildFly 25 release notes].
==== Proxy environment variables
{project_name} now respects the standard `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables for outgoing
HTTP requests. This change could lead to unexpected use of a proxy server if you have for example the `HTTP_PROXY` variable defined but have no
explicit proxy mappings specified in your SPI configuration. To prevent {project_name} from using those environment variables,
you can explicitly create a no proxy route for all requests as `.*;NO_PROXY`.
For more details, see the link:{installguide_link}#_proxy_env_vars[related chapter in the {installguide_name}].
==== Deprecated features in the {project_operator}
With this release, we have deprecated and/or marked as unsupported some features in the {project_operator}. This
concerns the Backup CRD and the operator managed Postgres Database. For more details, please see the
link:{installguide_link}#_operator_production_usage[related chapter in the {installguide_name}].
=== Keycloak Operator examples including unsupported Metrics extension
Previously, an unsupported metrics extension was added in the example for the creation of the Keycloak CR by the {project_operator}. This has been removed.
=== Migrating to 14.0.0 === Migrating to 14.0.0