Clone this repository and install the package directory using pip. StreamFlow will automatically recognise it as a plugin and load it at each workflow execution.

git clone https://github.com/alpha-unito/streamflow-slurm-rest
cd streamflow-slurm-rest
pip install .

If everything worked correctly, whenever a workflow execution start the following message should be printed in the log:

Successfully registered plugin streamflow.plugins.unito.slurmrest.plugin.SlurmRestStreamFlowPlugin

deployments:
  slurm-rest-deployment:
    type: unito.slurmrest
    config:
      api_address: <slurm_api_address> # Required
      api_version: v0.0.43  # Optional, default is v0.0.43
      jwt_token: <jwt_token or path to jwt token file> # Required
      services:
        slurm-rest-service:
          partition: <partition_name>
          <other_slurm_job_options>: <value>
          ...

The configuration for the service follows that of the SLURM REST API for the /job/submit endpoint, and it is described in detail in the official documentation (see job configuration). All configuration options are optional, except for api_address and jwt_token.