From 6c312c813f9f686d789fb0431019e6537205abfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Graber?= Date: Tue, 23 Jan 2024 15:19:56 -0500 Subject: [PATCH] doc: Add INCUS_AGENT_PATH MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Stéphane Graber --- doc/environment.md | 1 + doc/packaging.md | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/doc/environment.md b/doc/environment.md index 129bae0da72..5a325ce7f5a 100644 --- a/doc/environment.md +++ b/doc/environment.md @@ -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 diff --git a/doc/packaging.md b/doc/packaging.md index d2840f054e6..3eb18a6ec18 100644 --- a/doc/packaging.md +++ b/doc/packaging.md @@ -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`. \ No newline at end of file