From 13e011698d36883447697acee54078f40379f597 Mon Sep 17 00:00:00 2001 From: Cesar Talledo Date: Tue, 7 Jul 2020 13:33:35 -0700 Subject: [PATCH] Added small section on shiftfs to distro-compat doc. --- docs/distro-compat.md | 11 +++++++++++ docs/user-guide/install.md | 4 +++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/distro-compat.md b/docs/distro-compat.md index 4820547..0cdd8f1 100644 --- a/docs/distro-compat.md +++ b/docs/distro-compat.md @@ -29,3 +29,14 @@ package to do the upgrade as follows: ```console $ sudo apt-get update && sudo apt install --install-recommends linux-generic-hwe-18.04 -y ``` + +### Using Sysbox On Kernels Without the Shiftfs Module + +Recent Ubuntu kernels carry a module called `shiftfs` that Sysbox uses as part +of its container isolation strategy. + +However, some Ubuntu cloud images do not carry the module. In this case, Sysbox +requires that Docker be configured in [userns-remap mode](https://docs.docker.com/engine/security/userns-remap/). + +The Sysbox installer will detect this condition and can automatically put +Docker in userns-remap mode if desired. See [here](user-guide/install.md#docker-userns-remap) for details. diff --git a/docs/user-guide/install.md b/docs/user-guide/install.md index 1bba4d4..01a413d 100644 --- a/docs/user-guide/install.md +++ b/docs/user-guide/install.md @@ -22,6 +22,8 @@ The Linux host on which Sysbox runs must meet the following requirements: ## Installing Sysbox +**NOTE**: if you have a prior version of Sysbox already installed, please [uninstall it](#uninstalling-sysbox) first and then follow the installation instructions below. + 1) Download the latest Sysbox package from the [release](https://github.com/nestybox/sysbox-external/releases) page. 2) Verify that the checksum of the downloaded file fully matches the expected/published one. @@ -102,7 +104,7 @@ WARNING: No swap limit support ### Docker Userns-Remap -In addition, the Sysbox installer will detect if Docker needs to be placed +During installation, the Sysbox installer will also check if Docker needs to be placed in [userns-remap mode](https://docs.docker.com/engine/security/userns-remap/) or not. The installer uses the following logic: