Skip to content

Commit

Permalink
doc: Add INCUS_AGENT_PATH
Browse files Browse the repository at this point in the history
Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
  • Loading branch information
stgraber committed Jan 24, 2024
1 parent 07c74ed commit 6c312c8
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Name | Description

Name | Description
:--- | :----
`INCUS_AGENT_PATH` | Path to the directory including the `incus-agent` builds
`INCUS_CLUSTER_UPDATE` | Script to call on a cluster update
`INCUS_DEVMONITOR_DIR` | Path to be monitored by the device monitor. This is primarily for testing
`INCUS_DOCUMENTATION` | Path to the documentation to serve through the web server
Expand Down
20 changes: 20 additions & 0 deletions doc/packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,23 @@ On top of those, the following optional binaries may also be made available:
- `incus-migrate`
- `lxc-to-incus`
- `lxd-to-incus` (should be kept to root only)


## Incus agent binaries

There are two ways to provide the `incus-agent` binary.

### Single agent setup

The simplest way is to have `incus-agent` be available in the `PATH` of `incusd`.

In this scenario the agent should be a static build of `incus-agent` for the primary architecture of the system.

### Multiple agent setup

Alternatively, it's possible to provide multiple builds of the `incus-agent` binary, offering support for multiple architectures or operating systems.

To do that, the `INCUS_AGENT_PATH` environment variable should be set for the `incusd` process and point to a path that includes the `incus-agent` builds.

Those builds should be named after the operating system name and architecture.
For example `incus-agent.linux.x86_64`, `incus-agent.linux.i686` or `incus-agent.linux.aarch64`.

0 comments on commit 6c312c8

Please sign in to comment.