-
Notifications
You must be signed in to change notification settings - Fork 8.3k
docs: clarify subuid/subgid mapping in rootless vs userns-remap #24845
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lacatoire
wants to merge
2
commits into
docker:main
Choose a base branch
from
lacatoire:docs/rootless-subuid-mapping
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+35
−8
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,14 +20,16 @@ with `userns-remap` mode, the daemon itself is running with root privileges, | |
| whereas in rootless mode, both the daemon and the container are running without | ||
| root privileges. | ||
|
|
||
| The two modes also differ in how they map container UIDs and GIDs to the | ||
| host: see [UID/GID mapping](uid-gid-mapping/) for details. | ||
|
|
||
| Rootless mode does not use binaries with `SETUID` bits or file capabilities, | ||
| except `newuidmap` and `newgidmap`, which are needed to allow multiple | ||
| UIDs/GIDs to be used in the user namespace. | ||
|
|
||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Irrelevant changes |
||
| ## Prerequisites | ||
|
|
||
| - You must install `newuidmap` and `newgidmap` on the host. These commands | ||
| - You must install `newuidmap` and `newgidmap` on the host. These commands | ||
| are provided by the `uidmap` package on most distributions. | ||
|
|
||
| - `/etc/subuid` and `/etc/subgid` should contain at least 65,536 subordinate | ||
|
|
@@ -53,13 +55,15 @@ when the prerequisites are not satisfied. | |
| > [!NOTE] | ||
| > | ||
| > If the system-wide Docker daemon is already running, consider disabling it: | ||
| >```console | ||
| >$ sudo systemctl disable --now docker.service docker.socket | ||
| >$ sudo rm /var/run/docker.sock | ||
| >``` | ||
| > | ||
| > ```console | ||
| > $ sudo systemctl disable --now docker.service docker.socket | ||
| > $ sudo rm /var/run/docker.sock | ||
| > ``` | ||
| > | ||
| > Should you choose not to shut down the `docker` service and socket, you will need to use the `--force` | ||
| > parameter in the next section. There are no known issues, but until you shutdown and disable you're | ||
| > still running rootful Docker. | ||
| > still running rootful Docker. | ||
|
|
||
| {{< tabs >}} | ||
| {{< tab name="With packages (RPM/DEB)" >}} | ||
|
|
@@ -128,6 +132,7 @@ The binaries will be installed at `~/bin`. | |
| {{< /tabs >}} | ||
|
|
||
| Run `docker info` to confirm that the `docker` client is connecting to the Rootless daemon: | ||
|
|
||
| ```console | ||
| $ docker info | ||
| Client: Docker Engine - Community | ||
|
|
@@ -144,4 +149,4 @@ Server: | |
| ... | ||
| ``` | ||
|
|
||
| See [Troubleshooting](./troubleshoot.md) if you faced an error. | ||
| See [Troubleshooting](./troubleshoot.md) if you faced an error. | ||
22 changes: 22 additions & 0 deletions
22
content/manuals/engine/security/rootless/uid-gid-mapping.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| description: How container UIDs and GIDs are mapped to the host in rootless mode | ||
| keywords: security, namespaces, rootless, uid, gid, subuid, subgid | ||
| title: UID/GID mapping | ||
| weight: 15 | ||
| --- | ||
|
|
||
| Rootless mode and [`userns-remap` mode](../userns-remap.md) map container UIDs | ||
| and GIDs to the host differently. | ||
|
|
||
| - In `userns-remap` mode, container UID `0` is mapped to the first subordinate | ||
| UID listed in `/etc/subuid` for the remap user, and container UID `n` is | ||
| mapped to `subuid + n`. | ||
| - In rootless mode, container UID `0` is mapped to the host UID of the user | ||
| running rootless Docker (the result of `id -u`); container UID `n` (for | ||
| `n >= 1`) is mapped to `subuid + (n - 1)`. | ||
|
|
||
| GIDs follow the same rules using `/etc/subgid`. | ||
|
|
||
| This difference matters when setting file permissions on bind-mounted | ||
| directories: in rootless mode, files owned by your host user appear as owned | ||
| by `root` inside the container. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changes should be a subpage to avoid inflating the amount of the contents in a single page