batchbeagle: A Python repository from Caltech Academic Development Services

  _           _       _     _                      _      
 | |         | |     | |   | |                    | |     
 | |__   __ _| |_ ___| |__ | |__   ___  __ _  __ _| | ___ 
 | '_ \ / _` | __/ __| '_ \| '_ \ / _ \/ _` |/ _` | |/ _ \
 | |_) | (_| | || (__| | | | |_) |  __/ (_| | (_| | |  __/
 |_.__/ \__,_|\__\___|_| |_|_.__/ \___|\__,_|\__, |_|\___|
                                              __/ |       
                                             |___/

Full documentation at http://batchbeagle.readthedocs.io.

batchbeagle has commands for managing queues, compute environments, and job definitions:

Create, update, disable and destroy queues
Create, update, disable and destroy compute environments
Create, update, and deregister job definitions
Submit, list, cancel and terminate jobs
Run multiple jobs by passing a parameters file
Specify all allowed values for the parameters
Run jobs in both EC2 and SPOT

To use batchbeagle, you

Install batchbeagle
Define your queues, compute environments, and job definitions in batchbeagle.yml
Use beagle to start managing them

A simple batchbeagle.yml looks like this:

queues:
  - name: queue1
    state: enabled
    priority: 1
    compute_environments:
      - name: env1
        order: 1

compute_environments:
  - name: env1
    type: managed
    state: enabled
    serviceRole: arn:aws:iam::12345678901:role/service-role/AWSBatchServiceRole
    compute_resources:
        type: spot
        instanceRole: arn:aws:iam::12345678901:instance-profile/env1
        instanceTypes:
          - optimal
        maxvCpus: 24
        minvCpus: 0
        securityGroupIds:
          - sg-ffffffff
        subnets:
          - subnet-9f9f9f

job_definitions:
  - name: job1
    container:
        image: centos
        memory: 128
        vcpus: 1
        command: echo ${greeting} ${greetee}
    parameters:
        greeting: hello
        greetee: world

caltechads/batchbeagle