Domains and options¶
Every option belongs to a domain. The domain says who reads the option:
the checklet itself, the scheduler, or the tool lookup. An option is
identified by its name and domain together, written as name@domain.
checklet¶
The checklet domain holds the options that checklets define for
their own configuration, such as a time limit or a tolerance. This is
the default domain. A plain option name without @domain refers to
this domain.
scheduler¶
The scheduler domain holds the options the scheduler reads before
it runs a task. They control task creation, preflight checks, and tool
requirements. Checklets do not declare these options. They are
available for every step.
tools¶
The tools domain maps a tool requirement to the version to use on
the worker that runs the task, such as python/3.13. The scheduler
uses the requirements to pick a worker that has the tool. The checklet
receives the resolved tool path.
- Tools domain
ToolOptionDefinitionToolOptionDefinition.resolve()ToolOptionDefinition.resolve_tool()ToolOptionDefinition.NO_DEFAULTToolOptionDefinition.allToolOptionDefinition.defaultToolOptionDefinition.deprecatedToolOptionDefinition.docToolOptionDefinition.domainToolOptionDefinition.enableToolOptionDefinition.fullnameToolOptionDefinition.locationToolOptionDefinition.multipleToolOptionDefinition.nameToolOptionDefinition.requiredToolOptionDefinition.shortnameToolOptionDefinition.type
ToolOptionName
x-...¶
Domain names starting with x- are free for private use cases, such
as options shared between the checklets of one course or project.
Other domain names¶
All other domain names are reserved for future use by Momotor.