add cache.shared config reference and use case#971
Conversation
|
One more user asked about it on discord and so, as usual, I went to check the docs and noticed that there was nothing about it because I've just created a ticket a year ago and didn't send a PR. @jorgeorpinel you've spoiled me with great docs! 😄 So I've decided to send a PR right away, so I don't forget about it, will get back to it soon. |
|
|
||
| - `cache.shared` - permissions for newly created or downloaded cache files and | ||
| directories. The default permissions are `0o664`(rw-r--r--) for files and | ||
| `0o755`(rwxr-xr-x) for directories. The only accepted value right now is |
There was a problem hiding this comment.
Is presenting permissions in such way clear enough? I'm not sure if it is too hard to understand, maybe we are better describing it with words to make it as friendly as possible?
| ```dvc | ||
| $ sudo find /path/to/dvc-cache -type f -exec chmod 0664 {} \; | ||
| $ sudo find /path/to/dvc-cache -type d -exec chmod 0775 {} \; | ||
| $ sudo chown -R myuser:ourgroup /path/to/dvc-cache/ |
There was a problem hiding this comment.
Needs clarification that the user needs to use his username and his group, that he shares with his team. Also sudo is probably also something that we need to describe better, as it might require asking devops guys or something, not sure if usually DS teams have sudo access on their servers.
| And tell DVC to set group permissions on the newly created/downloaded cache | ||
| files: | ||
|
|
||
| ```dvc | ||
| $ dvc config cache.shared group | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The reason why it wasn't needed before is that I've assumed that people will just create their files with proper group permissions and so our cache files won't need any changes. That was clearly too much to ask, so we now do it explicitly.
| - `cache.shared` - permissions for newly created or downloaded cache files and | ||
| directories. The default permissions are `0o664`(rw-r--r--) for files and | ||
| `0o755`(rwxr-xr-x) for directories. The only accepted value right now is | ||
| `group`, which makes dvc use `0o664`(rw-rw-r--) for files and |
shcheklein
left a comment
shcheklein
left a comment
There was a problem hiding this comment.
just a minor change and I'll merge it :) looks good to me
|
Thanks @efiop! |
3 participants
Fixes #497
❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.
🐛 Please make sure to mention
Fix #issue(if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.Please chose to
allow us
to edit your branch when creating the PR.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏