Documentation

Integrate MATLAB Job Scheduler for Network License Manager

If you do not have an existing scheduler in your cluster, follow these instructions to integrate the MATLAB® Job Scheduler, which is provided with MATLAB Parallel Server™. If you already have a cluster with a scheduler, see Integrate MATLAB with Third-Party Schedulers.

After you integrate MATLAB with a scheduler, you can access workers in your cluster from a desktop MATLAB client session with Parallel Computing Toolbox™.

The setup in these steps uses the network license manager.

Activate Your MATLAB Parallel Server License

To install MATLAB Parallel Server, you must activate your license. To activate your MATLAB Parallel Server license:

  1. Navigate to https://www.mathworks.com/licensecenter.

  2. Log into the Administrator’s MathWorks Account.

  3. Select your MATLAB Parallel Server license, and click the Install and Activate tab.

  4. At the rightmost side, under RELATED TASKS, select Activate to Retrieve License File.

  5. Fill in the requested information. This information must refer to the machine that hosts the license manager. In these instructions, it is the head node. For more information, see Install Software on the Head Node.

  6. After filling in the information, download or email the License File and copy the File Installation Key. These are used later in the process.

Note

Activation is not necessary for trials. Contact your sales representative to obtain the License File and the File Installation Key.

Get the Installation Files

To save time and eliminate the need for the installer-based download process for each computer in your cluster, download the installation files prior to installation. Doing so facilitates installation in a large number of machines. If you have access to an Administrator’s account for your license, you can use the installer to download files without installing them. If not, contact the administrator of your license to obtain a copy of the installation files. For more information, see Download Products Without Installation (Installation, Licensing, and Activation). When using the installer to download the files, choose the following options:

  • Select the appropriate operating system for the cluster machines.

  • Select all products for download. MATLAB Parallel Server cannot run jobs requiring products that are not installed.

There are three server-side components of MATLAB Parallel Server:

  1. The license manager, which hosts the MATLAB Parallel Server license used by each worker. For more information, see Install Software on the Head Node.

  2. The MATLAB Job Scheduler, which runs on the head node and manages jobs on your cluster. For more information, see Install Software on the Head Node.

  3. MATLAB Parallel Server, which runs on the compute nodes. For more information, see Install Software on Worker Nodes.

Install Software on the Head Node

Use the offline installer from the previous step. For more information on the offline installation procedure, see Install Products Offline (Installation, Licensing, and Activation).

  1. Choose a computer to host the license manager and the MATLAB Job Scheduler. This computer is your head node.

  2. Start the MATLAB installer from the installation files acquired in Get the Installation Files.

  3. Select Use a File Installation Key, and continue through the prompts.

  4. Select all products, including the license manager.

  5. In the License File step, browse to your license.lic file (obtained from Activate Your MATLAB Parallel Server License).

  6. Start the license manager.

This license does not allow you to run MATLAB from the worker nodes or the head node. If you want to test the installation, complete the following setup, and follow the steps in Connect the MATLAB Client to the MATLAB Parallel Server Cluster.

Install Software on Worker Nodes

This procedure is similar to Install Software on the Head Node. For more information on the offline installation procedure, see Install Products Offline (Installation, Licensing, and Activation).

  1. Start the MATLAB installer from the installation files acquired in Get the Installation Files.

  2. Select Use a File Installation Key and continue through the prompts.

  3. Select all products. However, do not install the license manager.

  4. Use the license.dat file from the head node. You can obtain this file from the matlabroot/etc folder, where matlabroot is the MATLAB installation folder.

For best performance, install locally on each node. However, you can also install in a network share location. To save time, you can perform a noninteractive installation (silent installation) on the worker nodes. For instructions, see Install Noninteractively (Silent Installation) (Installation, Licensing, and Activation).

Configure the MATLAB Job Scheduler with Admin Center

The MATLAB Job Scheduler is a scheduler that ships with MATLAB Parallel Server. The MATLAB Job Scheduler is intended primarily for small-to-medium-sized clusters that run only MATLAB jobs. The scheduler interface is a high-level abstraction that lets you submit jobs to your computation resources, so you do not have to deal with differences in operating systems and environments.

  1. On the head node, start Admin Center. Browse to matlabroot/toolbox/parallel/bin and execute the file named admincenter. matlabroot is the MATLAB installation folder.

  2. Click Add or Find, and specify the computers that you are using as your head node and worker nodes.

  3. Progress through the prompts, and confirm to start the mjs service. If necessary, manually start the mjs service using the command-line interface. For more information, see Use the Command-Line Interface (Windows) or Use the Command-Line Interface (UNIX).

  4. In the MATLAB Job Scheduler section, click Start. Specify a name for your MATLAB Job Scheduler, and select the head node from the dropdown list.

  5. To add the MATLAB Parallel Server workers, click Start in the Workers section of the Admin Center.

    1. Select the computers to host the workers.

    2. Select the number of workers per computer.

  6. To verify your configuration, review worker status in the Workers section.

  7. To troubleshoot issues, click Test Connectivity in the Host section.

  8. If you are using UNIX, configure the mjs service to start automatically at start time. For instructions, see Start the mjs Service, MATLAB Job Scheduler, and Workers (Command-Line).

The following screenshot shows a final setup in Admin Center:

Note

If you need more help during the configuration, such as your cluster requires firewall configuration or you want to set up multiple mjs installations, see this more detailed guide: Configure Advanced Options for MATLAB Job Scheduler Integration.

Connect the MATLAB Client to the MATLAB Parallel Server Cluster

To use MATLAB Parallel Server, you must use a client computer running MATLAB and Parallel Computing Toolbox. In the MATLAB toolstrip, use Parallel > Discover Clusters and follow the instructions to automatically discover and set up your cluster. Alternatively, you can configure it manually as follows:

  1. In MATLAB, on the Home tab, select the Parallel menu. Select Create and Manage Clusters.

  2. Click Add Cluster Profile > MATLAB Job Scheduler.

  3. To modify the name of the MATLAB Job Scheduler profile, double click the profile name.

  4. To edit the profile, select it and click Edit in the toolbar.

  5. In the Host field, enter the host name of the head node.

  6. Click Done. The following image shows an MATLAB Job Scheduler cluster profile after configuration:

  7. To make this profile the default, select Set as Default.

  8. Validate the cluster profile.

If validation of your cluster is successful, your MATLAB session can now submit jobs to the MATLAB Parallel Server cluster.

Note

If your validation does not pass, contact the MathWorks install support team.

Any MATLAB cluster workers that you start use dynamic licensing: they can use all the functionality you are licensed for in the MATLAB client, while checking out only MATLAB Parallel Server licenses in the cluster.

To configure more advanced options for your cluster, see MATLAB Job Scheduler Cluster Customization. For example, you can set the security of the cluster in Set MATLAB Job Scheduler Cluster Security. After you finish your configuration, try some examples of cluster workflows in Running Code on Clusters and Clouds.

Related Topics