Logo Help Center

Creating an Elvis 4 dump for migration to Elvis 5

Creating an Elvis 4 dump for migration to Elvis 5

As part of the migration of content from Elvis 4 to Elvis 5 a dump needs to be created, describing the locations of files in the Elvis 4 storage.

This article explains how to create this.

Notes:

  • The dump will only contain references to where in the Elvis 4 storage files are stored; it will not contain the actual files.
  • Creating a dump file can potentially take a long time (sometimes more than a day), mainly depending on the number of available assets and statistics. Please allow sufficient time in your upgrade schedule for creating this file.
  • It is possible to prioritize data migration by specifying which data to migrate first. This will typically be the data needed for Production. All other data (typically archived data) will then be migrated at the end of the migration process. As a result, parts of the Elvis 5 system will become available for use during the migration; it is therefore not needed to wait for the full process to be completed before the system can be used. (This feature requires the Migration Tool version 1.1.25 (shipped with Elvis 5.27) or higher.) For more information, see Migrating Elvis 4 to Elvis 5.

Before you start

Step 1. Install the Java SE Development Kit 8u45 in order to run the Migration tool.

Step 2. Stop Elvis 4 server.

Step 3. Prepare free space for creating the dump.

Note: The size of the dump can be quite large, depending on the available Elvis 4 data. As a general reference, calculate the needed space in one of the following ways:

  • Use 500MB per million assets (example: 2 million assets will require 1GB of space)
  • Add the index file size (Elvis Hot Data/index) to the database file size (Elvis Hot Data/dstore)

Creating the dump

Step 1. Download the latest version of the Migration tool from the software download page and unzip it somewhere on the system.

Step 2. Run the Migration tool by entering the following in the command line:

  • For Mac OS X:  sudo java -jar elvis-migration-tool-x.x.x.jar
  • For Linux: sudo -u elvissrv java -jar elvis-migration-tool-x.x.x.jar
  • For Windows: java -jar c:\elvis-migration-tool-x.x.x.jar

Note: The default port for the tool is 8080. To change the port, use the 'server.port' command line option:

  • For Mac OS X and Linux: sudo java -jar elvis-migration-tool-x.x.x.jar --server.port=8181
  • For Windows: java -jar c:\elvis-migration-tool-x.x.x.jar --server.port=8181

Step 3. Access the Migration tool by entering the following URL in a Web browser:

http://localhost:8080/

Note: Make sure that the port number corresponds to the one that was specified in your command line.

The Export tab

Step 4. In the Export tab enter the following details:

  • Application folder. The location where Elvis 4 is installed.

Note: This field is pre-filled with the location of a default Elvis 4 installation, based on the operating system.

  • Source folder. The location where Elvis configuration and data folder are stored.

Note: This field is pre-filled with the default location, based on the operating system.

  • Destination folder. The location where the dump will be created.

Example:

  • Mac OS: /Volumes/Elvis Data/dumps
  • Linux: /Volumes/Elvis Data/dumps
  • Windows: D:\Elvis Data\dumps
  • Priority zones.Optional list of comma-separated folderPaths in Elvis from which assets and index entries need to be migrated first. Use this when migration of important data (such as from production) needs to be prioritized while other data (such as from archive) can be migrated at the end of the migration process. (Example: /Users,/Production/Brand).

Info: This feature requires the Migration Tool version 1.1.25 (shipped with Elvis 5.27) or higher.

  • Same server migration. Select this option when you are going to install Elvis 5 on the same system as Elvis 4.

Note: When this option is selected, absolute paths will be used during the storage move.

Step 5. Click Start dump creation to create the dump.

Progress bars appear to indicate the progress of various steps of the process.

Progress bars in the Migration tool

Step 6. After the process is completed, click Close.

Step 7. Verify that the dump has been created by accessing the "Destination folder". It should contain a folder with a name starting with 'elvis-dump' and it should itself contain various folders with content.

Example of a created dump

Continue the migration process

Return to Migrating Elvis 4 to Elvis 5 and continue with the next steps.

Document history

  • 4 July 2017: Updated section 'Creating the dump' with the 'Priority zones' option.
Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

2 Comments

Please sign in to leave a comment.