Congratulations! You finally have the go ahead from Management to expand your Logscape environment. You need to scale up from a few test machines to a larger environment. Unfortunately, you ran your proof of concept from Steve’s Dev machine. Or perhaps you underestimated the volume of data and urgently need faster disks to improve performance. You’re going to need to migrate your Logscape Manager to a new server, which is precisely why you’re reading this guide…
Preparation – What you will need:
Source Manager: The manager you are migrating from.
Target Manager: The manager you are migrating to.
LDAP Credentials (Optional but recommended)
SSL Certificates and Credentials (Optional but recommended)
Make sure that you are running the same version of Logscape on the Source and Target – as always we recommend using the latest version.
The following guide assumes you are using 3.1 or greater – if not, upgrade to 3.1 before you start.
Step 1. Clear the Target
The first thing you will need to do is ensure you have a clean machine.
If you have never installed Logscape on the Target Manager, proceed to step 2.
If this machine was previously a Logscape Agent, it is highly recommended that you uninstall Logscape or at least install your Manager in a clean directory.
If you want to keep historical data from the Target Managers work directory, copy it elsewhere and once the Manager is installed, copy the data to the new work directory. Only copy data! Do not copy over the DB folder or Jetty folders.
Step 2. Install your New Manager
Install Logscape in the usual manner using the MSI for Windows host and the Zip for Linux hosts. Once the environment is up and running, check that you can login using the default credentials:
Step 3. Secure your Manager Accounts and Upload your License
You need to change the passwords for the sysadmin and admin accounts – since they are currently still set to the defaults… which I just exposed to the world 30 seconds ago! Navigate to the User screen, select both accounts and change the passwords. Make them secure and hard to guess.
Next, upload your license file on the Deployment screen. If you need a new license file, contact email@example.com . If you’re running in unlicensed mode, your environment will be limited to a single Manager and Forwarders, preventing you from reaching your maximum potential performance.
Step 4. Download the Configuration from the Source Manager
Log on to the Source Manager and download a full backup. This will be used to migrate all of your users, searches, workspaces and alerts in a file called logscape-(all).config.
This is a brilliant time to clean your environment!
It’s highly likely that you will have old searches cluttering up your pages. If you remove them from the XML, they will not be imported.
Step 5. Import the Configuration to the Target Manager
On the Target Manager, from the Backup screen import your edited logscape-(all).config file, using the Overwrite method. Once the config is loaded, you should see that your dashboard has fully migrated.
Step 6. Setup your SMTP Server (Optional)
One thing that a config export does not include is any SMTP configuration you have setup. Assuming you’d like to receive e-mail alerts, you need this set. Simply go to the System screen and setup the SMTP server to use.
Step 7. Update LDAP Configuration on Target Manager (Optional)
When you export a configuration, users are included. LDAP Configuration does not get exported however. This is due to the fact that the configuration contains the LDAP user password. If you are not using LDAP authentication, you can proceed to the next step.
If you wish to use LDAP, on the Target Manager, go to the Users panel within the Configuration Section and click Directory services. Fill in the Configuration form (it should be exactly the same as the Source Manager configuration) but you will need to know the password for the System User. Then click:
The changes will not take effect until you bounce the system.
Step 8. Migrate the Apps and Settings from the Source Manager Downloads Folder
Go to the Downloads folder of the Source Manager and copy anything of value to the Downloads folder of the Target Manager. In particular, any Apps you plan to run (WindowsApp, JavaApp) or any .properties files your environment relies upon. If you’re not sure, copy it over.
Again, this is an excellent chance to clean your environment and get rid of unused apps.
You should now have a Target environment that mirrors your Source environment. The only thing missing is the agents.
Step 9. Migrate the Agents using the connection.properties file
Create a new text file and call it connection.properties. On the first line, add the following information:
Replace the HOST with either the Hostname, IP address or the DNS Alias of the Target Manager. Replace the PORT with the port number used by the environment (defaults to 11000). For example:
Now you have the connection.properties file, you can use it on your Source environment to migrate the hosts.
Then you will need to distribute the new connection settings to the agents.
- Upload the connection.properties file to the source environment
- Wait until the file has been distributed around the environment.
- Log on to the Source Manager and delete the connection.properties file from the Downloads folder.
- If you used a DNS Alias change the DNS Record to point to the new Manager. (Optional)
- Bounce the Source environment (you may need to do this several times).
Once the agents bounce, when they restart they will use the Manager address in the properties file and they should join the Target environment. The reason behind step 3 is to prevent your Source Manager from trying to join the Target environment.
Step 10. Set the Target Manager’s connection.properties
Upload the connection.properties file to your Target Manager, that way any future migrations will be simpler.
Step 11. Setup SSL (Optional)
If you’re running an enterprise environment, you really should be accessing the dashboard over SSL. This encrypt the traffic and ensure that users know they can trust your site. You’ll need to import the SSL certificate into the keystore and ensure the settings are correct in the ssl.properties file. For more information on setting up SSL, check the documentation.
You should now have successfully migrated your Logscape environment to a new Manager. The configuration means you have all of the same workspaces and searches, the agents have all re-joined. We hope this was helpful, if you have any questions please feel free to contact us on firstname.lastname@example.org.