XML Command File

Introduction

This document describes the specification for the XML based job description language (JDL) that Auger uses.

Language Specification

The JDL is XML based. The top level tag will be a request tag. The submission will consist of a description of one or more jobs that are to be run on the farm. The valid subtags and tag attributes will be described below. The script can be augmented with the use of variables. Comments can be specified by using the XML comments by starting the comments with Tags.

Auger Command Files

To submit a job to the farm you need to create a configuration script that describes your job(s). There are two different formats that this configuration file can be in. The first is a flat file format which has been supported for years. The second format is an XML based format, which allows some additional description.

Batch Job Tracks

NOTE: This information is no longer valid for our slurm-based queue manager. See 'account' and 'partition' information under https://scicomp.jlab.org/cli/add-job.html


All jobs submitted to the farm will belong to a track. The track is used to determine both what queue a job runs in and what type of job it is for accounting purposes.

Text Command File

Keywords

Auger Examples

This page gives examples of different types of configuration scripts for Auger. This document assumes that you are familiar with the syntax of these scripts and therefore doesn't spend much time explaining them. These files are intended to be used as templates for you to write your own configuration files, changing the values (files, names, commands, emails), to suit your needs. For a detailed description of these configuration files see the Auger Command Files.

farmhosts

Name
    farmhosts - displays hosts and their static and dynamic resources
Syntax
    farmhosts
Description
    Displays information about hosts. It also lists all the job id which
running on that node. The state of farm node is displayed in 5 bits,
FJDOB.

           1st bit is F if the node is free for more job, otherwise is "-"

           2nd bit is J if the maximum jobs are running on the node, otherwise is "-"

jsub

Name

    jsub - Submit an Auger job to farm batch system.

Syntax  

jobstat

Name
   jobstat - batch job status query
Syntax  
   jobstat [-h] [-u username] [-j job_id] [-s stat ] [-a account] [-q queue]
Description
  Display status pbs batch jobs and other information about the selected batch jobs. By default, jobstat show all jobs if no jobId is given. Use [ -u username ] option to select the jobs for specified users.Jobstat will display the job status and related information, such as,
Exec_HOST, SUBMIT_TIME, CPUTIME, WALLTIME and ACCOUNT etc. The status

FAQ

How does Auger handle different types of input file?

There are two different ways that a file is staged to a farm node. 

Fairshare

The batch farm uses a fair share system to schedule jobs using Slurm, the batch scheduler and the fair tree algorithm.  Fair share guarantees that CPU allocations are balanced out according to an allocation over time.

To use a project, the user specified the name of the project using the PROJECT parameter, and Auger will then schedule the work to be done using that project account/user (if the user is a member of that project).

Pages