1
0
mirror of https://github.com/lxc/incus.git synced 2026-02-05 09:46:19 +01:00

doc: Add packaging instructions

Closes #156

Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
This commit is contained in:
Stéphane Graber
2023-10-18 23:59:38 -04:00
parent c0b0dcad48
commit 8d955925e6
2 changed files with 46 additions and 0 deletions

View File

@@ -6,6 +6,7 @@
daemon-behavior
Debug Incus <debugging>
Requirements </requirements>
Packaging recommendations </packaging>
environment
syscall-interception
User namespace setup <userns-idmap>

45
doc/packaging.md Normal file
View File

@@ -0,0 +1,45 @@
# Packaging recommendations
Below are a few recommendations for packagers of Incus.
Following those recommendations should provide a more predictable experience across Linux distributions.
## Packages
It's usually a good idea to at least split things into an `incus` and `incus-client` package.
The latter allows for installing just the `incus` command line tool without bringing the daemon and its dependencies.
Additionally, it may be useful to have an `incus-tools` package with some of the less commonly used tools like `fuidshift`, `lxc-to-incus`, `incus-benchmark` and `incus-migrate`.
## Groups
Two groups should be provided:
- `incus-admin` which grants access to the `unix.socket` socket and effectively grants full control over Incus.
- `incus` which grants access to the `user.socket` socket which provides users with a restricted Incus project.
## Init scripts
The following assumes the use of `systemd`. Distributions not using
`systemd` should try to stick to a similar naming scheme but will likely
see some differences on things like socket activation.
- `incus.service` is the main unit that starts and stops the `incusd` daemon.
- `incus.socket` is the socket-activation unit for the `incus.service` unit. If present, `incus.service` should not be made to start on its own.
- `incus-user.service` is the unit responsible for starting and stopping the `incus-user` daemon.
- `incus-user.socket` is the socket-activation unit for the `incus-user.service` unit. If present, `incus-user.service` should not be made to start on its own.
- `incus-startup.service` uses the `incusd activateifneeded` command to trigger daemon startup if it is required. It also calls `incusd shutdown` to handle orderly shutdown of instances on host shutdown.
## Binaries
The `incusd` and `incus-user` daemons should be kept outside of the user's `PATH`.
The same is true of `incus-agent` which needs to be available in the daemon's `PATH` but not be visible to users.
The main binary that should be made visible to users is `incus`.
On top of those, the following optional binaries may also be made available:
- `fuidshift` (should be kept to root only)
- `incus-benchmark`
- `incus-migrate`
- `lxc-to-incus`
- `lxd-to-incus` (should be kept to root only)