Website: add documentation for worker tags and sleep schedule

The worker tags and sleep schedule features are now actually documented.
This commit is contained in:
Sybren A. Stüvel 2024-01-25 12:15:29 +01:00
parent c3a306a9c5
commit 13a793743f
3 changed files with 91 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@ -0,0 +1,36 @@
---
title: Sleep Schedule
resources:
- name: screenshot
src: "flamenco-sleep-schedule-web-interface.png"
title: Sleep Schedule of a Worker in the Flamenco Manager web interface
---
Workers can be given a sleep schedule. This tells the Worker when to go to
sleep, and when to wake up. A typical use is for a desktop computer that is **in
use during office hours**, and outside those hours be **part of the render
farm**.
{{< img name="screenshot" size="origin" >}}
The sleep schedule determines when Flamenco Worker is asleep, i.e. when it is
not active on the farm. You can also see this as a configuration of **when
someone else wants to use the computer**.
Status
: Whether the sleep schedule is doing anything. This can be toggled with the slider next to the "Sleep Schedule" header. If it's disabled, you can still edit it, but otherwise it is ignored. In this case the Worker can be woken up or sent to sleep manually via [worker actions]({{< ref "usage/worker-actions" >}}).
Days of the week
: Days of the week that this worker should be asleep. Write each day name using their first two letters, separated by spaces. For example: `mo tu we th fr`. Note that this does **not** support range notation (`mo-fr`).
Start Time & End Time:
: Start and end time of when this worker should be asleep, in 24h notation.
## Example
If the Worker machine is used by someone who works on weekdays except Wednesdays, usually from 10:00 to 19:00, the sleep schedule would look like this:
- **Days of the week:** `mo tu th fr`
- **Start Time:** `10:00`
- **End Time:** `19:00`

View File

@ -0,0 +1,55 @@
---
title: Tags
---
Sometimes you want **a job to be sent only to some workers, but not all of them**.
This can be due to memory requirements of that job, the GPU the workers have
available, or any other reason. This is what you can use tags for.
## How does it work?
How this works is easiest to explain when we look at two perspectives:
### From the perspective of the job
- A job can have one tag, or no tag.
- A job **with** a tag will only be assigned to workers with that tag.
- A job **without** tag will be assigned to any worker.
### From the perspective of the worker
- A worker can have any number of tags.
- A worker **with** one or more tags will work only on jobs with one those tags, and on tagless jobs.
- A worker **without** tags will only work on tagless jobs.
## Example: Blender Studio
[Blender Studio](https://studio.blender.org/) have two groups of Workers:
- **Artist machines**, with powerful GPUs. These are suitable for EEVEE renders, but
also Cycles-on-GPU, and can also help with Cycles-on-CPU jobs.
- **Render servers**, with lots of CPU power, but no GPUs. These can only do
Cycles-on-CPU jobs.
To support these different cases, they use three tags:
- `EEVEE`
- `Cycles`
- `Cycles GPU`
The **artist machines** get all three tags. The **render servers** just get the
`Cycles` tag. When submitting a job, the artists will chose the tag that is
suitable for that particular job.
{{< hint >}}
Choosing the tag for a job is something you have to do yourself. In this example
case, the tag could in theory be picked automatically depending on the active
render engine. The tagging system is more general than that, though, and so
Flamenco doesn't know what *you* want to use the tags for.
{{< /hint >}}
For more info on GPU rendering with Flamenco, see [FAQ: How do I make the
Workers render on GPU?][faq-gpu]
[faq-gpu]: {{< ref "faq" >}}#how-do-i-make-the-workers-render-on-gpu