drsybren/Flamenco
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Website: add some documentation about the storage options

Browse Source 
Basically it's "simple, efficient, isolated -- pick two".
This commit is contained in:
Sybren A. Stüvel 2022-08-01 16:36:29 +02:00
parent 1db1b06c9e
commit efff61c454
1 changed files with 36 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
web/project-website/content/usage/shared-storage/_index.md
View File

@ -5,7 +5,29 @@ title: Shared Storage
Flamenco needs some form of *shared storage*: a place for files to be stored
that can be accessed by all the computers in the farm.
TODO: write more about this.
Basically there are three approaches to this:
| Approach | Simple | Efficient | Render jobs are isolated |
|-------------------------------------|--------|-----------|--------------------------|
| Work directly on the shared storage | ✅ | ✅ | ❌ |
| Create a copy for each render job | ✅ | ❌ | ✅ |
| Shaman Storage System | ❌ | ✅ | ✅ |
Each is explained below.
## Work Directly on the Shared Storage
Working directly in the shared storage is the simplest way to work with Flamenco.
## Creating a Copy for Each Render Job
The "work on shared storage" approach has the downside that render jobs are not
fully separated from each other. For example, when you change a texture while a
render job is running, the subsequently rendered frames will be using that
altered texture. If this is an issue for you, and you cannot use the [Shaman
Storage System][shaman], the approach described in this section is for you.
[shaman]: #shaman-storage-system
## Shaman Storage System
@ -15,7 +37,19 @@ TODO: write
### Windows
TODO: lots of tricky stuff about getting symlinks to work on Windows. We may want to get inspiration from the [Git-for-Windows](https://github.com/git-for-windows/git/wiki/Symbolic-Links#allowing-non-administrators-to-create-symbolic-links) documentation.
The Shaman storage system uses _symbolic links_. On Windows the creation of
symbolic links requires a change in security policy. Unfortunately, *Home*
editions of Windows do not have a policy editor, but the freely available
[Polsedit][polsedit] can be used on these editions.
1. Press Win+R, in the popup type `secpol.msc`. Then click OK.
2. In the _Local Security Policy_ window that opens, go to _Security Settings_ > _Local Policies_ > _User Rights Assignment_.
3. In the list, find the _Create Symbolic Links_ item.
4. Double-click the item and add yourself (or the user running Flamenco Manager or the whole users group) to the list.
5. Log out & back in again, or reboot the machine.
[polsedit]: https://www.southsoftware.com/polsedit.html
### Linux