The plan and result files#
eb-pipeline plan writes the plan of a run, and eb-pipeline run --result FILE the result of one.
Both are objects in JavaScript Object Notation (JSON), with the keys of every object in sorted order, and both have schema_version 1.
The examples on this page come from docs/examples/files.sh, which plans and runs a two-line list on a site with the local scheduler, kept logs and rotation, with stand-ins for eb and eb-keep-logs that print their arguments.
The plan file#
plan --out FILE writes the plan to FILE, and plan without --out prints it.
A plan holds every phase, planned or not, in the order a run goes through them, and every command a run would start, with its whole argument vector and environment.
eb-pipeline plan --site site.toml --list build.list --target cpu --build-type production \
--run-id nightly --log-stamp 20261117_090000 --out plan.json
cat plan.json
{
"build_type": "production",
"kind": "plan",
"lines": 2,
"list": "build.list",
"log_dir": "$WORK/logs/20261117_090000/cpu",
"phases": [
{
"commands": [],
"env": {},
"name": "preflight",
"status": "planned"
},
{
"commands": [],
"env": {},
"name": "licences",
"reason": "not configured",
"status": "not configured"
},
...
{
"commands": [
{
"argv": [
"eb",
"Example-1.0-GCCcore-15.2.0.eb",
"--tmp-logdir=$WORK/logs/20261117_090000/cpu/easybuild-logs/Example-1.0-GCCcore-15.2.0"
],
"name": "build:Example-1.0-GCCcore-15.2.0"
},
{
"argv": [
"eb-keep-logs",
"failed",
"<exit-status>",
"Example-1.0-GCCcore-15.2.0",
"$WORK/logs/20261117_090000/cpu",
"$WORK/logs/20261117_090000/cpu/easybuild-logs/Example-1.0-GCCcore-15.2.0"
],
"env": {
"EASYBUILD_OUTPUT_STYLE": "basic"
},
"name": "keep-failed:Example-1.0-GCCcore-15.2.0",
"note": "runs after a failed line"
},
...
],
"env": {
"EASYBUILD_BUILDPATH": "$WORK/scratch/build",
"EASYBUILD_INSTALLPATH": "$WORK/software",
"EASYBUILD_TMPDIR": "$WORK/scratch/tmp",
"EB_PIPELINE_BUILD_TYPE": "production",
"EB_PIPELINE_LOG_DIR": "$WORK/logs/20261117_090000/cpu",
"EB_PIPELINE_LOG_STAMP": "20261117_090000",
"EB_PIPELINE_RUN_ID": "nightly",
"EB_PIPELINE_SITE": "$WORK/site.toml",
"EB_PIPELINE_SITE_NAME": "example",
"EB_PIPELINE_TARGET": "cpu"
},
"name": "build",
"role": "build",
"status": "planned"
},
...
],
"run_id": "nightly",
"schema_version": 1,
"site": "example",
"target": "cpu"
}
Key |
Type |
Meaning |
|---|---|---|
|
string |
The build type. |
|
array |
The lines that the target’s |
|
string |
|
|
integer |
The number of lines of the list, without blank lines and comments. |
|
string |
The build list, as |
|
string |
|
|
array |
Every phase, in the order a run goes through them. |
|
string |
The run id, |
|
integer |
|
|
integer |
The number of lines that |
|
string |
|
|
string |
|
|
string |
The name of the target. |
Where a run reads a value when it starts, the plan shows a stand-in: <run-id> and <log-stamp> without --run-id and --log-stamp, ${NAME} for a variable that the site file names, and <exit-status> for the status of the line that failed.
Each entry of phases#
Key |
Type |
Meaning |
|---|---|---|
|
array |
The commands of the phase, in the order a run starts them. |
|
object |
The environment of the phase, which each of its commands gets. |
|
string |
|
|
string |
Why the phase is not planned; only then. |
|
string |
The role whose launch arguments its commands take, such as |
|
string |
|
Each entry of commands#
Key |
Type |
Meaning |
|---|---|---|
|
array of string |
The whole command: the route, the launch line and the module wrapper when there are any, then the tool and its arguments. |
|
object |
Variables set over the phase environment for this command; only when there are some. |
|
string |
|
|
string |
What to know about the command, such as what its exit statuses mean; only when there is something. |
STEM is the easyconfig file name without .eb, with .2, .3 and so on added when the list repeats a line.
UNIT is all for the whole list, or cpu-prerequisites, prelude or the name of a shard with a shard plan.
A probe:TOOL command runs the --version of a tool that has a min_version.
Each entry of deselected#
Key |
Type |
Meaning |
|---|---|---|
|
string |
The easyconfig of the line. |
|
string |
|
The result file#
run --result FILE writes it when the run ends, and run without --result writes none.
run --dry-run writes none either, and neither does a run that an error in its input stops before it starts, such as an invalid site file, an unknown target, a list that cannot be read or a tool below its min_version: those exit 2, or 78 when only the licence gate fails, and leave an existing FILE as it was.
Read the exit status before the file.
eb-pipeline run --site site.toml --list build.list --target cpu --build-type production \
--run-id nightly --log-stamp 20261117_090000 --result result.json
INFO [licences] cpu: not configured
INFO [shard] cpu: not configured
INFO [sources] cpu: not configured
INFO [admission] cpu: not configured
INFO [caches] cpu: not configured
INFO [build] cpu: Example-1.0-GCCcore-15.2.0: start
INFO [build] cpu: Example-1.0-GCCcore-15.2.0: ok
INFO [build] cpu: Broken-1.0-GCCcore-15.2.0: start
ERROR [build] cpu: Broken-1.0-GCCcore-15.2.0: failed (exit 1)
cat result.json
{
"admission": [],
"build_type": "production",
"counts": {
"failed": 1,
"success": 1
},
"ended_at": "2026-11-17T03:07:42.086667400+00:00",
"exit_code": 1,
"kind": "result",
"lines": [
{
"easyconfig": "Example-1.0-GCCcore-15.2.0.eb",
"exit_code": 0,
"log": "$WORK/logs/20261117_090000/cpu/Example-1.0-GCCcore-15.2.0.stdout.log",
"phase": "build",
"status": "success",
"unit": "all"
},
{
"easyconfig": "Broken-1.0-GCCcore-15.2.0.eb",
"exit_code": 1,
"log": "$WORK/logs/20261117_090000/cpu/Broken-1.0-GCCcore-15.2.0.stdout.log",
"phase": "build",
"status": "failed",
"unit": "all"
}
],
"list": "build.list",
"log_dir": "$WORK/logs/20261117_090000/cpu",
"not_configured": [
"licences",
"shard",
"sources",
"admission",
"caches"
],
"phases": [
{
"name": "preflight",
"status": "ok"
},
...
{
"name": "build",
"status": "failed"
},
{
"name": "caches",
"status": "not configured"
},
{
"exit_code": 0,
"name": "logs",
"status": "ok"
}
],
"run_id": "nightly",
"schema_version": 1,
"sharded": false,
"site": "example",
"started_at": "2026-11-17T03:07:42.003465530+00:00",
"target": "cpu"
}
Key |
Type |
Meaning |
|---|---|---|
|
array |
The admission of each unit that went through it, in order. |
|
string |
The build type. |
|
object |
The number of lines with each status, for the statuses that some line has. A deselected line counts for none. |
|
array |
The lines that the target’s |
|
string |
When the run ended, in Coordinated Universal Time (UTC): the date, the time to the nanosecond and the offset |
|
integer |
The exit status of the run. |
|
string |
|
|
string |
|
|
array |
Every line the run reached, in that order. |
|
string |
The build list, as |
|
string |
|
|
string |
The error that stopped the run, when one did. |
|
array |
The phases that the site file leaves out, in pipeline order. |
|
array |
Every phase the run reached, in pipeline order from |
|
string |
The run id. |
|
integer |
|
|
boolean |
Whether the lines were built in the units of a shard plan. |
|
string |
|
|
string |
When the run started, in the same form as |
|
string |
The name of the target. |
Each entry of lines#
Key |
Type |
Meaning |
|---|---|---|
|
string |
The easyconfig of the line. |
|
integer |
The exit status the line counts as; absent for a line that did not run. |
|
string |
The log of the line’s command. |
|
string |
Why the line came to its status, when that needs saying. A line that went through eb-staged-rebuild has one, whatever its status. |
|
string |
|
|
string |
|
|
integer |
The command’s own exit status, when |
|
string |
The unit of the line: |
Status |
Meaning |
|---|---|
|
Its command exited 0. |
|
Its command, or the prefetch of its sources, exited with a status that means failure. |
|
|
|
|
|
It did not run: admission refused its unit or an earlier one, or a signal stopped the run first. The note says which. |
Each entry of phases#
Key |
Type |
Meaning |
|---|---|---|
|
integer |
The exit status behind the status, when there is one. |
|
string |
The phase. |
|
string |
Why the phase came to its status, when that needs saying. |
|
string |
What the phase came to. |
Status |
Meaning |
|---|---|
|
The phase did its work. |
|
A command of the phase failed, or, for |
|
Something the phase needs is missing, such as a variable that the site file names, and the run stopped; for |
|
The phase did not do its work, and the note says why: for |
|
|
|
A signal stopped the run in this phase. |
|
The site file leaves the phase out. |
Each entry of admission#
Key |
Type |
Meaning |
|---|---|---|
|
integer |
How many times |
|
string |
The last line in JSON that |
|
string |
|
|
string |
The unit, as in |
See also#
eb_pipeline::plan::Plan and eb_pipeline::run::RunResult, the types behind the two files.