Update uidmap documentation

[mtausig]

Update to the documentation how folders are shared.
Fixes the 4th box of #122

Questions for @robvdl to complete it:

There are two share related attributes defined in the schema: set_host_acl and share_properties. I couldn't figure out completely what they do (if anything at all).

set_host_acl appears to be deprecared, I couldn't find it in any python file.

share_properties is parsed in the _setup_shares method of lxdock/container.py, but I think it is just some sort of passthrough to pylxd. What can you do with it?

[codecov-io]

Codecov Report

Merging #178 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #178   +/-   ##
=======================================
  Coverage   91.41%   91.41%           
=======================================
  Files          45       45           
  Lines        1351     1351           
=======================================
  Hits         1235     1235           
  Misses        116      116

Impacted Files	Coverage Δ
lxdock/conf/schema.py	100% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f71006d...9d4f02e. Read the comment docs.

[robvdl]

I'll have to think about it as it's been a while, but I was definitely involved around the time we did the host_acl thing. As for share_properties, I'm not sure.

The host_acl setting had to do with the share and idmap thing, can't quite remember if it was deprecated, I'll have to have a look at the history and it should all come back to me.

[shuhaowu]

You shouldn't use host_acl anymore if you can do idmap. idmap is much smoother.

[mtausig]

set_host_acl is completely unused. I removed it from the schema and the documentation.

[mtausig]

You shouldn't use host_acl anymore if you can do idmap. idmap is much smoother.

I disagree here, idmaps have their drawbacks. But that' not really relevant for this PR, maybe a future discussion.

[mtausig]

What do we do with share_properties?

• Remove it, since we don't know what it is doing
• Ignore it
• Add a documentation line mentioning it without describing

[robvdl]

Note: If the PR is failing only due to codecov then it can still be merged, codecov has always been a bit sensitive and adding lots of docs probably triggers it.

The main issue with the old method (share_properties?) before we used idmap as I recall, is it recursively had to set extended permissions on each file on the share. This interfered with some things in the container, building debian packages was one of those things I had found. But something else also didn't like it, forgot what that was now sorry.

When switching to idmap, a project with existing shares should remove these extended permissions recursively. At the time (over 2 years ago) I had a command for that which should probably be in the docs as an upgrade path step, I'll need to dig it up, perhaps it is in the comment history on an old PR or issue.

[mtausig]

Note: If the PR is failing only due to codecov then it can still be merged, codecov has always been a bit sensitive and adding lots of docs probably triggers it.

"Problem" is there, because I deleted a single line of code (the obsolete item from the schema), which slightly reduced (theoretically) the coverage

[mtausig]

I suggest to merge this as is, and add an issue which tracks the unknown state of share_properties.

[mtausig]

Rebased

[mtausig]

Ping

[robvdl]

Ah yeah I'll try to fit it in the weekend, things have been a bit crazy in NZ with the country going into lockdown sorry.

[mtausig]

Ping

[mtausig]

Ping