Migrating the Elvis 4 configuration to Elvis 6

As part of the migration of content from Elvis 4 to Elvis 6 the Elvis 4 configuration needs to be moved to Elvis 6.

This article explains how to create this.

Notes: Changing the config files is normally only done through the Admin config page (with the exception of the node-config.properties.txt file). However, because Elvis 6 is not running yet, we will change files directly on the file system. Some steps are explained in separate articles; when completing these steps, return to this article that you are reading now.

Before you start

Make sure that you:

• Have (a backup of) your Elvis 4 configuration.
• Have installed a clean Elvis 6 server.
• Did not run or start your Elvis 6 server yet.

Note: If the Elvis 6 server was started, Elasticsearch indices have been created without your custom-assetinfo file. In this case you need to re-index your asset index before importing your migration dumps from Elvis 4 (this means: after finishing all the steps on this page).

1. Migrating configuration files

Step 1. Copy and replace the following files and folders from your Elvis 4 configuration to the Config folder of your Elvis 6 server:

• -crossdomain.xml file
• custom-assetinfo.xml file
• internal-users.properties.txt file
• ldap-config.properties.txt file
• messages folder
• sce_export folder
• taxonomies folder
• xml_previews folder
• xsl folder

Step 2. (Optional, only if you are migrating from Elvis 4.6.5 or lower). The ROLE_EMAIL option of Elvis 4 has been split into ROLE_SHARE, ROLE_SHARE_UPLOAD, and ROLE_SHARE_APPROVE since Elvis 4.6.6. Open the internal-users.properties.txt file and set these options accordingly.

Step 3. The config.properties file of Elvis 4 has been split into 2 files in Elvis 6:

1. node-config.properties.txt for configuring node level properties
2. cluster-config.properties.txt for configuring cluster level properties

Follow the steps on Changing the Elvis 6 Server configuration for a running cluster to set up both files.

2. Migrating plug-ins

Step 1. Copy your plug-in files and folder directly into the Confg/plugins folder of Elvis 6.

Note: It is important that plug-ins are copied to all nodes in the cluster.

Step 2. Some plug-ins have been made obsolete, make sure that these are removed from the plug-ins folder:

• backup plug-in
• metadata import plug-in
• sce import plug-in

Note: Scheduled plug-ins will be executed on any cluster node that is configured as a Job Runner node, as configured during the installation of Elvis 6. Plug-ins which need to access shared resources (such as a folder for import and a Hot folder for monitoring) should be configured to use the shared folder. See the description of the sharedDataLocation in the node-config.properties.txt.

3. Multi-volume storage

Because Elvis 6 supports multi-volume storage in a different way than Elvis 4, your volume-config.xml file does not need to be migrated.

4. Launch config

(Optional) Apply your Elvis 4 launch config by moving it to:

/etc/init.d/elvis-server

5. Re-indexing assets

(Optional) If the Elvis 6 server was started before all configuration steps were set, Elasticsearch indices have been created without your custom-assetinfo file. In this case you need to re-index your asset index before importing your migration dumps from Elvis 4 (this means: after finishing all the steps on this page).

6. Configuring multiple nodes

At this point you will have configured a single Elvis 6 node (server). If you have more nodes to configure, there are several ways to do this:

• When using virtual machines, just start new ones from this image.

Note: Do not forget that you still need to adjust the node-config.properties.txt file for every node separately (for example: changing node names and/or subsystems).

• When installing Elvis 6 on the other nodes, then just copy the Elvis 6 configuration you just created from this node to the other installations.

Note: Do not forget that you still need to adjust the node-config.properties.txt file for every node separately (for example: changing node names and/or subsystems).

• Start the Elvis 6 node as a 1-node-cluster. The cluster will upload your configuration to Elasticsearch and new nodes will automatically download the configuration from that location. You can then install and set up Elvis 6 with a minimal configuration on the other nodes and connect them to this cluster at a later stage. You can even wait until after the migration is done before adding your other nodes.

Warning: Plug-ins are not synchronized in this manner, see 2. Migrating plug-ins above if you want to use non-default plug-ins.

• Follow all the steps in this document again for your other nodes. However, this is not recommended because it is more open to mistakes (inconsistent configuration) than the other options.

7. Continue the migration process

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