Table of Contents Previous Next Index

Section 23 Moving a LISTSERV Maestro Installation

Section 23 Moving a LISTSERV Maestro Installation
Sometimes it is necessary to replace the hardware on which a LISTSERV Maestro instance is installed, or to move a LISTSERV Maestro installation from one server to another. This section describes how to do this for the following LISTSERV Maestro installation types:
All LISTSERV Maestro components are installed on the same server and an external system database is used, which is either also running on the same server, or is running on a different server.
Therefore, as long as LISTSERV Maestro is installed with all components on the same server (not counting the system database, which may also be on a different server), then this section describes how to replace or move this LISTSERV Maestro instance.
If however the LISTSERV Maestro components are distributed over several servers, and the components are to be moved separately, then please see Section 24.2 Moving Components to another Server.
The exact procedure that you need to follow to replace or move a server depends on what exactly you want to accomplish and if the internal or an external system database is being used. The following subsections describe various possible scenarios. Find the scenario that matches your situation and follow the procedure described in that section.
Notes: The procedures only describe how to either replace the server hardware of an existing LISTSERV Maestro installation, or how to move an existing LISTSERV Maestro installation from one server to another.
It is not possible to clone an existing LISTSERV Maestro installation, i.e. to create a copy of an installation that contains the same data as the original installation, while having both installations running in parallel.
Therefore, the following scenario, for example, is not possible: Server A is running a LISTSERV Maestro installation. This installation is cloned to server B, so that server B now runs a LISTSERV Maestro installation with the same data. Server A continues to run too, for the time being, while the new installation on server B is being tested, to see if everything is working smoothly. Once this has been validated, server A is shut down (and uninstalled) and server B takes over its operation. This scenario is not only impossible because of technical reasons, but also because it does not make sense from an operational point of view either: During the time when both servers are running in parallel, server A would still be the "main" server, and server B would only be a copy that is currently undergoing verification. However, any data changes that happen on server A after the copying (while it is still the "main" server) would never be seen by server B. This includes jobs that are being created, delivered, or otherwise changed during this time, plus tracking events that arrive at server A during this time (or later). When the testing of server B would finally be complete and B would be ready to "take over" from server A, the data on B would already be outdated in comparison to A, with no way to consolidate the two again. Therefore, it does not make sense to keep A running while the installation on B is being verified. But if A is shut down anyway at the moment the installation is moved to B, it is no longer a clone/copy operation, but instead either a replacement or move operation, as described below.
23.1 Server Replacement
Scenario: Replacing the LISTSERV Maestro Server with a New Server
The old LISTSERV Maestro server will be replaced with a new server. After the procedure, the LISTSERV Maestro installation will run on the new server, which will use the same host name as was previously used by the old server (possibly even the same IP-address), and the old server is either decommissioned or is used for other purposes, with a different host name (and possibly different IP-address).
This scenario, for example, applies if for some reason the old server hardware is getting old and a possible breakdown will be avoided, or the old hardware can no longer cope with the increased demands, so a new server with better hardware will replace it.
Note: With this scenario, LISTSERV Maestro will never be running in parallel on the two servers.
To perform such a server replacement, do the following:
1.
Important: If the backup fails with errors, then do not proceed! Resolve the errors first, then trigger another backup. Only proceed with a successful backup!
2.
3.
Do not start the old LISTSERV Maestro installation again while performing the rest of the procedure! Remember that LISTSERV Maestro can also be restarted automatically as a service (Windows) or daemon process (Unix/Linux), if the server computer is restarted. This must also be avoided!
4.
If you are planning to still use the old server after the procedure, for other purposes and with a new hostname (and possibly IP-address), then change the hostname/IP-address of the old server now.
If you are planning to decommission the old server and not use it anymore, then you still need to temporarily change its hostname (and possibly IP-address) at this point, to a temporary hostname/IP-address.
Note: Changing the hostname may also require a DNS-mapping entry for the new hostname.
5.
Configure the new server to use the hostname (and possibly IP-address) that previously was used by the old server. Also, check the DNS-mapping of that hostname to make sure that it points to the IP-address that is now used by the new server.
6.
If LISTSERV Maestro is configured to use an external database, and this external database was also installed on the old server, then you need to install a new external database on the new server too.
This step is not necessary if LISTSERV Maestro uses the internal database or if it uses an external database on some altogether different server (not the old server). In these cases, skip to the next step.
But, if the external database was used and it was installed on the old server, then now you need to install the same database software also on the new server. In this database software, create a new system database (or database schema), with the same name, user account (including password and access rights), and other configurations as was previously used by the system database on the old server. If necessary, check the configuration of the system database on the old server. (See Section 10.2 Preparing the System Database.
7.
Install LISTSERV Maestro on the new server. Install either the same or a newer version than was installed on the old server. (Do not install an older version/build!)
If possible, install into a folder with the same name and path as on the old server (on Windows also on the same drive). This is not strictly necessary, but makes the rest of the procedure easier.
8.
If the old LISTSERV Maestro installation also included a LISTSERV installation on the old server, then you need to include LISTSERV in the installation on the new server too. In this case, you also need to transfer all the LISTSERV data from the old server to the new server (see the LISTSERV manuals for how to do this).
9.
If you want to retain the log file history (recommended) then copy the log files from the old server to the new server. Log files are stored in three different folders. Copy them from each folder on the old server to the corresponding folder on the new server:
[maestro_install_folder]/hub/logs
[maestro_install_folder]/lui/logs
[maestro_install_folder]/trk/logs
10.
If you have added any additional content to the webapps folder of the installation on the old server, as described in Section 26 Adding Content to the Tomcat Server, then copy this content to the webapps folder of the installation on the new server.
Similarly, if you have any other custom content or custom folders in the LISTSERV Maestro installation folder on the old server, then copy it to suitable locations on the new server.
11.
Locate the backup that you saved in step 1 (on the old server) and restore it into the fresh LISTSERV Maestro installation on the new server. For details, See Section 11.7 Restoring a Backup.
Restoring the backup also includes the step of starting LISTSERV Maestro on the new server.
12.
If the new LISTSERV Maestro instance on the new server was installed into a different folder than on the old server (or on Windows onto a different drive), then login to the Administration Hub and check all settings that may contain folder paths, and if necessary change them to the correct path/drive-letter for the new installation location (changes do not require a restart):
Backup Folders: Under Global Settings > Administration Hub/Maestro User Interface/Maestro Tracker > General Administration (check for each of the three components!).
Content Upload Restrictions: Under Global Settings > Maestro User Interface > Default Content Restrictions. Also, check for any overrides on account or group level under User Account/Group > Content Restrictions (for all non-group accounts and all groups).
Recipient Upload Restrictions: Under Global Settings > Maestro User Interface > Default Recipients Restrictions. Also check for any overrides on account or group level under User Account/Group > Recipients Restrictions (for all non-group accounts and all groups).
Hosted Data Import Restrictions: Under Global Settings > Maestro User Interface > Default Hosted Data Settings. Also check for any overrides on account or group level under User Account/Group > Hosted Data Settings (for all non-group accounts and all groups).
13.
Once LISTSERV Maestro is running properly on the new server, with the backup restored, login to the Administration Hub on the new server and go to Global Settings > Maestro User Interface > General Administration and unselect the Outbox: Sending is disabled and Login Access: LISTSERV Maestro User Interface is locked checkboxes. Click [OK] to submit your changes.
Important: Once you have verified that LISTSERV Maestro is running properly on the new server, make sure to uninstall the old LISTSERV Maestro installation on the old server.
If desired, you can first make a backup of the LISTSERV Maestro installation folder on the old server before you uninstall it (by doing a simple file system copy of the whole installation folder), but you must uninstall it in any case.
14.
23.2 Moving a LISTSERV Maestro Installation
Scenario: Moving LISTSERV Maestro Installation From Old Server to New Server
The LISTSERV Maestro installation will be moved from the old server to a new server. The new server will use a different host name (and IP-address) than the old server and the old server will continue to use its original hostname (and IP-address).
This scenario, for example, applies if for some reason the installation must be moved to a new server, but for other purposes, the old server must remain operational with the same host name as before, only now without a LISTSERV Maestro installation on it.
Note: With this scenario, LISTSERV Maestro will never be running in parallel on the two servers.
Important: Moving a LISTSERV Maestro installation to a server with a different hostname is not a good idea and should be avoided, unless absolutely necessary.
The reason for this is the following: When LISTSERV Maestro sends out e-mails with tracked links, then the URLs of these tracked links point back to the LISTSERV Maestro server, using the server's hostname. But, if LISTSERV Maestro's hostname is changed (which would be the case if the LISTSERV Maestro installation is moved to a server with a different name), then all the already delivered e-mails still contain tracking links that point to the old hostname. Only now there is no LISTSERV Maestro installation with that hostname anymore. This has an effect both on the recipients of the already delivered messages and on the LISTSERV Maestro user who owns the mail jobs for these messages:
Negative effect for the recipients – All tracked links in all e-mails that were delivered before the server was moved cease to function. If a recipient clicks one of these links, then instead of seeing the intended target page, he will see a "server not found" message (or similar).
Negative effect for the LISTSERV Maestro user – Since the tracked links cease to function, no tracking events for these links will reach LISTSERV Maestro. Therefore, all mail jobs that were delivered before the server was moved will no longer receive any new tracking events. Their tracking data will appear "frozen" in the state that it had at the moment the server was moved.
Mail jobs that are delivered after the server was moved are not affected by this.
Therefore, unless the negative effects described above are acceptable in your situation, you should never move a LISTSERV Maestro installation to a server with a new name. If you have to move to a new server, then consider if it is not possible to also "move" the hostname from the old server to the new server. I.e. assign a new hostname to the old server and assign the old hostname to the new server (possibly as an alias, if the new server already had a different hostname before). If you can find a way to also "move" the hostname to the new server, then you are no longer dealing with "moving" a LISTSERV Maestro installation, as described in this section, but instead you are dealing with a "server replacement". In this case, please see Section 23.1 Server Replacement for details.
But if you have decided that you do indeed want to move a LISTSERV Maestro installation to a new server, with a new hostname, in spite of the negative effects that this has, then follow theses steps:
1.
Important: If the backup fails with errors, then do not proceed! Resolve the errors first, then trigger another backup. Only proceed with a successful backup!
2.
3.
Do not start the old LISTSERV Maestro installation again while performing the rest of the procedure! Remember that LISTSERV Maestro can also be restarted automatically as a service (Windows) or daemon process (Unix/Linux), if the server computer is restarted. This must also be avoided!
4.
Install LISTSERV Maestro on the new server. Install either the same or a newer version than was installed on the old server. (Do not install an older version/build!)
If possible, install into a folder with the same name and path as on the old server (on Windows also on the same drive). This is not strictly necessary, but makes the rest of the procedure easier.
5.
If you want to retain the log file history (recommended) then copy the log files from the old server to the new server. Log files are stored in three different folders. Copy them from each folder on the old server to the corresponding folder on the new server:
[maestro_install_folder]/hub/logs
[maestro_install_folder]/lui/logs
[maestro_install_folder]/trk/logs
6.
If you have added any additional content to the webapps folder of the installation on the old server, as described in Section 26 Adding Content to the Tomcat Server, then copy this content to the webapps folder of the installation on the new server.
Similarly, if you have any other custom content or custom folders in the LISTSERV Maestro installation folder on the old server, then copy it to suitable locations on the new server.
7.
Locate the backup that you saved in step 1 (on the old server) and restore it into the fresh LISTSERV Maestro installation on the new server. For details, See Section 11.7 Restoring a Backup.
Restoring the backup also includes the step of starting LISTSERV Maestro on the new server.
8.
Since you have restored the backup on a server with a different hostname, make sure to go through all configuration settings and adjust them to use the new hostname.
Login to the Administration Hub and check the URL settings (changes do not require a restart) under Global Settings >Maestro User Interface > Default URL Settings. Also check for any overrides on account or group level under User Account/Group > URL Settings (for all non-group accounts and all groups).
9.
If the new LISTSERV Maestro instance on the new server was installed into a different folder than on the old server (or on Windows onto a different drive), then login to the Administration Hub and check all settings that may contain folder paths, and if necessary, change them to the correct path/drive-letter for the new installation location (changes do not require a restart):
Backup Folders: Under Global Settings > Administration Hub/Maestro User Interface/Maestro Tracker > General Administration (check for each of the three components!).
Content Upload Restrictions: Under Global Settings > Maestro User Interface > Default Content Restrictions. Also, check for any overrides on account or group level under User Account/Group > Content Restrictions (for all non-group accounts and all groups).
Recipient Upload Restrictions: Under Global Settings > Maestro User Interface > Default Recipients Restrictions. Also check for any overrides on account or group level under User Account/Group > Recipients Restrictions (for all non-group accounts and all groups).
Hosted Data Import Restrictions: Under Global Settings > Maestro User Interface > Default Hosted Data Settings. Also check for any overrides on account or group level under User Account/Group > Hosted Data Settings (for all non-group accounts and all groups).
10.
Once LISTSERV Maestro is running properly on the new server, with the backup restored, login to the Administration Hub on the new server and go to Global Settings > Maestro User Interface > General Administration and unselect the Outbox: Sending is disabled and Login Access: LISTSERV Maestro User Interface is locked checkboxes. Click [OK] to submit your changes.
Important: Once you have verified that LISTSERV Maestro is running properly on the new server, make sure to uninstall the old LISTSERV Maestro installation on the old server.
If desired, you can first make a backup of the LISTSERV Maestro installation folder on the old server before you uninstall it (by doing a simple file system copy of the whole installation folder), but you must uninstall it in any case.
11.
23.3 Preparation for Replacing/Moving: Saving a Backup
The replacement/moving procedures described in the previous sections require you to perform a safe backup as their first step. The procedure on how to do this safe backup is described here:
1.
2.
Go to Global Settings > Maestro User Interface > General Administration.
3.
Select the Outbox: Sending is disabled checkbox.
4.
Select the Login Access: LISTSERV Maestro User Interface is locked checkbox.
5.
Click [OK].
6.
Click on the Switch to LUI link at the top of the screen to go to User Interface.
7.
Go to Mail Job > Mail Jobs Overview.
8.
Select the Jobs In System tab.
9.
Click on the Display the jobs owned by drop-down menu and select <Any Owner>.
10.
Select the Ongoing Jobs sub-tab.
11.
Verify that the job list on this sub-tab is either empty, or if there are any jobs remaining, that none of them are "being processed". The "being processed" state is shown with the yellow-arrows icon in the State column at the right. Any job that is still in the list must either be in the "authorized" state (clock icon) or "failed" state (red-X icon).
If there are still jobs in the "being processed" state, then wait for these jobs to be completed: If they are completed successfully, they will be removed from this list. If they fail, they will change into the "failed" state on this list.
While there are still jobs "being processed", refresh the list regularly until all jobs are either gone or only "failed" and "authorized" jobs remain.
12.
Once there are no jobs "being processed" anymore, use the Switch to HUB link at the top of the screen to go back to the HUB.
13.
Go to Global Settings > Administration Hub > General Administration.
14.
Click the [Execute Backup Now] button.
15.
16.
Now you need to wait for the backup to complete. To find out if the backup is complete, monitor the most recent log file of the Administration Hub. This file is located in the following folder:
[maestro_install_folder]/hub/logs
The name of the log file is similar to "HUB-YYYYMMDD.log" where YYYYMMDD is the date of the current day (in order "year month day").
Open this log file and check the most recent entries at the end of the log. You should see entries which say that a backup was started and that the backup is running.
Once the backup is complete, you will see a message like the following (with a matching date and time):
Final completion date: Fri Apr 16 00:01:01 CEST 2010
The backup was completed successfully
You may have to reopen/refresh the log file several times until you see this message appear. Be patient - especially if you have a larger LISTSERV Maestro installation, the backup may take a while.
17.
Once you see the above message you know that the backup has completed successfully. The backup will have been stored in the most recent backup folders. There is a backup folder for each of the components LUI, HUB, and TRK, so the full backup consists of the contents of all three backup folders of these components.
18.
You now have performed a successful "safe backup" and can go back to the replacement/moving procedure that you were originally executing.