(Quick Reference)

Storage Plugin

The Storage plugin type provides applications with a list of storage classes. This enables a user interface to populate drop-down lists with real values configured in the system.

Configuration

Plugin Configuration

There is no required or optional plugin configuration.

MWS Configuration

ParameterRequiredTypeDescription
storage.gres.ignore.namesNoList<String>Excludes certain generic resource names from being included as storage classes.
storage.classesNoList<String>When set, this list overrides all storage classes and is returned as the list of classes from the web service.

In order to be used, these parameters must be configured in the MWS Configuration.

Exposed Web Services

MethodSecuredParametersParameter TypesDescription
storage-classesYesNone-Provides a list of storage classes from generic resources configured on Nodes.

Initially Created Plugins

If MWS is configured in the Moab Cloud Suite, a plugin called "mws-storage" will be created automatically when this plugin type is loaded. This is to ensure that applications are able to access the storage-classes web service at a consistent URL.

How It Works

The first time that the storage-classes web service is requested after MWS has started, it will query all of the Nodes in Moab Workload Manager. All of the generic resource names are queried on each node by default. If the storage.gres.ignore.names configuration parameter is set, names in that list are filtered out.

MWS Configuration File
storage.gres.ignore.names = ["name1", "name2"]

The remaining unique generic resource names are returned as storage classes, in the order that they were encountered in the node list (equivalent to Get All Nodes). The resulting list of storage classes is cached for future use.

When the storage-classes web service is requested again, the list of storage classes is retrieved from the in-memory cache; the nodes are not queried again. If one of the configuration properties are changed, or the generic resources on nodes are modified, you must restart Moab Web Services for the changes to be registered in the Storage plugin.

You can use the storage.classes configuration parameter to set the list of storage classes. This will override the list of storage classes that result from a generic resource nodes query. For example, if you set storage.classes to "customName1","customName2", then the storage-classes web service will return only customName1 and customName2 as storage classes (regardless of what generic resources may be configured on any nodes).

MWS Configuration File
storage.classes = ["customName1", "customName2"]