The JBoss Server Migration Tool is a tool that migrates JBoss Application Servers. It reads the server configurations files for a previous release of WildFly or JBoss EAP, referred to as the source server, and migrates them to the latest release or target server. Besides the configurations, the tool is also capable of migrating modules, deployments and other resources found in the source server.
- Java 8.0 (Java SDK 1.8) or later
- Apache Maven
-
Use the following command to build the tool from source:
mvn clean install
-
Navigate to the
dist/standalone/target/directory and unzip thejboss-server-migration-VERSION_NUMBER.zipfileunzip jboss-server-migration-33.0.0.Final-SNAPSHOT.zip -
Open a terminal and navigate to the
dist/standalone/target/jboss-server-migration/directory. -
Run the following command.
For Linux|Mac: ./jboss-server-migration.sh -s SOURCE_SERVER_PATH -t TARGET_SERVER_PATH For Windows: jboss-server-migration.bat -s SOURCE_SERVER_PATH -t TARGET_SERVER_PATHReplace
SOURCE_SERVER_PATHwith the path to previous version of the server installation that you want to migrate from, for example:${user.home}/wildfly-26.0.0.Final/Replace
TARGET_SERVER_PATHwith the path to current version of the server installation that you want the old configuration migrated to, for example:${user.home}/wildfly-31.0.0.Final/ -
When you execute the command, the tool identifies the source and target servers from provided paths, and starts the server migration.
---------------------------------------------------------- ---- JBoss Server Migration Tool ----------------------- ---------------------------------------------------------- Retrieving servers... INFO SOURCE server name: WildFly Full, version: 26.0.0.Final. INFO TARGET server name: WildFly Full, version: 33.0.0.Final-SNAPSHOT. ---------------------------------------------------------- ---------------------------------------------------------- Server migration starting... -
Each server migration consists of several migration tasks, which may require or not user interaction.
INFO --- Migrating modules requested by environment... INFO Module cmtool.module1:main migrated. INFO --- Migrating standalone server... INFO No source's standalone content found to migrate. INFO Source's standalone configurations found: [standalone.xml] INFO Migrating standalone configuration standalone.xml... INFO Subsystem infinispan updated. INFO Subsystem undertow updated. INFO Security realms migrated. INFO Non-persistent deployments found in standalone/deployments: [cmtool-helloworld5.war, cmtool-helloworld6.war] INFO Non-persistent deployment cmtool-helloworld5.war migrated. INFO Non-persistent deployment cmtool-helloworld6.war migrated. INFO --- Migrating managed domain... INFO No source's domain content found to migrate. INFO Source's domain configurations found: [domain.xml] INFO Migrating domain configuration domain.xml... INFO Subsystem infinispan updated. INFO Subsystem undertow updated. INFO Source's host configurations found: [host.xml] INFO Migrating host configuration host.xml... INFO Migrating host master... INFO Security realms migrated. -
Once the server migration is done a
Task Summaryreport will be shown, that summarizes the results of migration tasks. Server migration done.INFO ---------------------------------------------------------------------------------------------- Task Summary ---------------------------------------------------------------------------------------------- server .............................................................................. SUCCESS modules.migrate-modules-requested-by-user .......................................... SUCCESS modules.migrate-modules-requested-by-user.migrate-module(id=cmtool.module1:main) .. SUCCESS standalone ......................................................................... SUCCESS standalone-configurations ......................................................... SUCCESS standalone-configuration(source=standalone.xml) .................................. SUCCESS domain ............................................................................. SUCCESS domain-configurations ............................................................. SUCCESS domain-configuration(source=domain.xml) .......................................... SUCCESS host-configurations ............................................................... SUCCESS host-configuration(source=host.xml) .............................................. SUCCESS -
You should see the following message when it completes.
---------------------------------------------------------------------------------------------- Migration Result: SUCCESS ---------------------------------------------------------------------------------------------- -
Additional reports may be found in the
reports/directory.
migration-report.html: The HTML report is a nicely formatted report showing the detailed results of the migration.migration-report.xml: The XML file includes all migration data collected.
- File log(s) may be found in the
logs/directory.
migration.log: The log contains detailed information about the server migration execution.
- Migration Failed Error
- If you get an error message telling you that the migration failed because of version Y not supporting migrations from version X please refer to the Releases section to see which version of the Migration Tool you need for migrating your versions. For example you cannot use the Migration Tool 1.11.0 Final for migrating WildFly 16.0.0 to WildFly 22.0.0. For that you require the Migration Tool Version 1.10.0 Final.
All new features and enhancements should be submitted to master branch. Our contribution guide will guide you through the steps for getting started on the project and will go through how to format and submit your first PR.
If you would like to ask us some question or you need some help, feel free to ask on the WildFly user forum.