From 84ae0def49640bf0b155304bc4e1cb4d64bfd79d Mon Sep 17 00:00:00 2001 From: Glenn-Agent Date: Mon, 25 May 2026 08:56:38 +0530 Subject: [PATCH 1/2] docs: update prerequisites Docker-driver wording Signed-off-by: Glenn-Agent --- docs/get-started/prerequisites.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/get-started/prerequisites.mdx b/docs/get-started/prerequisites.mdx index 752ae926b6..cb7054b39e 100644 --- a/docs/get-started/prerequisites.mdx +++ b/docs/get-started/prerequisites.mdx @@ -19,7 +19,7 @@ Before getting started, check the prerequisites to ensure you have the necessary | RAM | 8 GB | 16 GB | | Disk | 20 GB free | 40 GB free | -The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon, k3s, and the OpenShell gateway run alongside the export pipeline. The pipeline buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance. +The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline. The pipeline buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance. ## Software @@ -52,7 +52,7 @@ Avoid `openshell self-update`, `npm update -g openshell`, `openshell gateway sta -On Linux hosts running Docker 26 or later with the [containerd image store](https://docs.docker.com/engine/storage/containerd/) enabled (the install-time default for fresh `docker-ce` installations on Ubuntu 24.04 and similar distros), `nemoclaw onboard` transparently builds a `fuse-overlayfs`-enabled cluster image to bypass a kernel-level nested-overlay limitation in k3s. +On Linux hosts running Docker 26 or later with the [containerd image store](https://docs.docker.com/engine/storage/containerd/) enabled (the install-time default for fresh `docker-ce` installations on Ubuntu 24.04 and similar distros), `nemoclaw onboard` transparently builds a `fuse-overlayfs`-enabled OpenShell gateway image to bypass a kernel-level nested-overlay limitation. No manual setup is required. See the [troubleshooting guide](/reference/troubleshooting) for the override knobs and a manual `daemon.json` alternative. From 57937702d207400332eae500769de6bb391869d6 Mon Sep 17 00:00:00 2001 From: Glenn-Agent Date: Mon, 25 May 2026 09:00:00 +0530 Subject: [PATCH 2/2] docs: align Docker-driver memory guidance Signed-off-by: Glenn-Agent --- docs/get-started/prerequisites.mdx | 6 +++++- docs/reference/troubleshooting.mdx | 5 ++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/get-started/prerequisites.mdx b/docs/get-started/prerequisites.mdx index cb7054b39e..b440edab49 100644 --- a/docs/get-started/prerequisites.mdx +++ b/docs/get-started/prerequisites.mdx @@ -19,7 +19,11 @@ Before getting started, check the prerequisites to ensure you have the necessary | RAM | 8 GB | 16 GB | | Disk | 20 GB free | 40 GB free | -The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline. The pipeline buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance. +The sandbox image is approximately 2.4 GB compressed. +During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline. +The pipeline buffers decompressed layers in memory. +On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. +If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance. ## Software diff --git a/docs/reference/troubleshooting.mdx b/docs/reference/troubleshooting.mdx index 9dce909ec4..e45e61c794 100644 --- a/docs/reference/troubleshooting.mdx +++ b/docs/reference/troubleshooting.mdx @@ -61,7 +61,10 @@ Then re-run the installer. ### Image push fails with out-of-memory errors -The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon, k3s, and the OpenShell gateway run alongside the export pipeline, which buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. +The sandbox image is approximately 2.4 GB compressed. +During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline. +The pipeline buffers decompressed layers in memory. +On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configure at least 8 GB of swap to work around the issue at the cost of slower performance.