Skip to content

Commit a7f79e6

Browse files
authored
Merge pull request #7134 from bhearsum/definitions
Add brief definitions of task queue and worker terminology.
2 parents a2c8235 + 3816f03 commit a7f79e6

File tree

3 files changed

+56
-4
lines changed

3 files changed

+56
-4
lines changed

changelog/YsqougpvRtqJssPfQgjSJA.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
audience: general
2+
level: silent
3+
---

generated/docs-table-of-contents.json

Lines changed: 27 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
filename: task-execution/definitions.mdx
3+
title: Definitions
4+
order: 5
5+
---
6+
7+
There are a number of terms surrounding queues and workers that are named
8+
similarly and can be confusing. This page offers a quick overview and reference
9+
to help disambiguate them.
10+
11+
First, there's a set of closely related things that largely pertain to Worker
12+
Manager, the Queue, and task definitions. They are:
13+
14+
* taskQueueId: A property present on every Task that represents a queue
15+
of tasks that will be claimed by a `workerPoolId` of the same name.
16+
* workerPoolId & workerPool: A set of workers in Worker Manager. Each worker
17+
in this set will claim tasks from the `taskQueueId` of the same name.
18+
Each pool also contains configuration used by Worker Manager.
19+
* provisionerId & workerType: Legacy terms that are subsets of taskQueueId
20+
and workerPoolId. When present, they can be combined with a "/" to form
21+
one of the above. Eg: a provisionerId of `mozilla` and workerType of
22+
`linux` will form a taskQueueId and workerPoolId of `mozilla/linux`.
23+
These are still used instead of `workerPoolId` by generic-worker.
24+
* workerGroup & workerId: Identifiers for an individual worker. These are
25+
purely information, and do not relate to any of the above properties
26+
except by coincidence.

0 commit comments

Comments
 (0)