Unique identifier for a provisioner, that can supply specified
Unique identifier for a worker-type within a specific provisioner
All tasks in a task group must have the same
schedulerId. This is used for several purposes:
- it can represent the entity that created the task;
- it can limit addition of new tasks to a task group: the caller of
createTask must have a scope related to the
schedulerId of the task
- it controls who can manipulate tasks, again by requiring
schedulerId-related scopes; and
- it appears in the routing key for Pulse messages about the task.
Identifier for a group of tasks scheduled together with this task.
Generally, all tasks related to a single event such as a version-control
push or a nightly build have the same
taskGroupId. This property
taskId if it isn't specified. Tasks with
taskId equal to
taskGroupId are, by convention,
List of dependent tasks. These must either be completed or resolved
before this task is scheduled. See
requires for semantics.
taskId of a task that must be resolved before this task is
The tasks relation to its dependencies. This property specifies the
semantics of the
all-completed is given the task will be scheduled when all
dependencies are resolved completed (successful resolution).
all-resolved is given the task will be scheduled when all dependencies
have been resolved, regardless of what their resolution is.
List of task-specific routes. Pulse messages about the task will be CC'ed to
route.<value> for each
<value> in this array.
|Task Specific Route||string[1:249]|
A task specific route.
Priority of task. This defaults to
lowest and the scope
queue:create-task:<priority>/<provisionerId>/<workerType> is required
to define a task with
normal priority is treated as
Number of times to retry the task in case of infrastructure issues.
An infrastructure issue is a worker node that crashes or is shutdown,
these events are to be expected.
Task expiration, time at which task definition and status is deleted.
Notice that all artifacts for the task must have an expiration that is no
later than this. If this property isn't it will be set to
plus one year (this default may change).
Creation time of task
Deadline of the task,
running runs are
resolved as exception if not resolved by other means
before the deadline. Note, deadline cannot be more than
5 days into the future
List of scopes (or scope-patterns) that the task is
authorized to use.
A scope (or scope-patterns) which the task is
authorized to use. This can be a string or a string
* which will authorize all scopes for
which the string is a prefix. Scopes must be composed of
printable ASCII characters and spaces.
Task-specific payload following worker-specific format.
Refer to the documentation for the worker implementing
<provisionerId>/<workerType> for details.
Required task metadata
Human readable name of task, used to very briefly given an idea about
what the task does.
Human readable description of the task, please explain what the
task does. A few lines of documentation is not going to hurt you.
E-mail of person who caused this task, e.g. the person who did
hg push. The person we should contact to ask why this task is here.
Link to source of this task, should specify a file, revision and
repository. This should be place someone can go an do a git/hg blame
to who came up with recipe for this task.
default: [object Object]
Arbitrary key-value tags (only strings limited to 4k). These can be used
to attach informal metadata to a task. Use this for informal tags that
tasks can be classified by. You can also think of strings here as
candidates for formal metadata. Something like
purpose: 'build' || 'test' is a good example.
default: [object Object]
Object with properties that can hold any kind of extra data that should be
associated with the task. This can be data for the task which doesn't
payload, or it can supplementary data for use in services
listening for events from this task. For example this could be details to
display on treeherder, or information for indexing the task. Please, try
to put all related information under one property, so
extra data keys
for treeherder reporting and task indexing don't conflict, hence, we have
reusable services. Warning, do not stuff large data-sets in here --
task definitions should not take-up multiple MiBs.