@@ -3,18 +3,25 @@ Nestybox Sysboxd
3
3
4
4
## About Nestybox
5
5
6
- Nestybox is re-imagining server virtualization .
6
+ Nestybox expands the power of Linux containers .
7
7
8
- We are developing software solutions that improve efficiency,
9
- performance, portability, and security over current Linux container
10
- and server virtualization technologies.
8
+ We are developing software that enables deployment of ** system containers**
9
+ with Docker (and soon Kubernetes).
10
+
11
+ A system container is a Linux container designed to run low-level system
12
+ software, not just applications. See [ here] ( docs/system-containers.md ) for more info on system
13
+ containers and the use cases we envision for them.
14
+
15
+ Our mission is to make system containers run as many system-level
16
+ workload types as possible in order to provide users a fast,
17
+ efficient, and easy-to-use alternative to virtual machines for
18
+ deploying virtual hosts on Linux. And for this work out-of-the-box and
19
+ securely, without complex configurations or hacks.
11
20
12
21
## About Sysboxd
13
22
14
23
Sysboxd is software that installs on a Linux host and integrates with Docker,
15
- enabling Docker to create ** system containers** . See [ here] ( docs/system-containers.md )
16
- for a description of what a system container is and the use cases
17
- we envision for them.
24
+ enabling Docker to create [ system containers] ( docs/system-containers.md ) .
18
25
19
26
Users do not normally interact with Sysboxd directly. Instead, users
20
27
create system containers with Docker. See [ Usage] ( #usage ) below for more info.
@@ -24,22 +31,27 @@ create system containers with Docker. See [Usage](#usage) below for more info.
24
31
** NOTE** : It's early days for Nestybox, so our system containers
25
32
support a reduced set of features and use-cases at this time.
26
33
27
- Below is a list of features currently supported by sysboxd . Please
34
+ Below is a list of features currently supported by Sysboxd . Please
28
35
see our [ Roadmap] ( #roadmap ) for a list of features we are working on.
29
36
30
37
### Deployment
31
38
32
39
* Supports deployment of system containers with Docker.
33
40
34
- * System containers can run concurrently with regular Docker
35
- containers, without conflict.
41
+ * The system containers can run concurrently with regular Docker
42
+ application containers, without conflict.
36
43
37
44
### System Container Software
38
45
39
46
* Supports running Docker inside the system container.
40
47
41
- - Cleanly & securely, without using privileged containers or
42
- bind-mounting the host's Docker socket into the container.
48
+ - Cleanly & securely, with total isolation between the Docker inside
49
+ the container and the Docker on the host. No need to use insecure
50
+ privileged containers, or to bind-mount the host's Docker socket
51
+ into the container.
52
+
53
+ - The Docker inside the system container can build and run
54
+ containers as usual.
43
55
44
56
- This is useful for testing & CI/CD use cases.
45
57
@@ -51,12 +63,19 @@ see our [Roadmap](#roadmap) for a list of features we are working on.
51
63
user-ID and group-ID mappings for increased container-to-host and
52
64
container-to-container isolation.
53
65
54
- * Exposes a partially virtualized procfs (` /proc ` ) to the container.
66
+ * Resource isolation
67
+
68
+ - Programs inside the system container (e.g., Docker) are limited
69
+ to using the resources given to the system container itself.
55
70
56
- - This makes the container more closely resemble a real host.
71
+ * Partially virtualized procfs
57
72
58
- - Prevents processes within the container from changing global kernel
59
- settings via ` /proc ` .
73
+ - Processes inside the system container see a partially virtualized ` /proc ` .
74
+
75
+ - This makes the system container more closely resemble a real host.
76
+
77
+ - Prevents processes within the container from changing global
78
+ kernel settings.
60
79
61
80
## Supported Linux Distros
62
81
@@ -74,7 +93,7 @@ We plan to add support for more distros in the future.
74
93
75
94
## Host Requirements
76
95
77
- The Linux host on which sysboxd runs must meet the following requirements:
96
+ The Linux host on which Sysboxd runs must meet the following requirements:
78
97
79
98
1 ) Systemd must be running as the system's process-manager.
80
99
@@ -96,7 +115,8 @@ The Linux host on which sysboxd runs must meet the following requirements:
96
115
97
116
1 ) Download the latest package from the [ release] ( https://github.com/nestybox/sysboxd-external/releases ) page.
98
117
99
- 2 ) Verify that the checksum of the downloaded file fully matches the expected/published one:
118
+ 2 ) Verify that the checksum of the downloaded file fully matches the expected/published one.
119
+ For example:
100
120
101
121
``` bash
102
122
$ sha256sum ~ /sysboxd_0.0.1-0~ubuntu-bionic_amd64.deb
@@ -129,7 +149,7 @@ sysbox-mgr.service loaded active running sysbox-mgr compon
129
149
sysboxd.service loaded active exited Sysboxd General Service
130
150
```
131
151
132
- The sysboxd.service is ephemeral (it exits once it launches the other sysboxd services).
152
+ Note: the sysboxd.service is ephemeral (it exits once it launches the other sysboxd services).
133
153
134
154
If you are curious on what the other Sysboxd services are, refer to the [ Sysboxd design document] ( docs/design.md ) .
135
155
@@ -167,8 +187,12 @@ that runs in a regular Docker container. In addition, it runs
167
187
system-level software that does not run in a regular Docker container.
168
188
169
189
For system-level software, we currently only support running Docker
170
- inside the system container. See [ here] ( docs/usage.md#running-software-inside-the-system-container )
171
- for more info on this.
190
+ inside the system container. This allows you to build and run Docker
191
+ application containers inside the system container, just as you would
192
+ on a physical host or in a VM. It's useful in CI/CD pipelines where
193
+ the need for a container to build another container arises often.
194
+
195
+ See [ here] ( docs/usage.md#running-software-inside-the-system-container ) for more info on this.
172
196
173
197
## Integration with Container Managers
174
198
0 commit comments