Two-way Variables #99434

New Issue

Sybren A. Stüvel · 2022-07-04T16:06:48+02:00

Sybren A. Stüvel commented

2022-07-04 16:06:48 +02:00

To support mixed-platform render farms, Flamenco v2 has two-way variables. These need to be reintroduced to Flamenco v3.

These two-way variables effectively replace a path prefix with another one. Here is an example:

name	Linux	Windows	macOS
`RENDER`	`/render/flamenco`	`R:\flamenco`	`/Volumes/render/flamenco`

This is what a typical flow would look like:

Artist submits a job from a Windows machine, with render output set to R:\flamenco\Sprites\shot_010_0003\######.png
The path prefix is recognised, and the job is actually set to render to {RENDER}\Sprites\shot_010_0003\######.png
A Worker running Linux is assigned a render task. It is told to render to /render/Sprites/shot_010_0003/######.png

NOTE: The variable replacement (func (c *Conf) ExpandVariables(...) needs to go through multiple iterations, to make sure that, for example, the implicitly defined {jobs} variable gets the path replacements applied as well.

I'm not 100% sure whether this should be a Flamenco v3.0 target. On one hand it's an important feature for mixed-platform render farms. On the other hand, it's hard to explain this feature easily, and there are no sensible defaults (except an empty list of path replacement variables).

To support mixed-platform render farms, Flamenco v2 has *two-way* variables. These need to be reintroduced to Flamenco v3. These two-way variables effectively replace a path prefix with another one. Here is an example: | name | Linux | Windows | macOS | | ------ | ------ | ------ | ------ | | `RENDER` | `/render/flamenco` | `R:\flamenco` | `/Volumes/render/flamenco` | This is what a typical flow would look like: - Artist submits a job from a Windows machine, with render output set to `R:\flamenco\Sprites\shot_010_0003\######.png` - The path prefix is recognised, and the job is actually set to render to `{RENDER}\Sprites\shot_010_0003\######.png` - A Worker running Linux is assigned a render task. It is told to render to `/render/Sprites/shot_010_0003/######.png` **NOTE:** The variable replacement (`func (c *Conf) ExpandVariables(...)` needs to go through multiple iterations, to make sure that, for example, the implicitly defined `{jobs}` variable gets the path replacements applied as well. ---------------- I'm not 100% sure whether this should be a Flamenco v3.0 target. On one hand it's an important feature for mixed-platform render farms. On the other hand, it's hard to explain this feature easily, and there are no sensible defaults (except an empty list of path replacement variables).

Sybren A. Stüvel commented

2022-07-04 16:06:48 +02:00

Changed status from 'Needs Triage' to: 'Confirmed'