1
- Nestybox Sysboxd
2
- ================
1
+ Sysbox: System Container Runtime
2
+ ================================
3
3
4
4
## About Nestybox
5
5
@@ -18,20 +18,20 @@ efficient, and easy-to-use alternative to virtual machines for
18
18
deploying virtual hosts on Linux. And for this work out-of-the-box and
19
19
securely, without complex configurations or hacks.
20
20
21
- ## About Sysboxd
21
+ ## About Sysbox
22
22
23
- Sysboxd is software that installs on a Linux host and integrates with Docker,
23
+ Sysbox is software that installs on a Linux host and integrates with Docker,
24
24
enabling Docker to create [ system containers] ( docs/system-containers.md ) .
25
25
26
- Users do not normally interact with Sysboxd directly. Instead, users
26
+ Users do not normally interact with Sysbox directly. Instead, users
27
27
create system containers with Docker. See [ Usage] ( #usage ) below for more info.
28
28
29
29
## Features
30
30
31
31
** NOTE** : It's early days for Nestybox, so our system containers
32
32
support a reduced set of features and use-cases at this time.
33
33
34
- Below is a list of features currently supported by Sysboxd . Please
34
+ Below is a list of features currently supported by Sysbox . Please
35
35
see our [ Roadmap] ( #roadmap ) for a list of features we are working on.
36
36
37
37
### Deployment
@@ -93,7 +93,7 @@ We plan to add support for more distros in the future.
93
93
94
94
## Host Requirements
95
95
96
- The Linux host on which Sysboxd runs must meet the following requirements:
96
+ The Linux host on which Sysbox runs must meet the following requirements:
97
97
98
98
1 ) Systemd must be running as the system's process-manager.
99
99
@@ -113,20 +113,20 @@ The Linux host on which Sysboxd runs must meet the following requirements:
113
113
114
114
## Installation
115
115
116
- 1 ) Download the latest package from the [ release] ( https://github.com/nestybox/sysboxd -external/releases ) page.
116
+ 1 ) Download the latest package from the [ release] ( https://github.com/nestybox/sysbox -external/releases ) page.
117
117
118
118
2 ) Verify that the checksum of the downloaded file fully matches the expected/published one.
119
119
For example:
120
120
121
121
``` bash
122
- $ sha256sum ~ /sysboxd_0 .0.1-0~ubuntu-bionic_amd64.deb
123
- 2a02898dc53b4751cf413464b977f5b296d9aac3c5b477e05272bfa881d69cfc /home/user/sysboxd_0 .0.1-0~ubuntu-bionic_amd64.deb
122
+ $ sha256sum ~ /sysbox_0 .0.1-0~ubuntu-bionic_amd64.deb
123
+ 2a02898dc53b4751cf413464b977f5b296d9aac3c5b477e05272bfa881d69cfc /home/user/sysbox_0 .0.1-0~ubuntu-bionic_amd64.deb
124
124
```
125
125
126
- 3 ) Install the Sysboxd package:
126
+ 3 ) Install the Sysbox package:
127
127
128
128
``` bash
129
- $ sudo dpkg -i sysboxd_0 .0.1-0~ubuntu-bionic_amd64.deb
129
+ $ sudo dpkg -i sysbox_0 .0.1-0~ubuntu-bionic_amd64.deb
130
130
```
131
131
132
132
In case you hit an error with missing dependencies, fix this with:
@@ -136,28 +136,28 @@ $ sudo apt-get install -f -y
136
136
```
137
137
138
138
This will install the missing dependencies and automatically re-launch
139
- the Sysboxd installation process.
139
+ the Sysbox installation process.
140
140
141
141
142
- 4 ) Verify that Sysboxd 's systemd units have been properly installed, and
142
+ 4 ) Verify that Sysbox 's systemd units have been properly installed, and
143
143
associated daemons are properly running:
144
144
145
145
```
146
146
$ systemctl list-units -t service --all | grep sysbox
147
147
sysbox-fs.service loaded active running sysbox-fs component
148
148
sysbox-mgr.service loaded active running sysbox-mgr component
149
- sysboxd .service loaded active exited Sysboxd General Service
149
+ sysbox .service loaded active exited Sysbox General Service
150
150
```
151
151
152
- Note: the sysboxd .service is ephemeral (it exits once it launches the other sysboxd services).
152
+ Note: the sysbox .service is ephemeral (it exits once it launches the other sysbox services).
153
153
154
- If you are curious on what the other Sysboxd services are, refer to the [ Sysboxd design document] ( docs/design.md ) .
154
+ If you are curious on what the other Sysbox services are, refer to the [ Sysbox design document] ( docs/design.md ) .
155
155
156
156
If you hit problems during installation, see the [ Troubleshooting document] ( docs/troubleshoot.md ) .
157
157
158
158
## Usage
159
159
160
- To launch a system container with Docker, point Docker to the Sysboxd container
160
+ To launch a system container with Docker, point Docker to the Sysbox container
161
161
runtime, using the ` --runtime=sysbox-runc ` option:
162
162
163
163
``` bash
@@ -173,8 +173,8 @@ It's perfectly fine to run system containers along side with regular
173
173
Docker application containers on the host at the same time; they won't
174
174
conflict.
175
175
176
- Refer to the [ Sysboxd User's Guide] ( docs/usage.md ) for other ways to
177
- run system containers with Sysboxd .
176
+ Refer to the [ Sysbox User's Guide] ( docs/usage.md ) for other ways to
177
+ run system containers with Sysbox .
178
178
179
179
If you hit problems with the instructions above, see the
180
180
[ Troubleshooting document] ( docs/troubleshoot.md ) .
@@ -196,27 +196,27 @@ See [here](docs/usage.md#running-software-inside-the-system-container) for more
196
196
197
197
## Integration with Container Managers
198
198
199
- Sysboxd is designed to work with Docker / containerd.
199
+ Sysbox is designed to work with Docker / containerd.
200
200
201
201
We don't yet support other container managers (e.g., cri-o).
202
202
203
203
## Design
204
204
205
- For more detailed info about Sysboxd 's design, refer to the
206
- [ Sysboxd design document] ( docs/design.md ) .
205
+ For more detailed info about Sysbox 's design, refer to the
206
+ [ Sysbox design document] ( docs/design.md ) .
207
207
208
208
## OCI Compatibility
209
209
210
- Sysboxd is a fork of the [ OCI runc] ( https://github.com/opencontainers/runc ) . It is mostly
210
+ Sysbox is a fork of the [ OCI runc] ( https://github.com/opencontainers/runc ) . It is mostly
211
211
(but not 100%) compatible with the OCI runtime specification. See [ here] ( docs/design.md#oci-compatibility )
212
212
for a list of incompatibilities.
213
213
214
214
We believe these incompatibilities won't negatively affect users of
215
- Sysboxd and should mostly be transparent to them.
215
+ Sysbox and should mostly be transparent to them.
216
216
217
217
## Production Readiness
218
218
219
- Sysboxd is still in Beta. It's stable, but not production ready yet.
219
+ Sysbox is still in Beta. It's stable, but not production ready yet.
220
220
221
221
## Troubleshooting
222
222
@@ -227,12 +227,12 @@ Refer to the [Troubleshooting document](docs/troubleshoot.md).
227
227
We apologize for any problems in the product or documentation, and we appreciate
228
228
customers filing issues that help us improve them.
229
229
230
- To file issues with Sysboxd (e.g., bugs, feature requests, documentation changes, etc.),
230
+ To file issues with Sysbox (e.g., bugs, feature requests, documentation changes, etc.),
231
231
please refer to the [ issue guidelines] ( docs/issue-guidelines.md ) document.
232
232
233
233
## Roadmap
234
234
235
- The following is a list of features in the Sysboxd roadmap.
235
+ The following is a list of features in the Sysbox roadmap.
236
236
237
237
We list these here so that our users can get a better idea of where we
238
238
are going and can give us feedback on which of these they like best
@@ -259,7 +259,7 @@ Here is the list:
259
259
260
260
## Feedback
261
261
262
- We love feedback, as it helps us improve Sysboxd and set its future
262
+ We love feedback, as it helps us improve Sysbox and set its future
263
263
direction.
264
264
265
265
We would much appreciate if you would take a couple of minutes to
@@ -269,20 +269,20 @@ https://www.surveymonkey.com/r/SH8HMGY
269
269
270
270
## Uninstallation
271
271
272
- Prior to uninstalling Sysboxd , make sure all system containers are removed.
272
+ Prior to uninstalling Sysbox , make sure all system containers are removed.
273
273
There is a simple shell script to do this [ here] ( scr/rm_all_syscont ) .
274
274
275
- 1 ) Uninstall Sysboxd binaries:
275
+ 1 ) Uninstall Sysbox binaries:
276
276
277
277
``` bash
278
- $ sudo dpkg --remove sysboxd
278
+ $ sudo dpkg --remove sysbox
279
279
```
280
280
281
281
Alternatively, remove the above items plus all the associated
282
282
configuration and systemd files (recommended):
283
283
284
284
``` bash
285
- $ sudo dpkg --purge sysboxd
285
+ $ sudo dpkg --purge sysbox
286
286
```
287
287
288
288
2 ) Unload the ` nbox_shiftfs ` module:
@@ -291,10 +291,10 @@ $ sudo dpkg --purge sysboxd
291
291
$ sudo rmmod nbox_shiftfs
292
292
```
293
293
294
- 3 ) Finally remove the ` sysboxd ` user from the system:
294
+ 3 ) Finally remove the ` sysbox ` user from the system:
295
295
296
296
``` bash
297
- $ sudo userdel sysboxd
297
+ $ sudo userdel sysbox
298
298
```
299
299
300
300
## Contact
@@ -304,7 +304,7 @@ be happy to help.
304
304
305
305
## Thank You!
306
306
307
- We thank you ** very much** for using Sysboxd . We hope you find it useful.
307
+ We thank you ** very much** for using Sysbox . We hope you find it useful.
308
308
309
309
Your trust in us is very much appreciated.
310
310
0 commit comments