Skip to content

Commit 907047b

Browse files
committed
docs(drivers): document bind-mount selinux_label and whitespace rules
1 parent 4524fcb commit 907047b

2 files changed

Lines changed: 18 additions & 13 deletions

File tree

crates/openshell-driver-docker/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,15 @@ paths to sandbox requests. Image mounts are not part of the Docker
5656
driver-config schema. The driver still uses internal bind mounts for
5757
OpenShell-owned supervisor, token, and TLS material.
5858

59-
Docker `bind` mounts accept `source`, `target`, and optional `read_only`.
60-
Docker `volume` mounts may include `subpath`. User-supplied bind and volume
61-
mounts are read-only by default; set `read_only: false` to make them writable.
62-
Mount targets must be absolute container paths and must not replace the
63-
workspace root (`/sandbox`) or overlap OpenShell supervisor files,
64-
`/etc/openshell`, `/etc/openshell-tls`, or `/run/netns`.
59+
Docker `bind` mounts accept `source`, `target`, optional `read_only`, and an
60+
optional `selinux_label` of `shared` (applies `:z`) or `private` (applies
61+
`:Z`) for SELinux-enforcing hosts. Docker `volume` mounts may include
62+
`subpath`. User-supplied bind and volume mounts are read-only by default; set
63+
`read_only: false` to make them writable. Mount `source`, `target`, and
64+
`subpath` values must not contain surrounding whitespace. Mount targets must be
65+
absolute container paths and must not replace the workspace root (`/sandbox`)
66+
or overlap OpenShell supervisor files, `/etc/openshell`, `/etc/openshell-tls`,
67+
or `/run/netns`.
6568

6669
Example named-volume usage:
6770

crates/openshell-driver-podman/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,15 @@ Host bind mounts are disabled by default because they expose gateway host paths
7171
to sandbox requests. The driver still uses internal bind mounts for
7272
OpenShell-owned token and TLS material.
7373

74-
Podman `bind` mounts accept `source`, `target`, and optional `read_only`.
75-
User-supplied bind and volume mounts are read-only by default; set
76-
`read_only: false` to make them writable. Podman image and volume mounts do not
77-
support `subpath` in OpenShell driver config. Mount targets must be absolute
78-
container paths and must not replace the workspace root (`/sandbox`) or overlap
79-
OpenShell supervisor files, `/etc/openshell`, `/etc/openshell-tls`, or
80-
`/run/netns`.
74+
Podman `bind` mounts accept `source`, `target`, optional `read_only`, and an
75+
optional `selinux_label` of `shared` (applies `:z`) or `private` (applies
76+
`:Z`) for SELinux-enforcing hosts. User-supplied bind and volume mounts are
77+
read-only by default; set `read_only: false` to make them writable. Podman
78+
image and volume mounts do not support `subpath` in OpenShell driver config.
79+
Mount `source`, `target`, and `subpath` values must not contain surrounding
80+
whitespace. Mount targets must be absolute container paths and must not replace
81+
the workspace root (`/sandbox`) or overlap OpenShell supervisor files,
82+
`/etc/openshell`, `/etc/openshell-tls`, or `/run/netns`.
8183

8284
Example named-volume usage:
8385

0 commit comments

Comments
 (0)