Update instructions for KVM

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
self-actuated · Nov 28, 2023 · d7880b0 · d7880b0
1 parent f54b8d3
commit d7880b0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/docs/examples/kvm-guest.md b/docs/examples/kvm-guest.md
@@ -12,17 +12,25 @@ There are some prerequisites to enable KVM support:
 
 1. Make sure [nested virtualization is enabled](https://ostechnix.com/how-to-enable-nested-virtualization-in-kvm-in-linux/) on the Agent host.
 
-2. Edit `/etc/default/actuated` for your Actuated Agent and add the `kvm` suffix to the `AGENT_KERNEL_REF` variable:
+2. Edit `/etc/default/actuated` on the Actuated Agent and add the `kvm` suffix to the `AGENT_KERNEL_REF` variable:
 
     ```diff
-    - AGENT_KERNEL_REF="ghcr.io/openfaasltd/actuated-kernel-5.10.77:x86-64-latest"
-    + AGENT_KERNEL_REF="ghcr.io/openfaasltd/actuated-kernel-5.10.77:x86-64-latest-kvm"
+    - AGENT_KERNEL_REF="ghcr.io/openfaasltd/actuated-kernel:x86-64-latest"
+    + AGENT_KERNEL_REF="ghcr.io/openfaasltd/actuated-kernel:x86-64-kvm-latest"
+    ```
+
+3. Also add it to the `AGENT_IMAGE_REF` line:
+
+    ```diff
+    - AGENT_IMAGE_REF="ghcr.io/openfaasltd/actuated-ubuntu22.04:x86-64-latest"
+    + AGENT_IMAGE_REF="ghcr.io/openfaasltd/actuated-ubuntu22.04:x86-64-kvm-latest"
     ```
 
 3. Restart the Agent to use the new kernel.
 
     ```bash
-    sudo systemctl restart actuated
+    sudo systemctl daemon-reload && \
+        sudo systemctl restart actuated
     ```
 
 4. Run a [test build](/test-build/) to verify KVM support is enabled in the runner. The specs script from the test build will report whether `/dev/kvm` is available.
@@ -43,7 +51,7 @@ The workflow instals Firecracker, configures and boots a guest VM and then waits
     on: push
     jobs:
     vm-run:
-        runs-on: actuated
+        runs-on: actuated-4cpu-8gb
         steps:
         - uses: actions/checkout@master
             with:

diff --git a/docs/faq.md b/docs/faq.md
@@ -172,7 +172,7 @@ The image is built automatically using GitHub Actions and is available on a cont
 
 ## What Kernel version is being used?
 
-At time of writing, actuated is using a 5.10.199 Kernel version, and will upgrade to various patch versions as they become available.
+At time of writing, actuated is using a 5.10.201 Kernel version, and will upgrade to various patch versions as they become available.
 
 As and when [newer versions are made available](https://github.com/firecracker-microvm/firecracker/tree/master/resources/guest_configs), we'll upgrade our support.