How do I upgrade Compute Server and Cluster Manager?

Upgrading server components

The recommended steps to upgrade your Compute Server and Cluster Manager are as follows. If you are not using the Cluster Manager, please skip the corresponding steps:

1. Download and install the new version of Gurobi Remote Services on each server and the Cluster Manager. We will use <old-installdir> to refer to the old version's Remote Services installation directory and <new-installdir> to refer to the new version's Remote Services installation directory.
2. Set up the new license file on each Compute Server when upgrading to a new major version. Note that the Cluster Manager does not require a license.
3. Configure the new installation:
   1. Locate the existing configuration file(s) for your Compute Server(s) and Cluster Manager. The Compute Server configuration file can be found at <old-installdir>/bin/grb_rs.cnf. The Cluster Manager configuration file can be found at <old-installdir>/bin/grb_rsm.cnf.
   2. Verify that the settings listed in the configuration file(s) are correct.
   3. Copy the configuration file(s) to the appropriate location(s) in the new installation directory.
4. Stop and uninstall the Compute Server grb_rs on each server. If you are running Compute Server as a service, stop it with grb_rs stop and uninstall it with grb_rs uninstall.
5. Stop and uninstall the Cluster Manager grb_rsm, if applicable. If you are running Cluster Manager as a service, stop it with grb_rsm stop and uninstall it with grb_rsm uninstall.
6. Backup data before starting the new version to allow a rollback since database schemata might be upgraded to a new version:
   1. If you run Cluster Manager, dump the connected MongoDB (or compatible) database.
   2. If you run Compute Server(s) without Cluster Manager, some configuration is stored in <old-installdir>/bin/data/grb_rs.db, while log files and metrics are located in <old-installdir>/bin/data/files.
7. Migrate data to the new version:
   1. If you use Cluster Manager all previous data will be available when connecting to the same database.
   2. If you use Compute Server(s) without Cluster Manager, copy <old-installdir>/bin/data/grb_rs.db and <old-installdir>/bin/data/files to the new installation directory <new-installdir>. Note that you should not copy <old-installdir>/bin/data/runtimes to the new installation directory since different Compute Server versions have different sets of runtimes.
8. Update the appropriate environment variables on each server so they point to the new installation directory. On Linux, this entails extending the environment variable PATH to include the new installation directory and removing the reference to the old one(s). We suggest that you do it in a persistent way by modifying the appropriate script file (e.g. .bashrc, .bash_profile, .profile, etc.). On Windows and macOS, this is usually set up correctly by the installation procedure.
9. Start the Cluster Manager grb_rsm. To start it as a service, use grb_rsm start.
10. Start the Compute Server grb_rs on each server. To start it as a service, use grb_rs start. 
11. Remove all deprecated installation directories from each server after you have verified that the new version is running correctly.

Note: You may need to update firewall rules for the new executables, e.g., when using the Windows Firewall.

Upgrading client machines

After upgrading the Compute Server, the clients can upgrade their Gurobi Optimizer version.

We highly recommend upgrading all clients to the version of your Compute Server. However, the Compute Server contains runtimes for all supported previous versions. So, an upgrade of the client is optional (as long as the client version is still supported). Backward compatibility is ensured for all minor and technical releases up to the previous major Gurobi release. The exact list of versions supported by your current Compute Server installation can be seen in the directory <new-installdir>/bin/data/runtimes.

Note: If you are running the new Compute Server(s) on the same machine(s) with the same settings as before, updating the client license files should not be necessary.