KEYCLOAK-8139 Update the documentation for supported/deprecated Wildfly/EAP adapters

This commit is contained in:
mposolda 2018-08-30 13:56:07 +02:00 committed by Hynek Mlnařík
parent 8ae19e5f78
commit 66c96281d2
5 changed files with 43 additions and 12 deletions

View file

@ -1,4 +1,7 @@
ifeval::[{project_community}==true]
== {project_name_full} 4.4.0.Final
include::topics/4_4_0_final.adoc[leveloffset=2]
== {project_name_full} 4.3.0.Final
include::topics/4_3_0_final.adoc[leveloffset=2]

View file

@ -0,0 +1,5 @@
= Upgrade to WildFly 13
The {project_name} server was upgraded to use WildFly 13 under the covers. This means update of the underlying dependencies and also
some changes in the configuration. We now also support WildFly 13 adapter and we upgraded the underlying JDG/Infinispan server version for
the Cross-DC setup. See link:{upgradingguide_link}[{upgradingguide_name}] for more details.

View file

@ -26,10 +26,13 @@ Both methods are described in this section.
Adapters are available as a separate archive depending on what server version you are using.
NOTE: {appserver_name} should be running when you install the adapter. If you have either one running, you must stop it before installing and then restart it after installation is complete.
ifeval::[{project_community}==true]
Install on WildFly 9, 10 or 11:
NOTE: We only test and maintain adapter with the most recent version of WildFly available upon the release. Once new version of
WildFly is released, the current adapters become deprecated and support for them will be removed after next WildFly release.
The other alternative is to switch your applications from WildFly to the JBoss EAP, as the JBoss EAP adapter is supported for much longer period.
Install on WildFly 9 or newer:
[source, subs="attributes"]
----
@ -105,7 +108,7 @@ To configure the adapter subsystem if the server is not running execute:
NOTE: Alternatively, you can specify the `server.config` property while installing adapters from the command line to install adapters using a different config, for example: `-Dserver.config=standalone-ha.xml`.
ifeval::[{project_community}==true]
.WildFly 11
.WildFly 11 or newer
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install-offline.cli
@ -116,10 +119,14 @@ $ ./bin/jboss-cli.sh --file=adapter-elytron-install-offline.cli
----
$ ./bin/jboss-cli.sh --file=adapter-install-offline.cli
----
NOTE: It is possible to use the legacy non-Elytron adapter on WildFly 11 or newer as well, meaning you can use `adapter-install-offline.cli`
even on those versions. However, we recommend to use the newer Elytron adapter.
endif::[]
ifeval::[{project_product}==true]
.JBoss EAP 7.1
.JBoss EAP 7.1 or newer
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install-offline.cli
@ -130,15 +137,18 @@ $ ./bin/jboss-cli.sh --file=adapter-elytron-install-offline.cli
----
$ ./bin/jboss-cli.sh --file=adapter-install-offline.cli
----
endif::[]
NOTE: It is possible to use the legacy non-Elytron adapter on JBoss EAP 7.1 or newer as well, meaning you can use `adapter-install-offline.cli`
even on those versions. However, we recommend to use the newer Elytron adapter.
NOTE: The offline script is not available for JBoss EAP 6.4
endif::[]
Alternatively, if the server is running execute:
ifeval::[{project_community}==true]
.WildFly 11
.WildFly 11 or newer
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install.cli
@ -152,7 +162,7 @@ $ ./bin/jboss-cli.sh --file=adapter-install.cli
endif::[]
ifeval::[{project_product}==true]
.JBoss EAP 7.1
.JBoss EAP 7.1 or newer
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install.cli

View file

@ -5,7 +5,12 @@
Each adapter is a separate download on the {project_name} download site.
ifeval::[{project_community}==true]
Install on WildFly 9 or 10, 11 or JBoss EAP 7:
NOTE: We only test and maintain adapter with the most recent version of WildFly available upon the release. Once new version of
WildFly is released, the current adapters become deprecated and support for them will be removed after next WildFly release.
The other alternative is to switch your applications from WildFly to the JBoss EAP, as the JBoss EAP adapter is supported for much longer period.
Install on WildFly 9 or newer or on JBoss EAP 7:
[source]
----
@ -50,7 +55,7 @@ There is a CLI script that will help you modify your server configuration.
Start the server and run the script from the server's bin directory:
ifeval::[{project_community}==true]
.WildFly 11
.WildFly 11 or newer
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install-saml.cli
@ -63,10 +68,14 @@ $ ./bin/jboss-cli.sh --file=adapter-elytron-install-saml.cli
$ cd $JBOSS_HOME/bin
$ jboss-cli.sh -c --file=adapter-install-saml.cli
----
NOTE: It is possible to use the legacy non-Elytron adapter on WildFly 11 or newer as well, meaning you can use `adapter-install-saml.cli`
even on those versions. However, we recommend to use the newer Elytron adapter.
endif::[]
ifeval::[{project_product}==true]
.JBoss EAP 7.1
.JBoss EAP 7.1 or newer
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install-saml.cli
@ -79,6 +88,10 @@ $ ./bin/jboss-cli.sh --file=adapter-elytron-install-saml.cli
$ cd $JBOSS_HOME/bin
$ jboss-cli.sh -c --file=adapter-install-saml.cli
----
NOTE: It is possible to use the legacy non-Elytron adapter on JBoss EAP 7.1 or newer as well, meaning you can use `adapter-install-saml.cli`
even on those versions. However, we recommend to use the newer Elytron adapter.
endif::[]

View file

@ -84,7 +84,7 @@
:appserver_loadbalancer_name: {appserver_name} {appserver_version} Documentation
:jdgserver_name: Infinispan
:jdgserver_version: 8.2.8
:jdgserver_version: 9.2.4
:jdgserver_crossdcdocs_link: https://access.redhat.com/documentation/en-us/red_hat_jboss_data_grid/7.2/html/administration_and_configuration_guide/set_up_cross_datacenter_replication
:fuseVersion: JBoss Fuse 6.3.0 Rollup 5