diff --git a/docs/admin/templates/troubleshooting.md b/docs/admin/templates/troubleshooting.md index a0daa23f1454d..b439b3896d561 100644 --- a/docs/admin/templates/troubleshooting.md +++ b/docs/admin/templates/troubleshooting.md @@ -170,3 +170,59 @@ See our to optimize your templates based on this data. ![Workspace build timings UI](../../images/admin/templates/troubleshooting/workspace-build-timings-ui.png) + +## Docker Workspaces on Raspberry Pi OS + +### Unable to query ContainerMemory + +When you query `ContainerMemory` and encounter the error: + +```shell +open /sys/fs/cgroup/memory.max: no such file or directory +``` + +This error mostly affects Raspberry Pi OS, but might also affect older Debian-based systems as well. + +
Add cgroup_memory and cgroup_enable to cmdline.txt: + +1. Confirm the list of existing cgroup controllers doesn't include `memory`: + + ```console + $ cat /sys/fs/cgroup/cgroup.controllers + cpuset cpu io pids + + $ cat /sys/fs/cgroup/cgroup.subtree_control + cpuset cpu io pids + ``` + +1. Add cgroup entries to `cmdline.txt` in `/boot/firmware` (or `/boot/` on older Pi OS releases): + + ```text + cgroup_memory=1 cgroup_enable=memory + ``` + + You can use `sed` to add it to the file for you: + + ```bash + sudo sed -i '$s/$/ cgroup_memory=1 cgroup_enable=memory/' /boot/firmware/cmdline.txt + ``` + +1. Reboot: + + ```bash + sudo reboot + ``` + +1. Confirm that the list of cgroup controllers now includes `memory`: + + ```console + $ cat /sys/fs/cgroup/cgroup.controllers + cpuset cpu io memory pids + + $ cat /sys/fs/cgroup/cgroup.subtree_control + cpuset cpu io memory pids + ``` + +Read more about cgroup controllers in [The Linux Kernel](https://docs.kernel.org/admin-guide/cgroup-v2.html#controlling-controllers) documentation. + +
diff --git a/docs/images/install/coder-setup.png b/docs/images/install/coder-setup.png deleted file mode 100644 index 67cc4c5bc9992..0000000000000 Binary files a/docs/images/install/coder-setup.png and /dev/null differ diff --git a/docs/images/screenshots/welcome-create-admin-user.png b/docs/images/screenshots/welcome-create-admin-user.png index de78b48c7ea26..fcb099bf888d2 100644 Binary files a/docs/images/screenshots/welcome-create-admin-user.png and b/docs/images/screenshots/welcome-create-admin-user.png differ diff --git a/docs/install/cli.md b/docs/install/cli.md index 9c68734c389b4..9dbd51e2c3638 100644 --- a/docs/install/cli.md +++ b/docs/install/cli.md @@ -49,7 +49,7 @@ To start the Coder server: coder server ``` -![Coder install](../images/install/coder-setup.png) +![Coder install](../images/screenshots/welcome-create-admin-user.png) To log in to an existing Coder deployment: diff --git a/docs/install/index.md b/docs/install/index.md index 100095c7ce3c3..46476de0d22bb 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -60,7 +60,7 @@ To start the Coder server: coder server ``` -![Coder install](../images/install/coder-setup.png) +![Coder install](../images/screenshots/welcome-create-admin-user.png) To log in to an existing Coder deployment: