config/containers-and-vms/lxc: document incus

[duskmoss]

Incus is the current community tool for easy LXC administration. LXD has been moved to canonical, relicensed (Apache 2.0 to AGPL3) and contributors are asked to sign a CLA.

LXD package in repos is out of date, but incus is up to date. I thought we should have docs for this package.

For now I've left the LXD section in as ahesford recommended on IRC.

[classabbyamp]

mostly copyediting review as I don't know much about incus

[0x5c]

Note that incus-user will initialize the default incus profile when it is started. To avoid default configuration initialize incus for youself with incus admin init before enabling incus-user.

I spent multiple days trying to figure out what was going on with incus automatically creating a new zfs pool, thanks for saving me from going mad :D

[0x5c]

There's two remaining bits of documentation in the README.voidlinux file that if added here would render it completely unnecessary.

The root user should also be assigned a range of subordinate user and group IDs to be mapped in
containers.
For example, the command

usermod --add-subuids 1000000-1065535 \
	--add-subgids 1000000-1065535 root

will assign a range of 65,536 IDs for users and groups.

The sub{u,g}id stuff is mentioned vaguely (with different values and the manual method) in the LXC section, but there's no indication that one would need to follow the instruction in the LXC section, nor good indication at to what it means in practice Maybe this could be refactored into a section that both the LXC and Incus sections link to.

Optional dependencies:

To run virtual machines, install qemu and edk2-ovmf.
To run OCI containers, install spokeo and umoci.

[duskmoss]

There's two remaining bits of documentation in the README.voidlinux file that if added here would render it completely unnecessary.

IIRC I didn't include the Subuids/gids info because it's actually not neccesary, these are setup in void by default. I did make a lot to remove from the readme but maintainer wanted to keep.

[0x5c]

Interesting, the only range that was setup without my intervention was for my user, not root. What part of void would be setting that up automatically?

[duskmoss]

https://github.com/void-linux/void-packages/blob/master/srcpkgs/base-files/files/subgid

[0x5c]

Weirdly, that was added 5 years ago and my install is not that old, I guess something to investigate separately from this issue

[duskmoss]

I'll try and confirm at some point, but eitherway, it's in the readme.

I think optional dependencies should stay in the readme, it's much easier to update them when the package is updated than keeping the documentation in sync. And it's the standard place for void, like with the steam package.

I'll get the edits talked about here worked on either today or tomorrow.

[classabbyamp]

I think optional dependencies should stay in the readme, it's much easier to update them when the package is updated than keeping the documentation in sync.

a pr to void-docs updating that kind of thing can be merged quickly, but it is also valuable to have them in README.voidlinux for history.

Can we put them in both places?

[duskmoss]

Sure

[classabbyamp]

and btw, commit message should be config/containers-and-vms/lxc: document incus or something like that

[duskmoss]

and btw, commit message should be config/containers-and-vms/lxc: document incus or something like that

Thanks! Maybe the contribution docs should be more clear about what you want for because path, and file name with extension removed is not something I would have gotten from