pearc19-hpc-in-the-cloud GitHub

Intro to Tapis(Aloe) Jobs

Tapis(Aloe) Jobs service

The Tapis(Aloe) Jobs service is a basic execution service that allows you to run applications registered with the Tapis Apps service across multiple, distributed, heterogeneous systems through a common REST interface.
This service manages all aspects of execution and job management from data staging, job submission, monitoring, output archiving, event logging, sharing, and notifications. The Agave jobs service has been recently rearchitectured, to a new code-named Aloe, which provides improved reliability, scalability, performance and serviceability. More details on this new jobs service can be found in the Jobs Tutorial

Jobs Parameters

An example Job JSON defintion:

  "parameters": { 
    "imagefile": ""
  • appId - The unique ID (name + version) of the application run by this job. This must be a valid application that the user has permission to run.
  • name - The user selected name for the job.
  • archive - Whether the job output should be archived. When true, all new files created during job execution will be moved to the archivePath.
  • memoryPerNode - The memory requested for each node on which the job runs. Values are expressed as [num][units], where num can be a decimal number and units can be KB, MB, GB, TB (default = GB). Examples include 200MB, 1.5GB and 5.
  • archiveSystem - The unique id of the storage system on which the job output will be archived.
  • parameters - Application-specific parameters with types defined in the application defintion.
    appId and name are required parameters. Please refer to all the job parameters here Job Parameters

Exercise: Submitting a Job

Once you have at least one app registered, you can start running jobs. To run a job, Tapis just needs to know what app you want to run and what inputs and parameters you want to use.
There are number of other optional features, which are explained in detail in the Job Management Tutorial.
Note that you can specify which queue to use as well as runtime limits in your job. If those are absent, Tapis falls back to whatever was listed in the app description (also optional). If that app doesn’t specify, then it falls back to the defaults given for the execution system.

Lets run our very first Tapis(Aloe) Job!

Step 1: Crafting a Job Definition

Create job.json file in your home directory on Jetstream VM and update the values for fields name, appID and archiveSystem.

You can find the appId of the app that you just registered and your storage system id with the command below.


In the job.json, you will see archive set as True. With this setting, all new files created during job execution will get copied to the archiveSystem.

Step 2: Submit job

Run the job submission command from the directory on your VM, where you created job.json

jobs-submit -F job.json

Alternately, this command can be run with -V option to get a detialed job response

jobs-submit -F job.json -V

You should see a message “Successfully submitted job job-id”. Everytime you submit a job, a unique job id is created. You will use this job id with other CLI commands to get the Job Status, output listing and much more.

Jobs List

Now, when you do a jobs-list you can see your job id


Jobs Status

Job status allows you to see the current state of the job. You can also set up email or webhook notification and get notified when the job state changes

jobs-status <jobId>

Job enters into different states throughout the execution. Details about different job states are given here JOB STATES

Jobs Output

jobs-output-list -L <jobId>

With this command, you can see the current files in the output folder.
When archive is true, all the new files will get copied to archive directory on your archive system. When it is false, all the output files can be found on the execution system’s scratch directory

To retrieve the output predictions.txt file we will use the jobs-output-get command below:

jobs-output-get -r <jobId>

For example, if using the train510 account with job uuid 8c7a91ac-7da5-44ad-a6dd-39f010e87e54-007, the command would be:

jobs-output-get -r 8c7a91ac-7da5-44ad-a6dd-39f010e87e54-007

You should see a “jobs-jobId” folder created in your present working directoty, which contains the predictions.txt file along with .err and .log files.

Jobs Notifications

You can monitor progress of your job by setting by email or webhook notifications Add this to your job definition and try to submit the job again


You should see email notifications pop up in your inbox as the job changes state.

What’s next?

If you made it this far, you have successfully created a new app within a container and have deployed that tool on an HPC system, and now you can run that tool through the cloud from anywhere! That is quite a lot in one workshop.

At this point, it would be a good idea to connect with other developers that are publishing apps and running workflows through Tapis by joining the Tapis API Slack channel: