Skip to content

Commit ae5eb1b

Browse files
committed
Update Sysbox-EE documentation
``` $ remark * README.md: no issues found distro-compat.md: no issues found issue-guidelines.md: no issues found quickstart/README.md: no issues found quickstart/dind.md: no issues found quickstart/images.md: no issues found quickstart/kind.md: no issues found quickstart/security.md: no issues found quickstart/storage.md: no issues found quickstart/systemd.md: no issues found user-guide/README.md: no issues found user-guide/concepts.md: no issues found user-guide/configuration.md: no issues found user-guide/deploy.md: no issues found user-guide/design.md: no issues found user-guide/dind.md: no issues found user-guide/images.md: no issues found user-guide/install.md: no issues found user-guide/kind.md: no issues found user-guide/limitations.md: no issues found user-guide/security.md: no issues found user-guide/storage.md: no issues found user-guide/systemd.md: no issues found user-guide/troubleshoot.md: no issues found $ ``` Signed-off-by: Rodny Molina <rmolina@nestybox.com>
1 parent a62917d commit ae5eb1b

26 files changed

+1427
-394
lines changed

README.md

+88-90
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,26 @@
22

33
## Contents
44

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)
2425

2526
## Introduction
2627

@@ -35,7 +36,7 @@ containers (nested) while providing strong isolation from the underlying host.
3536

3637
Sysbox-EE uses Sysbox at its core, but adds enterprise-level features around
3738
lifecycle, security, efficiency, scalability, and robustness. More on this
38-
in the [features](#key-features) section.
39+
in the [features](#features) section.
3940

4041
## Features
4142

@@ -46,17 +47,17 @@ and compares it to the community edition (Sysbox CE).
4647
<img alt="sysbox" src="./docs/figures/sysbox-features.png" width="1000x" />
4748
</p>
4849

49-
More on the features [below](#feature-description).
50+
More on the features [below](#features-description).
5051

5152
If you have questions, you can reach us [here](#contact).
5253

5354
## Videos
5455

5556
We have some sample videos showing Sysbox-EE in action:
5657

57-
- [Docker Sandboxing](https://asciinema.org/a/kkTmOxl8DhEZiM2fLZNFlYzbo?speed=2)
58+
- [Docker Sandboxing](https://asciinema.org/a/kkTmOxl8DhEZiM2fLZNFlYzbo?speed=2)
5859

59-
- [Kubernetes-in-Docker](https://asciinema.org/a/V1UFSxz6JHb3rdHpGrnjefFIt?speed=1.75)
60+
- [Kubernetes-in-Docker](https://asciinema.org/a/V1UFSxz6JHb3rdHpGrnjefFIt?speed=1.75)
6061

6162
## Audience
6263

@@ -85,133 +86,130 @@ features), plus enterprise-level features. These are described below.
8586

8687
#### Systemd-in-Docker
8788

88-
- Run Systemd inside a Docker container easily, without complex container configurations.
89+
- Run Systemd inside a Docker container easily, without complex container configurations.
8990

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).
9192

9293
#### Docker-in-Docker
9394

94-
- Run Docker inside a container easily and without unsecure privileged containers.
95+
- Run Docker inside a container easily and without unsecure privileged containers.
9596

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.
9798

9899
#### Kubernetes-in-Docker
99100

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).
103104

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)).
106107

107108
#### Strong container isolation
108109

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.
110111

111-
- The procfs and sysfs exposed in the container are fully namespaced.
112+
- The procfs and sysfs exposed in the container are fully namespaced.
112113

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.
115116

116-
- Avoid the need for unsecure privileged containers.
117+
- Avoid the need for unsecure privileged containers.
117118

118119
#### Inner Container Image Preloading
119120

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.
122123

123124
### Enterprise-level Features
124125

125126
#### Lifecycle
126127

127-
* Sysbox-EE package installer and systemd services.
128+
- Sysbox-EE package installer and systemd services.
128129

129130
#### Security
130131

131-
* Stronger cross-container isolation (Sysbox-EE assigns exclusive
132+
- Stronger cross-container isolation (Sysbox-EE assigns exclusive
132133
user-namespaces user-ID and group-ID mappings to each container).
133134

134135
#### Performance & Efficiency
135136

136-
* Sysbox EE includes optimizations for running containers in containers that are
137+
- Sysbox EE includes optimizations for running containers in containers that are
137138
not present in the Sysbox community edition. This speeds up container
138139
deployment and significantly reduces storage overhead.
139140

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
141142
starts in ~2 minutes and consumes only 1GB of overhead. In contrast,
142143
the Sysbox open-source version takes 2 min 40 secs and consumes up to 10GB
143144
for this same cluster.
144145

145146
#### Scalability
146147

147-
* Higher efficiency means you can launch more system containers per host.
148+
- Higher efficiency means you can launch more system containers per host.
148149

149150
#### Robustness
150151

151-
* Sysbox-EE is tested and hardened for operation in production environments.
152+
- Sysbox-EE is tested and hardened for operation in production environments.
152153

153154
#### Feature Prioritization
154155

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.
156157

157158
#### Nestybox Support
158159

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.
166161

167162
## Supported Distros
168163

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.
170166

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.
173169

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.
175171

176172
## Host Requirements
177173

178174
The Linux host on which Sysbox-EE runs must meet the following requirements:
179175

180-
1) It must have one of the supported Linux distros.
176+
1. It must have one of the supported Linux distros.
181177

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).
183179

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).
185181

186182
## Installing Sysbox-EE
187183

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:
189186

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+
```
191190

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.
193192
For example:
194193

195194
```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
198197
```
199198

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.
203202

204203
```
205-
$ docker stop $(docker ps -a -q) && docker container prune -f
204+
$ docker rm $(docker ps -a -q) -f
206205
```
207206

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.
210208

211-
4) Install the Sysbox-EE package and follow the installer instructions:
209+
4. Install the Sysbox-EE package and follow the installer instructions:
212210

213211
```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
215213
```
216214

217215
More information on the installation process can be found [here](docs/user-guide/install.md).
@@ -236,7 +234,7 @@ or virtual machine.
236234

237235
You can launch inner containers (and even inner privileged containers), with
238236
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.
240238

241239
The [Sysbox Quickstart Guide](docs/quickstart/README.md) and the [Nestybox Blog Site](https://blog.nestybox.com) have
242240
many usage examples.
@@ -251,22 +249,22 @@ regular Docker containers; they won't conflict and can co-exist side-by-side.
251249
We have several documents to help you get started and get the best out of
252250
Sysbox-EE:
253251

254-
- [Sysbox Quick Start Guide](docs/quickstart/README.md)
252+
- [Sysbox Quick Start Guide](docs/quickstart/README.md)
255253

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.
258256

259-
- [Sysbox User Guide](docs/user-guide/README.md)
257+
- [Sysbox User Guide](docs/user-guide/README.md)
260258

261-
- Provides more detailed information on Sysbox features.
259+
- Provides more detailed information on Sysbox features.
262260

263-
- [Sysbox Distro Compatibility Doc](docs/distro-compat.md)
261+
- [Sysbox Distro Compatibility Doc](docs/distro-compat.md)
264262

265-
- Distro compatibility requirements.
263+
- Distro compatibility requirements.
266264

267-
- [Issue Guidelines](docs/issue-guidelines.md)
265+
- [Issue Guidelines](docs/issue-guidelines.md)
268266

269-
- Guidelines for filing issues in the Sysbox-EE GitHub project site.
267+
- Guidelines for filing issues in the Sysbox-EE GitHub project site.
270268

271269
In addition, the [Nestybox blog site](https://blog.nestybox.com) has articles
272270
on how to use system containers.
@@ -277,12 +275,12 @@ Though Sysbox is OCI-based (and thus compatible with OCI container managers),
277275
it's currently only tested with Docker / containerd.
278276

279277
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).
281279

282280
## Troubleshooting
283281

284282
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
286284
the GitHub site.
287285

288286
Do [contact us](#contact) if you need any help.
@@ -315,17 +313,17 @@ answer the following survey:
315313
Prior to uninstalling Sysbox, make sure all system containers are removed.
316314
There is a simple shell script to do this [here](scr/rm_all_syscont).
317315

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:
320318

321319
```console
322-
$ sudo apt-get purge sysbox -y
320+
$ sudo apt-get purge sysbox-ee -y
323321
```
324322

325-
2) Remove the `sysbox` user from the system:
323+
2. Remove the `sysbox` user from the system:
326324

327325
```console
328-
$ sudo userdel sysbox
326+
$ sudo userdel sysbox-ee
329327
```
330328

331329
## About Nestybox

docs/README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Sysbox Documentation
2+
3+
This directory contains the Sysbox documentation for both
4+
5+
- **Sysbox Community Edition (Sysbox-CE)**
6+
- **Sysbox Enterprise Edition (Sysbox-EE)**
7+
8+
In general, the features and limitations described in these docs apply equally
9+
to Sysbox-CE and Sysbox-EE.
10+
11+
Features that are specific to Sysbox-EE are tagged with **"Sysbox-EE Feature
12+
Highlight"**.
13+
14+
Features that appear in a particular Sysbox release are flagged in the docs with
15+
the release tag (e.g., "**\[ +v0.1.2 ]**" indicates the feature appeared in
16+
Sysbox release v0.1.2 and beyond).
17+
18+
## Documents
19+
20+
- [Sysbox Distro Compatibility doc](distro-compat.md)
21+
22+
- Shows Linux distros supported by Sysbox.
23+
24+
- [Sysbox Quick Start Guide](quickstart/README.md)
25+
26+
- Start here if new to Sysbox; has lots of examples on how to use it.
27+
28+
- [Sysbox User Guide](user-guide/README.md)
29+
30+
- Provides detailed info and details on Sysbox's features and functionality.
31+
32+
In addition to these docs, you can also find articles on practical uses of Sysbox
33+
in the [Nestybox blog site](https://blog.nestybox.com/).

0 commit comments

Comments
 (0)