Distribute a Generic Cluster Profile and Plugin Scripts

You can distribute a Generic cluster profile and plugin scripts for others to use. If necessary, you can create a Generic cluster profile and plugin scripts as follows:

Download the plugin scripts from the GitHub^® repository appropriate for your third-party scheduler. For more details, see Download Sample Plugin Scripts.
Create a Generic cluster profile. For more details, see Create a Generic Cluster Profile.

Decide How Users Access the Plugin Scripts

The PluginScriptsLocation property of your Generic cluster profile specifies the folder containing the plugin scripts that your cluster profile uses to submit MATLAB^® jobs to the cluster. Other users must have access to these plugin scripts or a copy of them in order to submit jobs to the cluster. As the one distributing a Generic cluster profile and plugin scripts, you must decide how other users will access these scripts.

If you prefer to put the plugin scripts in a read-only shared location, follow the steps in Shared PluginScriptsLocation Folder. This option simplifies subsequent steps and allows any changes you make to the plugin scripts to take effect immediately for all users.
If you prefer to give other users their own copy of your plugin scripts, follow the steps in Distribute Copies of the PluginScriptsLocation Folder.

Shared PluginScriptsLocation Folder

If other users have read access to the PluginScriptsLocation folder specified in your cluster profile, they need only a copy of your profile to submit MATLAB jobs to the cluster.

Note

If you have moved your PluginScriptsLocation folder to a shared location, remember to update the PluginScriptsLocation property of your cluster profile before continuing.

To distribute a copy of your profile, you must:
1. Open MATLAB and navigate to Home > Parallel > Create and Manage Clusters to open the Cluster Profile Manager.
2. Select your profile in the list and click Export.
3. Choose a name for the .settings file, which contains your profile, and click Save.
4. Send a copy of the .settings file to other users.
To import your profile, other users must:
1. Save the .settings file to a location of their choice.
2. Open MATLAB and navigate to Home > Parallel > Create and Manage Clusters.
3. Open the Cluster Profile Manager and click Import.
4. Select the .settings file and click Open. A copy of the profile appears in their profile list.
5. Check that the profile works by selecting the profile in the Cluster Profile Manager and clicking Validate.

Distribute Copies of the `PluginScriptsLocation` Folder

If you cannot or prefer not to put your plugin scripts in a shared location, you can give users a copy of your plugin scripts in addition to your profile.

Note

If you make changes to your plugin scripts, you will have to distribute copies of your updated plugin scripts for the changes to take effect for other users.

To distribute a copy of your profile and plugin scripts, you must:
1. Open MATLAB and navigate to Home > Parallel > Create and Manage Clusters to open the Cluster Profile Manager.
2. Select your profile in the list and click Export.
3. Choose a name for the .settings file, which contains the exported profile, and click Save.
4. Send other users a copy of
  - The .settings file.
  - The PluginScriptsLocation folder and all files therein.
To import your profile and plugin scripts, other users must:
1. Save all files to a location of their choice.
2. Open MATLAB and navigate to Home > Parallel > Create and Manage Clusters.
3. Open the Cluster Profile Manager and click Import.
4. Select the .settings file and click Open. A copy of the profile appears in their profile list.
5. Select the profile in the Cluster Profile Manager and click Edit. Scroll down to the Scheduler Plugin section of the profile and change the PluginScriptsLocation property to point to their copy of the PluginScriptsLocation folder.
6. Check that the profile works by selecting the profile in the Cluster Profile Manager and clicking Validate.

Further Considerations for Clusters with Shared File Systems

If you are distributing a Generic cluster profile with the HasSharedFileSystem property set to true (for example, if your cluster shares a filesystem with MATLAB clients, see Interface with Third-Party Schedulers), the cluster machines must have read and write access to the folder specified in the JobStorageLocation property of the profile. Remind other users receiving the profile that they must either:

Set the JobStorageLocation property of their profile to a shared location, preferably one that is unique to their user name and MATLAB version.
Only create or submit jobs to the cluster when the current working folder is a shared location.