This article describes the steps for migrating an Elvis Server 4 environment to an Elvis Server 5 environment. This is done by installing Elvis Server 5 and migrating the Elvis 4 content and configuration settings to Elvis 5.
Before you start
Take note of the following:
- The lowest version of Elvis 4 that can be migrated from is Elvis 4.1. If you are running Elvis 4.0 or lower, please upgrade to 4.1 first and then complete the migration.
- The installation of a new Elvis 5 server is also considered to be part of the migration process.
- The lowest version of Elvis 5 which can be migrated to is Elvis 5.1.1.
- It is recommended to upgrade to the most recent version of Elvis 5 available.
- Migrating a multi-volume storage to Elvis 5 requires the Migration tool version 1.1.24 (available since Elvis 5.24) or higher.
- It is not possible to migrate without a certain amount of downtime. Beware that no write actions should be performed on the Elvis 4 system once the migration has started. Make the Elvis 4 system read-only or completely disable access.
- Creating a dump file can potentially take a long time (sometimes more than a day), mainly depending on the number of assets and statistics. Please allow sufficient time in your upgrade schedule for creating this file.
- It is not possible to do incremental migrations. In case of copying large amounts of files, we do however recommend to use rsync to prepare the copy step in advance.
-
Make sure that the Migration Tool is installed.
Prioritizing data migration
Info: This feature requires the Migration Tool version 1.1.25 (shipped with Elvis 5.27) or higher.
Migrating Elvis 4 data to Elvis 5 can take a long time, depending on the available assets and indices. This also means that it can take a long time before the Elvis 5 system is ready for use.
To have a working Elvis 5 system available in the shortest amount of time, 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 process; it is therefore not needed to wait for the full process to be completed before the system can be used.
Import order
The following overview shows which parts of Elvis 5 become available after specific import processes are completed.
Essentials for users. When the following processes are completed, users can log in:
- Rules
- Permissions
- Saved Searches
- Rendition Presets
- Profiles
- Perspectives
- Auth keys (Share links)
Assets. When the following processes are completed, the system is available for use.
- Folders
- First priority assets
- Rest of the assets
- Versions
- Relations
Note: Versions and Relations are added after all assets have been migrated.
Statistics. When the following processes are completed, statistics are available:
- Usage
- Search
- Activity
Asset and Version files. When the following processes are completed, the full system is available.
Note: These processes run parallel with the above mentioned processes; the process of moving or copying assets will run as soon as the import is started at the same time the index is populated.
- First priority asset files
- Rest of asset files
- Version files
Migration steps
Migrating Elvis 4 to Elvis 5 is split into the following scenarios:
Step 1. Back up all your Elvis 4 data:
- Your <elvis server>/Config folder
- Your <elvis server>/Elvis Hot Data folder
- Your <elvis server>/Elvis Data folder
- Optional: your launch configuration (MacOSX/Linux). On Linux this is /srv/elvis-server/app/wrapper/conf/wrapper.conf, on MacOSX this is /Library/LaunchDaemons/com.dutchsoftware.elvis.server.launchd.plist.
Step 2. Create a dump of your Elvis 4 data.
Step 3. Uninstall Elvis 4 and make sure to select the option 'Also remove the configuration files' (available in the uninstaller on Windows and Mac).
Step 4. Install Elvis 5.
Step 5. Migrate the Elvis 4 configuration to Elvis 5.
Step 6. Run Elvis 5.
Step 7. Import the Elvis 4 content into Elvis 5.
Step 8. Validate the migration by performing some regular actions in Elvis 5.
Step 9. Run the Relations Upgrade tool to rebuild Collections and fix broken asset relations (requires Elvis 5.20 or higher) by doing the following:
Step 9a. Access the Elvis Server admin pages and click Upgrade Node/cluster.
Step 9b. Click Relations upgrade and follow the progress onscreen.
If the process fails, please contact WoodWing Support (customers should do this via their WoodWing Partner).
Step 10. Remove the old Elvis 4 data folders.
Step 11. (Optional) Remove Java from the system:
- Mac OS X / Linux: run the following command:
sudo yum remove java
- Windows: Run the uninstaller.
Tip: Because transferring your assets to the new server will probably take a long time, make sure that this process is completed before starting the migration process. When it is time to start the migration you can then transfer what has been changed or added in the meantime.
Step 1. Create a dump of your Elvis 4 data.
Step 2. Copy all your Elvis 4 data to the new server:
- Your <elvis server>/Config folder
- Your <elvis server>/Elvis Hot Data folder
- Your <elvis server>/Elvis Data folder
- Optional: your launch configuration (MacOSX/Linux). On Linux this is /srv/elvis-server/app/wrapper/conf/wrapper.conf, on MacOSX this is /Library/LaunchDaemons/com.dutchsoftware.elvis.server.launchd.plist.
Step 3. Transfer the dump folder that was created in Step 1 to the new server.
Note: When setting up multiple Elvis 5 nodes, place the file in a shared folder.
Step 4. Install Elvis 5.
Step 5. Migrate the Elvis 4 configuration to Elvis 5.
Step 6. Run Elvis 5.
Step 7. Import the Elvis 4 content into Elvis 5.
Step 8. Validate the migration by performing some regular actions in Elvis 5.
Step 9. Run the Relations Upgrade tool to rebuild Collections and fix broken asset relations (requires Elvis 5.20 or higher) by doing the following:
Step 9a. Access the Elvis Server admin pages and click Upgrade Node/cluster.
Step 9b. Click Relations upgrade and follow the progress onscreen.
Note: If the process fails, please contact WoodWing Support (customers should do this via their WoodWing Partner).
Step 10. Uninstall Elvis 4.
Step 11. (Optional) Remove old Elvis 4 data folders from your 'old' server.
Step 12. (Optional) Remove Java from the system:
- Mac OS X / Linux: run the following command:
sudo yum remove java
- Windows: Run the uninstaller.
Note: Some steps are explained in separate articles; when completing these steps, return to this article that you are reading now.
Rollback
- If the migration failed or got interrupted for some reason, perform a rollback by removing your Elvis 5 installation and (in case a single server was used) installing Elvis 4 followed by applying your backup.
- If the migration failed after a data import, the Elvis 4 files may have moved. In this case, use the Rollback feature of the Migration tool to move your files back to your Elvis 4 installation.
Document history
- 3 July 2018: Updated section 'Migration steps' by adding a link to Installing the Elvis Migration Tool.
Comment
Do you have corrections or additional information about this article? Leave a comment! Do you have a question about what is described in this article? Please contact Support.
1 comment
There is a partner enablement session about this subject: https://helpcenter.woodwing.com/hc/en-us/articles/208264766-2016-03-31-Migration-to-Elvis-5-On-Premise
Please sign in to leave a comment.