Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 6a28af4

Browse files
committed
Made final adjustments to Installation documentation.
1 parent 224d75a commit 6a28af4

File tree

2 files changed

+34
-56
lines changed

2 files changed

+34
-56
lines changed

README.md

Lines changed: 14 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -97,42 +97,28 @@ It's very easy:
9797
For example:
9898

9999
```console
100-
$ sha256sum sysbox_0.1.3-0.ubuntu-disco_amd64.deb
101-
774aa1442c9142a1e6c6db49f896439b989de3668926bccd91aa0a679fa3df87 sysbox_0.1.3-0.ubuntu-disco_amd64.deb
100+
$ sha256sum sysbox_0.2.0-0.ubuntu-focal_amd64.deb
101+
1e171a58f21ad8bd427af3186f5f331a466350f02ce6a66c7e8b723c2764e33c sysbox_0.2.0-0.ubuntu-focal_amd64.deb
102102
```
103103

104-
3) Stop all running Docker containers (as the installer may need to restart Docker).
104+
3) Stop and eliminate all running Docker containers. Refer to the
105+
[detailed](docs/user-guide/install.md) installation process for information
106+
on how to avoid impacting existing containers.
105107

106-
4) Install the Sysbox package and follow the installer instructions:
107-
108-
```console
109-
$ sudo dpkg -i sysbox_0.1.3-0.ubuntu-disco_amd64.deb
110108
```
111-
112-
In case you hit an error with missing dependencies, fix this with:
113-
114-
```console
115-
$ sudo apt-get update
116-
$ sudo apt-get install -f -y
109+
$ docker stop $(docker ps -a -q) && docker container prune -f
117110
```
118111

119-
This will install the missing dependencies and automatically re-launch
120-
the Sysbox installation process.
112+
If an error is returned, it simply indicates that no existing containers were
113+
found.
121114

122-
5) Verify that Sysbox's Systemd units have been properly installed, and
123-
associated daemons are properly running:
115+
4) Install the Sysbox package and follow the installer instructions:
124116

125117
```console
126-
$ systemctl list-units -t service --all | grep sysbox
127-
sysbox-fs.service loaded active running sysbox-fs component
128-
sysbox-mgr.service loaded active running sysbox-mgr component
129-
sysbox.service loaded active exited Sysbox General Service
118+
$ sudo apt-get install ./sysbox_0.2.0-0.ubuntu-focal_amd64.deb -y
130119
```
131120

132-
Note: the sysbox.service is ephemeral (it exits once it launches the other sysbox services; that's why
133-
you see `sysbox.service loaded active exited` above).
134-
135-
More info on the installation process can be found [here](docs/user-guide/install.md).
121+
More information on the installation process can be found [here](docs/user-guide/install.md).
136122

137123
If you run into problems during install, see the [troubleshooting doc](docs/user-guide/troubleshoot.md).
138124

@@ -358,17 +344,11 @@ answer the following survey:
358344
Prior to uninstalling Sysbox, make sure all system containers are removed.
359345
There is a simple shell script to do this [here](scr/rm_all_syscont).
360346

361-
1) Uninstall Sysbox binaries:
362-
363-
```console
364-
$ sudo dpkg --remove sysbox
365-
```
366-
367-
Alternatively, remove the above items plus all the associated
368-
configuration and Systemd files (recommended):
347+
1) Uninstall Sysbox binaries plus all the associated configuration and Systemd
348+
files:
369349

370350
```console
371-
$ sudo dpkg --purge sysbox
351+
$ sudo apt-get purge sysbox -y
372352
```
373353

374354
2) Remove the `sysbox` user from the system:

docs/user-guide/install.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,32 @@ The Linux host on which Sysbox runs must meet the following requirements:
2828
For example:
2929

3030
```console
31-
$ sha256sum sysbox_0.1.3-0.ubuntu-disco_amd64.deb
32-
774aa1442c9142a1e6c6db49f896439b989de3668926bccd91aa0a679fa3df87 sysbox_0.1.3-0.ubuntu-disco_amd64.deb
31+
$ sha256sum sysbox_0.2.0-0.ubuntu-focal_amd64.deb
32+
1e171a58f21ad8bd427af3186f5f331a466350f02ce6a66c7e8b723c2764e33c sysbox_0.2.0-0.ubuntu-focal_amd64.deb
3333
```
3434

35-
3) Stop all running Docker containers.
35+
3) In scenarios where kernel carries `shiftfs` module, there is no need to stop
36+
and eliminate existing containers prior to Sysbox installation. Sysbox's installer
37+
will seamlessly complete the installation process without service disruption.
3638

37-
4) Install the Sysbox package and follow the installer instructions:
39+
On the other hand, if `shiftfs` module is missing, Sysbox installer may require
40+
a Docker Service restart. In this scenario (see [userns-remap](#docker-userns-remap) mode), if Docker is not already operating in
41+
`userns-remap` mode, we encourage users to stop and remove existing containers
42+
before launching the Sysbox installer:
3843

39-
```console
40-
$ sudo dpkg -i sysbox_0.1.3-0.ubuntu-disco_amd64.deb
44+
```
45+
$ docker stop $(docker ps -a -q) && docker container prune -f
4146
```
4247

43-
In case you hit an error with missing dependencies, fix this with:
48+
If an error is returned, it simply indicates that no existing containers were
49+
found.
50+
51+
4) Install the Sysbox package and follow the installer instructions:
4452

4553
```console
46-
$ sudo apt-get update
47-
$ sudo apt-get install -f -y
54+
$ sudo apt-get install ./sysbox_0.2.0-0.ubuntu-focal_amd64.deb -y
4855
```
4956

50-
This will install the missing dependencies and automatically re-launch
51-
the Sysbox installation process.
52-
5357
5) Verify that Sysbox's Systemd units have been properly installed, and
5458
associated daemons are properly running:
5559

@@ -114,7 +118,7 @@ The installer uses the following logic:
114118

115119
If Docker needs to be placed in userns-remap, the Sysbox installer will check if
116120
Docker is already in this mode (by looking for `userns-remap` in
117-
`/etc/docker/daemon.json`). If so, no further action is required.
121+
`/etc/docker/daemon.json` and `userns` entry in `docker info` output). If so, no further action is required.
118122

119123
Otherwise, the Sysbox installer will add the following `userns-remap` entry to the
120124
`/etc/docker/daemon.json` file:
@@ -152,17 +156,11 @@ keep in mind:
152156
Prior to uninstalling Sysbox, make sure all system containers are removed.
153157
There is a simple shell script to do this [here](../../scr/rm_all_syscont).
154158

155-
1) Uninstall Sysbox binaries:
156-
157-
```console
158-
$ sudo dpkg --remove sysbox
159-
```
160-
161-
Alternatively, remove the above items plus all the associated
162-
configuration and Systemd files (recommended):
159+
1) Uninstall Sysbox binaries plus all the associated configuration and Systemd
160+
files:
163161

164162
```console
165-
$ sudo dpkg --purge sysbox
163+
$ sudo apt-get purge sysbox -y
166164
```
167165

168166
2) Remove the `sysbox` user from the system:

0 commit comments

Comments
 (0)