Skip to content

Commit 5b0bdd3

Browse files
ctalledorodnymolina
authored andcommitted
Reduced host requirements section; moved some text to troubleshooting section.
1 parent 1303bc7 commit 5b0bdd3

File tree

2 files changed

+43
-22
lines changed

2 files changed

+43
-22
lines changed

Diff for: README.md

+1-22
Original file line numberDiff line numberDiff line change
@@ -80,28 +80,7 @@ The Linux host on which sysboxd runs must meet the following requirements:
8080

8181
2) Docker must be installed on the host machine.
8282

83-
3) The host's kernel must be configured to allow unprivileged users
84-
to create namespaces. For Ubuntu:
85-
86-
```
87-
sudo sh -c "echo 1 > /proc/sys/kernel/unprivileged_userns_clone"
88-
```
89-
90-
**Note:** This instruction will be *automatically* executed by the
91-
Sysboxd package installer, so there is no need for the user to
92-
manually type it.
93-
94-
4) Sysboxd stores some internal state in `/var/lib/sysboxd`. This directory
95-
must be on one of the following filesystems:
96-
97-
* ext4
98-
* btrfs
99-
100-
The same requirement applies to the `/var/lib/docker` directory.
101-
102-
This is normally the case for vanilla Ubuntu installations.
103-
104-
5) If the host runs Ubuntu-Bionic, you'll need to update the Linux kernel to
83+
3) If the host runs Ubuntu-Bionic, you'll need to update the Linux kernel to
10584
5.X+ (unless you enable docker [userns-remap](docs/usage.md#interaction-with-docker-userns-remap)).
10685

10786
Note that you must use the Ubuntu 5.X+ kernel, **not** the Linux

Diff for: docs/troubleshoot.md

+42
Original file line numberDiff line numberDiff line change
@@ -169,3 +169,45 @@ To solve this problem, load the Nestybox Shiftfs module as described [here](http
169169
Note that normally the Sysboxd installer loads this module into the
170170
kernel, so this error implies that either the installer did not
171171
succeed or that the module was somehow unloaded since then.
172+
173+
## Unprivileged User Namespace Creation Error
174+
175+
When creating a system container, Docker may report the following error:
176+
177+
```bash
178+
docker run --runtime=sysbox-runc -it ubuntu:latest
179+
docker: Error response from daemon: OCI runtime create failed: host is not configured properly: kernel is not configured to allow unprivileged users to create namespaces: /proc/sys/kernel/unprivileged_userns_clone: want 1, have 0: unknown.
180+
```
181+
182+
This means that the host's kernel is not configured to allow unprivileged users
183+
to create user namespaces.
184+
185+
For Ubuntu, fix this with:
186+
187+
```
188+
sudo sh -c "echo 1 > /proc/sys/kernel/unprivileged_userns_clone"
189+
```
190+
191+
**Note:** The Sysboxd package installer automatically executes this
192+
instruction, so normally there is no need to do this configuration
193+
manually.
194+
195+
## Failed to Setup Docker Volume Manager Error
196+
197+
When creating a system container, Docker may report the following error:
198+
199+
```bash
200+
docker run --runtime=sysbox-runc -it ubuntu:latest
201+
docker: Error response from daemon: OCI runtime create failed: failed to setup docker volume manager: host dir for docker store /var/lib/sysboxd/docker can't be on ..."
202+
```
203+
204+
This means that directory `/var/lib/sysboxd` is on a filesystem not supported by Sysboxd.
205+
206+
This directory must be on one of the following filesystems:
207+
208+
* ext4
209+
* btrfs
210+
211+
The same requirement applies to the `/var/lib/docker` directory.
212+
213+
This is normally the case for vanilla Ubuntu installations.

0 commit comments

Comments
 (0)