2
2
3
3
## Contents
4
4
5
- - [ Introduction] ( #introduction )
6
- - [ Free for Individual Developers, Paid for Enterprise] ( #free-for-individual-developers-paid-for-enterprise )
7
- - [ Key Features] ( #key-features )
8
- - [ Videos] ( #videos )
9
- - [ Download] ( #download )
10
- - [ Supported Distros] ( #supported-distros )
11
- - [ Host Requirements] ( #host-requirements )
12
- - [ Installing Sysbox] ( #installing-sysbox )
13
- - [ Using Sysbox] ( #using-sysbox )
14
- - [ Documentation] ( #documentation )
15
- - [ Integration with Container Managers] ( #integration-with-container-managers )
16
- - [ Troubleshooting] ( #troubleshooting )
17
- - [ Filing Issues] ( #filing-issues )
18
- - [ Support] ( #support )
19
- - [ We want your feedback] ( #we-want-your-feedback )
20
- - [ Uninstallation] ( #uninstallation )
21
- - [ About Nestybox] ( #about-nestybox )
22
- - [ Contact] ( #contact )
23
- - [ Thank You] ( #thank-you )
5
+ - [ Introduction] ( #introduction )
6
+ - [ Features] ( #features )
7
+ - [ Videos] ( #videos )
8
+ - [ Audience] ( #audience )
9
+ - [ System Containers] ( #system-containers )
10
+ - [ Features Description] ( #features-description )
11
+ - [ Supported Distros] ( #supported-distros )
12
+ - [ Host Requirements] ( #host-requirements )
13
+ - [ Installing Sysbox-EE] ( #installing-sysbox-ee )
14
+ - [ Using Sysbox-EE] ( #using-sysbox-ee )
15
+ - [ Documentation] ( #documentation )
16
+ - [ Integration with Container Managers & Orchestrators] ( #integration-with-container-managers-&-orchestrators )
17
+ - [ Troubleshooting] ( #troubleshooting )
18
+ - [ Filing Issues] ( #filing-issues )
19
+ - [ Support] ( #support )
20
+ - [ We want your feedback] ( #we-want-your-feedback )
21
+ - [ Uninstallation] ( #uninstallation )
22
+ - [ About Nestybox] ( #about-nestybox )
23
+ - [ Contact] ( #contact )
24
+ - [ Thank You] ( #thank-you )
24
25
25
26
## Introduction
26
27
@@ -35,7 +36,7 @@ containers (nested) while providing strong isolation from the underlying host.
35
36
36
37
Sysbox-EE uses Sysbox at its core, but adds enterprise-level features around
37
38
lifecycle, security, efficiency, scalability, and robustness. More on this
38
- in the [ features] ( #key- features ) section.
39
+ in the [ features] ( #features ) section.
39
40
40
41
## Features
41
42
@@ -46,17 +47,17 @@ and compares it to the community edition (Sysbox CE).
46
47
<img alt="sysbox" src="./docs/figures/sysbox-features.png" width="1000x" />
47
48
</p >
48
49
49
- More on the features [ below] ( #feature -description ) .
50
+ More on the features [ below] ( #features -description ) .
50
51
51
52
If you have questions, you can reach us [ here] ( #contact ) .
52
53
53
54
## Videos
54
55
55
56
We have some sample videos showing Sysbox-EE in action:
56
57
57
- - [ Docker Sandboxing] ( https://asciinema.org/a/kkTmOxl8DhEZiM2fLZNFlYzbo?speed=2 )
58
+ - [ Docker Sandboxing] ( https://asciinema.org/a/kkTmOxl8DhEZiM2fLZNFlYzbo?speed=2 )
58
59
59
- - [ Kubernetes-in-Docker] ( https://asciinema.org/a/V1UFSxz6JHb3rdHpGrnjefFIt?speed=1.75 )
60
+ - [ Kubernetes-in-Docker] ( https://asciinema.org/a/V1UFSxz6JHb3rdHpGrnjefFIt?speed=1.75 )
60
61
61
62
## Audience
62
63
@@ -85,133 +86,130 @@ features), plus enterprise-level features. These are described below.
85
86
86
87
#### Systemd-in-Docker
87
88
88
- - Run Systemd inside a Docker container easily, without complex container configurations.
89
+ - Run Systemd inside a Docker container easily, without complex container configurations.
89
90
90
- - Enables you to containerize apps that rely on Systemd (e.g., legacy apps).
91
+ - Enables you to containerize apps that rely on Systemd (e.g., legacy apps).
91
92
92
93
#### Docker-in-Docker
93
94
94
- - Run Docker inside a container easily and without unsecure privileged containers.
95
+ - Run Docker inside a container easily and without unsecure privileged containers.
95
96
96
- - Full isolation between the Docker inside the container and the Docker on the host.
97
+ - Full isolation between the Docker inside the container and the Docker on the host.
97
98
98
99
#### Kubernetes-in-Docker
99
100
100
- - Deploy Kubernetes (K8s) inside containers with proper isolation (no
101
- privileged containers), using simple Docker images and Docker run commands
102
- (no need for custom Docker images with tricky entrypoints).
101
+ - Deploy Kubernetes (K8s) inside containers with proper isolation (no
102
+ privileged containers), using simple Docker images and Docker run commands
103
+ (no need for custom Docker images with tricky entrypoints).
103
104
104
- - Deploy directly with ` docker run ` commands for full flexibility, or using a
105
- higher level tool (e.g., such as [ kindbox] ( https://github.com/nestybox/kindbox ) ).
105
+ - Deploy directly with ` docker run ` commands for full flexibility, or using a
106
+ higher level tool (e.g., such as [ kindbox] ( https://github.com/nestybox/kindbox ) ).
106
107
107
108
#### Strong container isolation
108
109
109
- - Root user in the system container maps to a fully unprivileged user on the host.
110
+ - Root user in the system container maps to a fully unprivileged user on the host.
110
111
111
- - The procfs and sysfs exposed in the container are fully namespaced.
112
+ - The procfs and sysfs exposed in the container are fully namespaced.
112
113
113
- - Programs running inside the system container (e.g., Docker, Kubernetes, etc)
114
- are limited to using the resources given to the system container itself.
114
+ - Programs running inside the system container (e.g., Docker, Kubernetes, etc)
115
+ are limited to using the resources given to the system container itself.
115
116
116
- - Avoid the need for unsecure privileged containers.
117
+ - Avoid the need for unsecure privileged containers.
117
118
118
119
#### Inner Container Image Preloading
119
120
120
- - You can create a system container image that includes inner container
121
- images, with a simple Dockerfile or Docker commit.
121
+ - You can create a system container image that includes inner container
122
+ images, with a simple Dockerfile or Docker commit.
122
123
123
124
### Enterprise-level Features
124
125
125
126
#### Lifecycle
126
127
127
- * Sysbox-EE package installer and systemd services.
128
+ - Sysbox-EE package installer and systemd services.
128
129
129
130
#### Security
130
131
131
- * Stronger cross-container isolation (Sysbox-EE assigns exclusive
132
+ - Stronger cross-container isolation (Sysbox-EE assigns exclusive
132
133
user-namespaces user-ID and group-ID mappings to each container).
133
134
134
135
#### Performance & Efficiency
135
136
136
- * Sysbox EE includes optimizations for running containers in containers that are
137
+ - Sysbox EE includes optimizations for running containers in containers that are
137
138
not present in the Sysbox community edition. This speeds up container
138
139
deployment and significantly reduces storage overhead.
139
140
140
- * For example, with Sysbox-EE, a 10-node Kubernetes-in-Docker cluster
141
+ - For example, with Sysbox-EE, a 10-node Kubernetes-in-Docker cluster
141
142
starts in ~ 2 minutes and consumes only 1GB of overhead. In contrast,
142
143
the Sysbox open-source version takes 2 min 40 secs and consumes up to 10GB
143
144
for this same cluster.
144
145
145
146
#### Scalability
146
147
147
- * Higher efficiency means you can launch more system containers per host.
148
+ - Higher efficiency means you can launch more system containers per host.
148
149
149
150
#### Robustness
150
151
151
- * Sysbox-EE is tested and hardened for operation in production environments.
152
+ - Sysbox-EE is tested and hardened for operation in production environments.
152
153
153
154
#### Feature Prioritization
154
155
155
- * Sysbox-EE offers customers the ability to request and fast-track new features.
156
+ - Sysbox-EE offers customers the ability to request and fast-track new features.
156
157
157
158
#### Nestybox Support
158
159
159
- * Sysbox-EE includes official Nestybox support for bug fixes, updated, etc.
160
-
161
- ## Download
162
-
163
- The latest release of Sysbox-EE is [ here] ( https://github.com/nestybox/sysbox-ee/releases ) .
164
-
165
- Installation instructions are below.
160
+ - Sysbox-EE includes official Nestybox support for bug fixes, updated, etc.
166
161
167
162
## Supported Distros
168
163
169
- Sysbox-EE relies on functionality that is currently only present in Ubuntu Linux.
164
+ Sysbox-EE relies on functionality available only in relatively recent Linux kernel
165
+ releases.
170
166
171
- See the [ distro compatibility doc] ( docs/distro-compat.md ) for information on what versions
172
- of Ubuntu kernels are supported .
167
+ See the [ distro compatibility doc] ( docs/distro-compat.md ) for information about
168
+ the supported Linux distributions and the required kernel releases .
173
169
174
- We plan to add support for more distros in the future.
170
+ We plan to add support for more distros in the near future.
175
171
176
172
## Host Requirements
177
173
178
174
The Linux host on which Sysbox-EE runs must meet the following requirements:
179
175
180
- 1 ) It must have one of the supported Linux distros.
176
+ 1 . It must have one of the supported Linux distros.
181
177
182
- 2 ) Systemd must be the system's process-manager (the default in the supported distros).
178
+ 2 . Systemd must be the system's process-manager (the default in the supported distros).
183
179
184
- 3 ) Docker must be [ installed natively] ( docs/user-guide/install.md#docker-installation ) (** not** with the Docker snap package).
180
+ 3 . Docker must be [ installed natively] ( docs/user-guide/install.md#docker-installation ) (** not** with the Docker snap package).
185
181
186
182
## Installing Sysbox-EE
187
183
188
- It's very easy:
184
+ 1 . Download the latest Sysbox-EE package from the
185
+ [ release] ( https://github.com/nestybox/sysbox-ee/releases ) page:
189
186
190
- 1 ) Download the latest Sysbox-EE package from the [ release] ( https://github.com/nestybox/sysbox-external/releases ) page.
187
+ ``` console
188
+ wget https://github.com/nestybox/sysbox-ee/releases/download/v0.3.0/sysbox-ee_0.3.0-0.ubuntu-focal_amd64.deb
189
+ ```
191
190
192
- 2 ) Verify that the checksum of the downloaded file fully matches the expected/published one.
191
+ 2 . Verify that the checksum of the downloaded file fully matches the expected/published one.
193
192
For example:
194
193
195
194
``` console
196
- $ sha256sum sysbox_0.2 .0-0.ubuntu-focal_amd64.deb
197
- 736dba5645549ac0aabe11f29c6410bdbb76e717431a8a241833f20ce8b58a11 sysbox_0.2 .0-0.ubuntu-focal_amd64.deb
195
+ $ sha256sum sysbox-ee_0.3 .0-0.ubuntu-focal_amd64.deb
196
+ c98e5f5adc90ef4279bdf05d32fa9052d62ac7b8a4de300ce4f78d513786c639 sysbox-ee_0.3 .0-0.ubuntu-focal_amd64.deb
198
197
```
199
198
200
- 3 ) Stop and eliminate all running Docker containers. Refer to the
201
- [ detailed] ( docs/user-guide/install.md ) installation process for information
202
- on how to avoid impacting existing containers.
199
+ 3 . Stop and eliminate all running Docker containers. Refer to the
200
+ [ detailed] ( docs/user-guide/install.md ) installation process for information
201
+ on how to avoid impacting existing containers.
203
202
204
203
```
205
- $ docker stop $(docker ps -a -q) && docker container prune -f
204
+ $ docker rm $(docker ps -a -q) -f
206
205
```
207
206
208
- If an error is returned, it simply indicates that no existing containers were
209
- found.
207
+ ... if an error is returned, it simply indicates that no existing containers were found.
210
208
211
- 4 ) Install the Sysbox-EE package and follow the installer instructions:
209
+ 4 . Install the Sysbox-EE package and follow the installer instructions:
212
210
213
211
``` console
214
- $ sudo apt-get install ./sysbox_0.2 .0-0.ubuntu-focal_amd64.deb -y
212
+ $ sudo apt-get install ./sysbox-ee_0.3 .0-0.ubuntu-focal_amd64.deb -y
215
213
```
216
214
217
215
More information on the installation process can be found [ here] ( docs/user-guide/install.md ) .
@@ -236,7 +234,7 @@ or virtual machine.
236
234
237
235
You can launch inner containers (and even inner privileged containers), with
238
236
strong isolation from the underlying host. No more complex docker images or
239
- docker run commands, and no need for unsecure privileged containers.
237
+ docker run commands, and no need for insecure privileged containers.
240
238
241
239
The [ Sysbox Quickstart Guide] ( docs/quickstart/README.md ) and the [ Nestybox Blog Site] ( https://blog.nestybox.com ) have
242
240
many usage examples.
@@ -251,22 +249,22 @@ regular Docker containers; they won't conflict and can co-exist side-by-side.
251
249
We have several documents to help you get started and get the best out of
252
250
Sysbox-EE:
253
251
254
- - [ Sysbox Quick Start Guide] ( docs/quickstart/README.md )
252
+ - [ Sysbox Quick Start Guide] ( docs/quickstart/README.md )
255
253
256
- - Provides many examples for using system containers. New users
257
- should start here.
254
+ - Provides many examples for using system containers. New users
255
+ should start here.
258
256
259
- - [ Sysbox User Guide] ( docs/user-guide/README.md )
257
+ - [ Sysbox User Guide] ( docs/user-guide/README.md )
260
258
261
- - Provides more detailed information on Sysbox features.
259
+ - Provides more detailed information on Sysbox features.
262
260
263
- - [ Sysbox Distro Compatibility Doc] ( docs/distro-compat.md )
261
+ - [ Sysbox Distro Compatibility Doc] ( docs/distro-compat.md )
264
262
265
- - Distro compatibility requirements.
263
+ - Distro compatibility requirements.
266
264
267
- - [ Issue Guidelines] ( docs/issue-guidelines.md )
265
+ - [ Issue Guidelines] ( docs/issue-guidelines.md )
268
266
269
- - Guidelines for filing issues in the Sysbox-EE GitHub project site.
267
+ - Guidelines for filing issues in the Sysbox-EE GitHub project site.
270
268
271
269
In addition, the [ Nestybox blog site] ( https://blog.nestybox.com ) has articles
272
270
on how to use system containers.
@@ -277,12 +275,12 @@ Though Sysbox is OCI-based (and thus compatible with OCI container managers),
277
275
it's currently only tested with Docker / containerd.
278
276
279
277
In particular, we don't yet support using Kubernetes to deploy system containers
280
- with Sysbox (though we [ plan to] ( #roadmap ) ).
278
+ with Sysbox (though we plan to).
281
279
282
280
## Troubleshooting
283
281
284
282
Refer to the [ Troubleshooting document] ( docs/user-guide/troubleshoot.md )
285
- and to the [ issues] ( https://github.com/nestybox/sysbox-external /issues ) in
283
+ and to the [ issues] ( https://github.com/nestybox/sysbox-ee /issues ) in
286
284
the GitHub site.
287
285
288
286
Do [ contact us] ( #contact ) if you need any help.
@@ -315,17 +313,17 @@ answer the following survey:
315
313
Prior to uninstalling Sysbox, make sure all system containers are removed.
316
314
There is a simple shell script to do this [ here] ( scr/rm_all_syscont ) .
317
315
318
- 1 ) Uninstall Sysbox binaries plus all the associated configuration and Systemd
319
- files:
316
+ 1 . Uninstall Sysbox binaries plus all the associated configuration and Systemd
317
+ files:
320
318
321
319
``` console
322
- $ sudo apt-get purge sysbox -y
320
+ $ sudo apt-get purge sysbox-ee -y
323
321
```
324
322
325
- 2 ) Remove the ` sysbox ` user from the system:
323
+ 2 . Remove the ` sysbox ` user from the system:
326
324
327
325
``` console
328
- $ sudo userdel sysbox
326
+ $ sudo userdel sysbox-ee
329
327
```
330
328
331
329
## About Nestybox
0 commit comments