Skip to content

Commit

Permalink
[CMTOOL-363] WildFly 32 server migration user-guide modules
Browse files Browse the repository at this point in the history
  • Loading branch information
emmartins committed May 2, 2024
1 parent 098bc20 commit 0e743e7
Show file tree
Hide file tree
Showing 48 changed files with 2,798 additions and 6 deletions.
98 changes: 98 additions & 0 deletions docs/user-guides/migrations/wildfly32.0/wildfly22.0/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2021 Red Hat, Inc.
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.jboss.migration</groupId>
<artifactId>jboss-server-migration-parent</artifactId>
<version>32.0.0.Final-SNAPSHOT</version>
<relativePath>../../../../../pom.xml</relativePath>
</parent>

<artifactId>jboss-server-migration-wildfly22.0-to-wildfly32.0-userguide</artifactId>

<name>JBoss Server Migration: User-Guide Wildfly 22.0 to Wildfly 32.0</name>

<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>jboss-server-migration-docs-userguide-migration-includes</artifactId>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/asciidoc</outputDirectory>
<resources>
<resource>
<directory>src/main/asciidoc</directory>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<id>unpack-includes</id>
<phase>generate-sources</phase>
<goals>
<goal>unpack-dependencies</goal>
</goals>
<configuration>
<outputDirectory>${project.build.directory}/asciidoc</outputDirectory>
<includeScope>compile</includeScope>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<executions>
<execution>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<sourceDocumentName>master.adoc</sourceDocumentName>
<outputFile>${project.build.outputDirectory}/index.html</outputFile>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
// setup of vars used by this and/or included docs
:server-source-productName: WildFly 22.0
:server-source-name: WildFly
:server-source-version: 22.0.0.Final
:server-source-baseDir: wildfly-22.0

:server-target-productName: WildFly 32.0
:server-target-name: WildFly
:server-target-version: 32.0.0.Final
:server-target-baseDir: wildfly-32.0

:includesDir: topics

// toc setup
:toc:
:numbered:

// include abstract
include::{includesDir}/ServerMigration.adoc[]

// customize
The server migration from {server-source-productName} to {server-target-productName} includes:

* Modules Migration
* Standalone Server Migration
* Managed Domain Migration

:leveloffset: +1

// --- modules migration

include::{includesDir}/ServerMigration-Modules.adoc[]

// --- standalone server migration

include::{includesDir}/ServerMigration-StandaloneServer.adoc[]

:leveloffset: +1

// ------ standalone server configuration migration

include::{includesDir}/ServerMigration-StandaloneServer-StandaloneServerConfiguration.adoc[]

:leveloffset: +1

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ServerConfiguration-MigrateJBossDomainProperties.adoc[]

include::{includesDir}/ServerMigration-ServerConfiguration-RemoveUnsupportedSubsystems.adoc[]

include::{includesDir}/ServerMigration-ServerConfiguration-MigrateReferencedModules.adoc[]

include::{includesDir}/ServerMigration-ServerConfiguration-MigrateReferencedPaths.adoc[]

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-StandaloneServerConfiguration-MigrateLegacySecurityRealms.adoc[]

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-StandaloneServerConfiguration-MigrateLegacySecurityDomains.adoc[]

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ServerConfiguration-Subsystem-Migrate-keycloak.adoc[]

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ServerConfiguration-Subsystem-Migrate-picketlink.adoc[]

:leveloffset: -1

:leveloffset: -1

// --- managed domain migration

include::{includesDir}/ServerMigration-ManagedDomain.adoc[]

// ------ domain configuration

:leveloffset: +1

include::{includesDir}/ServerMigration-ManagedDomain-DomainConfiguration.adoc[]

:leveloffset: +1

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ServerConfiguration-MigrateJBossDomainProperties.adoc[]

include::{includesDir}/ServerMigration-ServerConfiguration-RemoveUnsupportedSubsystems.adoc[]

include::{includesDir}/ServerMigration-ServerConfiguration-MigrateReferencedModules.adoc[]

include::{includesDir}/ServerMigration-ServerConfiguration-MigrateReferencedPaths.adoc[]

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ManagedDomain-DomainConfiguration-MigrateLegacySecurityRealms.adoc[]

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ManagedDomain-DomainConfiguration-MigrateLegacySecurityDomains.adoc[]

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ServerConfiguration-Subsystem-Migrate-keycloak.adoc[]

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ServerConfiguration-Subsystem-Migrate-picketlink.adoc[]

include::{includesDir}/ServerMigration-ManagedDomain-AddHostExcludes.adoc[]

:leveloffset: -1

// ------ host configuration

include::{includesDir}/ServerMigration-ManagedDomain-HostConfiguration.adoc[]

:leveloffset: +1

include::{includesDir}/WFLY22.0toWFLY32.0-ServerMigration-ServerConfiguration-MigrateJBossDomainProperties.adoc[]

include::{includesDir}/ServerMigration-ServerConfiguration-MigrateReferencedModules.adoc[]

include::{includesDir}/ServerMigration-ServerConfiguration-MigrateReferencedPaths.adoc[]

:leveloffset: -1

:leveloffset: -1

:leveloffset: -1
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
= Migrate Legacy Security Domains

{server-target-productName} does not supports the legacy Security Domains framework, and the tool migrates any usage of such resources to instead use the default {server-target-productName} Elytron replacements.

Please note that further manual Elytron configuration may be needed if the legacy Security Domain(s) being used were not the {server-source-productName}'s defaults!
The console logs all configuration resources migrated to the default {server-target-productName} Elytron replacements, for each configuration profile.
[source,options="nowrap"]
----
WARN Migrated ejb3 subsystem resource /profile/default/subsystem/ejb3/application-security-domain/other using legacy security domain other, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated undertow subsystem resource /profile/default/subsystem/undertow/application-security-domain/other using legacy security domain other, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated ejb3 subsystem resource /profile/full/subsystem/ejb3/application-security-domain/other using legacy security domain other, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated undertow subsystem resource /profile/full/subsystem/undertow/application-security-domain/other using legacy security domain other, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated messaging-activemq subsystem server resource /profile/full/subsystem/messaging-activemq/server/default, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated iiop-openjdk subsystem resource using legacy security domain to Elytron defaults. Please note that further manual Elytron configuration should be needed!
WARN Migrated ejb3 subsystem resource /profile/ha/subsystem/ejb3/application-security-domain/other using legacy security domain other, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated undertow subsystem resource /profile/ha/subsystem/undertow/application-security-domain/other using legacy security domain other, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated ejb3 subsystem resource /profile/full-ha/subsystem/ejb3/application-security-domain/other using legacy security domain other, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated undertow subsystem resource /profile/full-ha/subsystem/undertow/application-security-domain/other using legacy security domain other, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated messaging-activemq subsystem server resource /profile/full-ha/subsystem/messaging-activemq/server/default, to Elytron's default application Security Domain. Please note that further manual Elytron configuration may be needed if the legacy security domain being used was not the source server's default Application Domain configuration!
WARN Migrated iiop-openjdk subsystem resource using legacy security domain to Elytron defaults. Please note that further manual Elytron configuration should be needed!
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
= Migrate Legacy Security Realms

{server-target-productName} does not supports the legacy Security Realms framework, and the tool migrates any usage of such resources to instead use the default {server-target-productName} Elytron replacements.

Please note that further manual Elytron configuration may be needed if the legacy security realm(s) being used were not the {server-source-productName}'s defaults!
The console logs all configuration resources migrated to the default {server-target-productName} Elytron replacements, for each configuration profile.
[source,options="nowrap"]
----
INFO Legacy security XML configuration retrieved.
WARN Migrated Remoting subsystem's http connector resource /profile/full-ha/subsystem/remoting/http-connector/http-remoting-connector using a legacy security-realm, to Elytron's default application SASL Authentication Factory migration-defaultApplicationSaslAuthenticationFactory. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
WARN Migrated Undertow subsystem https-listener resource /profile/full-ha/subsystem/undertow/server/default-server/https-listener/https using a legacy security-realm, to Elytron's default TLS ServerSSLContext migration-defaultTLSServerSSLContext. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
WARN Migrated Undertow subsystem http-invoker resource /profile/full-ha/subsystem/undertow/server/default-server/host/default-host/setting/http-invoker using a legacy security-realm, to Elytron's default Application HTTP AuthenticationFactory migration-defaultApplicationHttpAuthenticationFactory. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
INFO Legacy security realms migrated to Elytron.
WARN Migrated Remoting subsystem's http connector resource /profile/full/subsystem/remoting/http-connector/http-remoting-connector using a legacy security-realm, to Elytron's default application SASL Authentication Factory migration-defaultApplicationSaslAuthenticationFactory. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
WARN Migrated Undertow subsystem https-listener resource /profile/full/subsystem/undertow/server/default-server/https-listener/https using a legacy security-realm, to Elytron's default TLS ServerSSLContext migration-defaultTLSServerSSLContext. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
WARN Migrated Undertow subsystem http-invoker resource /profile/full/subsystem/undertow/server/default-server/host/default-host/setting/http-invoker using a legacy security-realm, to Elytron's default Application HTTP AuthenticationFactory migration-defaultApplicationHttpAuthenticationFactory. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
INFO Legacy security realms migrated to Elytron.
WARN Migrated Remoting subsystem's http connector resource /profile/ha/subsystem/remoting/http-connector/http-remoting-connector using a legacy security-realm, to Elytron's default application SASL Authentication Factory migration-defaultApplicationSaslAuthenticationFactory. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
WARN Migrated Undertow subsystem https-listener resource /profile/ha/subsystem/undertow/server/default-server/https-listener/https using a legacy security-realm, to Elytron's default TLS ServerSSLContext migration-defaultTLSServerSSLContext. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
WARN Migrated Undertow subsystem http-invoker resource /profile/ha/subsystem/undertow/server/default-server/host/default-host/setting/http-invoker using a legacy security-realm, to Elytron's default Application HTTP AuthenticationFactory migration-defaultApplicationHttpAuthenticationFactory. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
INFO Legacy security realms migrated to Elytron.
WARN Migrated Remoting subsystem's http connector resource /profile/default/subsystem/remoting/http-connector/http-remoting-connector using a legacy security-realm, to Elytron's default application SASL Authentication Factory migration-defaultApplicationSaslAuthenticationFactory. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
WARN Migrated Undertow subsystem https-listener resource /profile/default/subsystem/undertow/server/default-server/https-listener/https using a legacy security-realm, to Elytron's default TLS ServerSSLContext migration-defaultTLSServerSSLContext. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
WARN Migrated Undertow subsystem http-invoker resource /profile/default/subsystem/undertow/server/default-server/host/default-host/setting/http-invoker using a legacy security-realm, to Elytron's default Application HTTP AuthenticationFactory migration-defaultApplicationHttpAuthenticationFactory. Please note that further manual Elytron configuration may be needed if the legacy security realm being used was not the source server's default Application Realm configuration!
INFO Legacy security realms migrated to Elytron.
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
= Migrate JBoss Domain Properties

The words `master` and `slave` on Domain related property names were replaced with the words 'primary' and 'secondary', and the migrates automatically fixes any usage of the old property names.

The console logs any properties renamed by the migration.

[source,options="nowrap"]
----
INFO JBoss domain property jboss.domain.master.address migrated to jboss.domain.primary.address
INFO JBoss domain property jboss.domain.master.port migrated to jboss.domain.primary.port
INFO JBoss domain property jboss.domain.master.protocol migrated to jboss.domain.primary.protocol
----

If any property was successfully renamed the following message will be logged.
[source,options="nowrap"]
----
INFO JBoss domain properties migrated.
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:subsystem-migrate-legacySubsystemName: keycloak
:subsystem-migrate-legacyExtensionName: org.keycloak.keycloak-adapter-subsystem
:subsystem-migrate-replacementSubsystemName: elytron-oidc-client

include::ServerMigration-ServerConfiguration-Subsystem-Migrate.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:subsystem-migrate-legacySubsystemName: picketlink-federation
:subsystem-migrate-legacyExtensionName: org.wildfly.extension.picketlink
:subsystem-migrate-replacementSubsystemName: keycloak-saml

include::ServerMigration-ServerConfiguration-Subsystem-Migrate.adoc[]
Loading

0 comments on commit 0e743e7

Please sign in to comment.