TES in 5 minutes
TES is a GA4GH standard for a REST API that submits, manages and monitors batch tasks. It was built to make genomic analyses portable across compute environments, but any workload that fits "run this command with these inputs and collect these outputs" works. Poiesis implements the server side on Kubernetes.
A task
A TES task declares:
executors: an ordered list of image, command, environment and working directory;inputs: URLs to stage onto the task's volume (optional);outputs: paths to upload after the executors run (optional);resources: CPU, RAM and disk.
json
{
"name": "hello",
"executors": [
{"image": "alpine:3.20", "command": ["echo", "hello from poiesis"]}
]
}The API
Five operations under /ga4gh/tes/v1:
| Method | Path | Operation |
|---|---|---|
GET | /service-info | GetServiceInfo |
GET | /tasks | ListTasks (filters, pagination, views) |
POST | /tasks | CreateTask |
GET | /tasks/{id} | GetTask (MINIMAL, BASIC or FULL view) |
POST | /tasks/{id}:cancel | CancelTask |
The full contract is on the TES API page.
States
Terminal states are COMPLETE, EXECUTOR_ERROR, SYSTEM_ERROR and CANCELED. SYSTEM_ERROR covers failures that aren't your executor's: an image that can't be pulled, a volume that can't be bound, a node that disappears, an input or output that can't be staged.
- A task is
QUEUEDuntil its Pod is scheduled andtrecstarts. - It is
INITIALIZINGfrom then until the first executor starts: images are pulled andtifstages the inputs. A task without inputs passes throughINITIALIZINGtoo, usually for the time it takes to pull the first executor's image. - It is
RUNNINGfrom the start of the first executor until it ends, output upload included.
Poiesis doesn't use PAUSED or PREEMPTED.
Fields Poiesis accepts but ignores
inputs[].streamable: TES lets a server ignore it.tifalways downloads an input onto the task's volume; nothing is streamed or FUSE-mounted.
