Pipelines glossary¶

Short definitions of the terms used in the pipelines pages. Each links to its normative definition.

Audience: All · See also: Pipelines · Configuration · Operating · Internals: normative glossary

1. Files and folders¶

confdir: <long_name>-conf/, the editable source of a pipeline: TOML files, scripts/, hook declarations and data/. Kept in git. Normative
rootdir: <name>-rootdir/, the long-lived home of one pipeline instance, built by init. After init, it is authoritative. Normative
rundir: $MILK_SHM_DIR/pipe_rundirs/<name>/, the claim a deploy writes for the current boot. Ephemeral. Normative
conf artifact: A file whose fingerprint is tracked: each conf file (TOML, scripts/) and each hook product. Drift is computed per artifact. Normative
fingerprint: The record of an artifact's content (a hash) and, for a hook product, of its declaration. Normative
tagfile: <product>.tag, the fingerprint of a hook product, stored next to it. Normative
identity keys: long_name, name and loop_number. Every path and FPS name derives from them; they cannot be overridden. Normative

provisioning: The file operations on confdirs and rootdirs: clone, consolidate, confresolve, init, drift, resync. CLI milk-pipeinit. Normative
clone: A one-time copy of a confdir's conf files to a new location, without data/. Normative
conf hook: A declared action that fetches or generates a file into confdir/data/. Normative
consolidate: Run the pending conf hooks of a confdir. Normative
confresolve: Turn a confdir or rootdir, plus overrides, into one validated configuration. Normative
init: Build a rootdir from a confdir. Normative
drift: A change of a conf artifact since it was recorded, in the confdir or in the rootdir. Only reported. Normative
resync: Copy drifted artifacts from the confdir into an existing rootdir. Normative

compute unit (CompU): One milk fpsexec executable in a pipeline, with its FPS, its conf and run processes and its tmux session. Normative
kind: The protocol a pipeline declares (kind = "…"). Kinds other than generic: not yet implemented. Normative
state: cold, deployed, configured, running, mixed or inconsistent. Computed, never stored. Normative
cold: Nothing deployed: no rundir and no FPS. Normative
inconsistent: The rundir and the live FPSs disagree; only teardown is accepted. Normative
task: One idempotent action on the live pipeline, on all CompUs or a subset. Normative
plan: A named, ordered list of tasks with a failure policy, run by milk-pipes <plan>. Normative