doc/instances: Cover LXD agent installation

Signed-off-by: Simos Xenitellis <[email protected]> (cherry picked from commit f92d3d83ce67a25e6ee0aacfa804bd7167e75e52) Signed-off-by: Simon Deziel <[email protected]> License: Apache-2.0
canonical · Sep 6, 2024 · 044cd64 · 044cd64
1 parent b7d961f
commit 044cd64
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/doc/howto/instances_create.md b/doc/howto/instances_create.md
@@ -480,6 +480,30 @@ You can then upload your ISO file and install a VM from it.
 ````
 `````
 
+### Install the LXD agent into virtual machine instances
+
+In order for features like direct command execution (`lxc exec`), file transfers (`lxc file`) and detailed usage metrics (`lxc info`)
+to work properly with virtual machines, an agent software is provided by LXD.
+
+The virtual machine images from the [images](https://images.lxd.canonical.com) remote are pre-configured to load that agent on startup.
+
+For other virtual machines, you may want to manually install the agent.
+
+```{note}
+The LXD agent is currently available only on Linux virtual machines.
+```
+
+LXD provides the agent through a remote `9p` file system with mount name `config`.
+To install the agent, you'll need to get access to the virtual machine and run the following commands:
+
+    mount -t 9p config /mnt
+    cd /mnt
+    ./install.sh
+
+The first line will mount the remote file system on the mount point `/mnt`.
+The subsequent commands will run the installation script `install.sh` to install and run the LXD agent.
+You need to perform this task once.
+
 ### Create a Windows VM
 
 To create a Windows VM, you must first prepare a Windows image.