mvn clean install
Migrating an existing application server configuration to a new version is a complex task. It requires that the user completely understand how the server is currently configured and what has changed in the target release. The user generally must copy and edit several configuration files to make the updates needed to keep the same behavior in the new release. If it is not done correctly, the new server does not work as expected,often because some functionality is not supported by the new server. The JBoss Server Migration Tool is an application that migrates JBoss EAP and WildFly server configurations on behalf of the users, with minimal interaction required.
The JBoss Server Migration Tool is a Java standalone application. It requires Java version 7 or later.
It is recommended that you start the tool using the provided .sh (Linux, Mac OS) and .bat (Windows) scripts.
The JBoss Server Migration Tool ZIP archive can be downloaded from https://github.com/wildfly/wildfly-server-migration/releases.Simply unzip the archive into a directory of your choice. No further setup is needed.
The JBoss Server Migration Tool source code is open source. Its repository is located at https://github.com/wildfly/wildfly-server-migration
Apache Maven 3.x is required to build the application from code. To build the tool, open a terminal and navigate to the root of the project and type:
mvn clean install
The build process creates a ZIP archive in the build/target/ directory containing the tool. As with the downloaded binary distribution, unzip the ZIP archive into the directory of your choice.
The JBoss Server Migration Tool is started in a terminal using the script provided. This is the server-migration.sh file for Linux or the server-migration.bat file for Windows.
You must provide the following arguments when you execute the script:
---source <server-from-path>
---target <server-to-path>
Replace <server-from-path> with the path to the server you are migrating from.
Replace <server-to-path> with the path to the server you are migrating to.
The paths should be absolute paths or relative to the current directory.
For example, if the source server base directory relative path is ../jboss-eap-6.4 and the target server base directory relative path is ../jboss-eap-7.0, execute the following command to migrate the server configuration:
./server-migration.sh --source ../jboss-eap-6.4 --target ../jboss-eap-7.0
NOTE: If no arguments are provided, the tool prints usage instructions and provides a list of supported arguments.
The JBoss Server Migration Tool supports running in either interactive or non-interactive mode. By default, the tool is executed in interactive mode and may ask the user for some input. To use predefined behaviors and run in non-interactive mode, you must specify the following argument:
---interactive <true or false>
NOTE: Non-interactive mode predefined behavior is specific to each supported server migration and is described in more detail in the related sections of this document.
The tool uses the JBoss Logging framework to log the migration progress. Results are written to the Java console and also to a file named migration.log, which is located in the current user directory. This log file is created if it doesn't exist and its content is overwritten on each subsequent execution of the tool.
The logging configuration is provided by the config/logging.properties file.The user can modify the configuration file or specify an alternative logging configuration file but specifying the following system property:
-Dlogging.configuration=file:<absolute-path-to-alternative-logging-configuration-file>
Upon execution, the tool scans the specified source and target server base directories to identify each server. It then delegates the migration process to the target server.
---------------------------------------------------------- ---- JBoss Server Migration Tool ----------------------- ---------------------------------------------------------- Retrieving servers... 15:11:33,844 INFO [org.wildfly.migration.core.logger] (main) SOURCE server name: EAP, version: 6.4.0.Final. 15:11:33,859 INFO [org.wildfly.migration.core.logger] (main) TARGET server name: EAP, version: 7.0.0.Final.
Note that this is a fully automated process. The tool execution will fail if a server is not recognized or if the target server does not support migration from the specified source server.
The Server Migration Tool includes support for the following server migrations, each with its own User Guide: