Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dgruber/qsub
The "qsub" command is a command line utility that is used to submit batch jobs, and it is not limited to just Kubernetes.
https://github.com/dgruber/qsub
cloudevents container docker drmaa2 hpc jobtemplate json kubernetes kubernetes-jobs poseidon processes pubsub
Last synced: about 1 month ago
JSON representation
The "qsub" command is a command line utility that is used to submit batch jobs, and it is not limited to just Kubernetes.
- Host: GitHub
- URL: https://github.com/dgruber/qsub
- Owner: dgruber
- License: bsd-3-clause
- Created: 2019-01-21T08:21:47.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-31T14:23:04.000Z (12 months ago)
- Last Synced: 2024-06-20T12:04:04.070Z (6 months ago)
- Topics: cloudevents, container, docker, drmaa2, hpc, jobtemplate, json, kubernetes, kubernetes-jobs, poseidon, processes, pubsub
- Language: Go
- Homepage:
- Size: 223 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# qsub _not just_ for Kubernetes
[](https://circleci.com/gh/dgruber/qsub)
[](https://codecov.io/gh/dgruber/qsub)
_qsub_ is a command line tool used for submitting batch jobs. It has basic functionality defined in the [POSIX standard](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/qsub.html). Various high-performance computing (HPC) job schedulers, such as Grid Engine, SLURM, LSF, and Torque, offer an extended version of qsub with [additional features](http://gridengine.eu/mangridengine/manuals.html).
This repository offers a simplified implementation of qsub for running jobs locally, in Docker containers, on Kubernetes, Google Batch, PubSub, and more. It enables users to easily submit and manage batch jobs in different environments.
## Installation
_qsub_ can be build directly from the sources or alternatively pre-build binaries for darwin and linux can be downloaded from the builds dir.
## Using a DRMAA2 JSON File
By using a [DRMAA2 compatible](https://github.com/dgruber/drmaa2interface) JSON file jobs can be submitted to several backends:
- Google Batch (-b googlebatch)
- Local Process (-b process)
- Docker (-b docker)
- Sending a DRMAA2 JobTemplate wrapped as CloudEvent into Google PubSub (-b pubsub)
- Sending a job to a remote "qsub --server" (-b server)
See some examples [here](https://github.com/dgruber/qsub/tree/master/examples).
```
qsub -b process -j ./jobtemplate.json
```
## Usage for Kubernetes
In order to let the _sleep_ command run in the Kubernetes cluster
which is selected in the current context (_./kube/config_) you need
to specify the container image as well as the command to be executed
in the container (potentially with its arguments).
qsub --image busybox:latest sleep 123
It returns the ID of the job.
The container image can also be set beforehand as environment variable.
export QSUB_IMAGE=busybox:latest
qsub sleep 123
The corresponding pods can be showed with the ID returned back on command line:
kubectl describe pod -l job-name=ID
### More Arguments for Kubernetes
The image name (_--img_) as well as the command which should be executed in the
container derived from the image are mandatory.
Following optional arguments are currently available.
#### Job Name
The job name must be unique otherwise job submission will fail.
qsub --image busybox:latest -N unique sleep 123
Submitted job with ID unique
kubectl get jobs unique
NAME DESIRED SUCCESSFUL AGE
unique 1 0 14s
#### Namespace for Kubernetes Jobs
Jobs can be submitted to a specific kubernetes namespace.
qsub --namespace default --image busybox:latest sleep 123
#### Labels for Kubernetes Jobs
Kubernetes allows to attach labels to pods. Labels are key-value pairs
which can be defined with the _-l_ argument.
#### Environment Variables for Kubernetes Jobs
Environment variables for the jobs can be set by passing them into _-v_. There are
two ways of doing so: as key-value pairs, or just by name.
Following example sets ENV1 to VALUE1 and ENV2 to VALUE2 (using the value from
the current context).
export ENV2=VALUE2
qsub --image busybox:latest -v ENV1=VALUE1,ENV2 sleep 123
#### Scheduler for Kubernetes Jobs
In order to let the job be scheduled by a non-default scheduler (like poseidon
or kube-batch) the _--scheduler_ argument can be used.
qsub --scheduler poseidon --img busybox:latest sleep 123