What is a scheduler?
What's a job?
On computers we are most often familiar with graphical user interfaces (GUIs). There are windows, menus, buttons; we click here and there and the system responds. On Compute Canada servers the environment is different. To begin with, you control it by typing, not clicking. This is called a command line interface. Furthermore, a program you would like to run may not begin immediately, but may instead be put in a waiting list. When the necessary CPU cores are available it will begin, otherwise jobs would interfere with each other leading to performance loss.
You prepare a small text file called a job script that basically says what program to run, where to get the input, and where to put the output. You submit this job script to a piece of software called the scheduler which decides when and where it will run. Once the job has finished you can retrieve the results of the calculation. Normally there is no interaction between you and the program while the job is running, although you can check on its progress if you wish.
Here's a very simple job script:
#!/bin/bash #SBATCH --time=00:01:00 echo 'Hello, world!' sleep 30
It runs the programs
sleep, there is no input, and the output will go to a default location. Lines starting with
#SBATCH are directives to the scheduler, telling it things about what the job needs to run. This job, for example, only needs one minute of run time (00:01:00).
The job scheduler
The job scheduler is a piece of software with multiple responsibilities. It must
- maintain a database of jobs,
- enforce policies regarding limits and priorities,
- ensure resources are not overloaded, for example by only assigning each CPU core to one job at a time,
- decide which jobs to run and on which compute nodes,
- launch them on those nodes, and
- clean up after each job finishes.
On Compute Canada clusters, these responsibilities are handled by the Slurm Workload Manager. All the examples and syntax shown on this page are for Slurm.
You use the job script to ask for the resources needed to run your calculation. Among the resources associated with a job are time and number of processors. In the example above, the time requested is one minute and there will be one processor allocated by default since no specific number is given. We describe below other types of requests such as multiple processors, memory capacity and special processors such as GPUs.
It is important to specify those parameters well. If you ask for less than the calculation needs, the job will be killed for exceeding the requested time or memory limit. If you ask for more than it needs, the job may wait longer than necessary before it starts, and once running it will needlessly prevent others from using those resources.
A basic SLURM job
We can submit the job script
simple_job.sh shown above with sbatch:
[someuser@host ~]$ sbatch simple_job.sh Submitted batch job 1234 [someuser@host ~]$ squeue -u $USER JOBID PARTITION NAME USER ST TIME NODES NODELIST(REASON) 1234 mem12_sho simple_j someuser R 0:03 1 zeno001 [someuser@host ~]$ cat slurm-1234.out Hello, world!
Look at the ST column in the output of squeue to determine the status of your jobs. The two most common states are "PD" for "pending" or "R" for "running". When the job has finished it no longer appears in the
Notice that each job is assigned a "job ID", a unique identification number printed when you submit the job --- 1234 in this example. You can have more than one job in the system at a time, and the ID number can be used to distinguish them even if they have the same name. And finally, because we didn't specify anywhere else to put it the output is placed in a file named with the same job ID number,
You can also specify options to
sbatch on the command line. So for example,
[someuser@host ~]$ sbatch --time=00:30:00 simple_job.sh
will change the time limit of the job to 30 minutes. Any option can be overridden in this way.
Choosing where the output goes
If you want the output file to have a more distinctive name than
slurm‑1234.out, you can use
--output to change it.
The following script sets a job name which will appear in
squeue output, and sends the output to a file prefixed with the job name and containing the job ID number.
#!/bin/bash #SBATCH --time=00:01:00 #SBATCH --job-name=test #SBATCH --output=test-%J.out echo 'Hello, world!'
Error output will normally appear in the same file, just as it would if you were typing commands interactively. If you wish you can split the standard error channel (stderr) from the standard output channel (stdout) by specifying a file name with the
Accounts and projects
Information about your job, like how long it waited, how long it ran, and how many cores it used, is recorded so we can monitor our quality of service and so we can report to our funders how their money is spent. Every job must have an associated account name corresponding to a Compute Canada resource allocation project.
If you try to submit a job with
sbatch without supplying an account name, and one is needed, you will be shown a list of valid account names to chose from.