Skip to content

Commit 14e28c6

Browse files
committed
ECI: fix error regarding default value of allowDerivedImages in docs.
Signed-off-by: Cesar Talledo <[email protected]>
1 parent 7f84a9b commit 14e28c6

File tree

1 file changed

+14
-8
lines changed
  • content/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation

1 file changed

+14
-8
lines changed

content/manuals/security/for-admins/hardened-desktop/enhanced-container-isolation/config.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ memory. Then, when a container is started with a Docker socket bind-mount,
120120
Docker Desktop checks if the container's image digest matches one of the allowed
121121
digests. If so, the container is allowed to start, otherwise it's blocked.
122122

123-
Due to the digest comparison, it's not possible to bypass the Docker socket mount permissions by re-tagging a
124-
disallowed image to the name of an allowed one. In other words, if a user
125-
does:
123+
Due to the digest comparison, it's not possible to bypass the Docker socket
124+
mount permissions by re-tagging a disallowed image to the name of an allowed
125+
one. In other words, if a user does:
126126

127127
```console
128128
$ docker image rm <allowed_image>
@@ -174,12 +174,15 @@ When the buildpack runs, it will create an ephemeral image derived from
174174
allow this because it will notice that the ephemeral image is derived from an
175175
allowed image.
176176

177-
The behavior is enabled by default. It can be disabled by setting
178-
`allowDerivedImages=false` in the `admin-settings.json` file. In general it is
179-
not recommended that you disable this setting unless you know it won't be
180-
required.
177+
The behavior is disabled by default and must be explicitly enabled by setting
178+
`"allowDerivedImages": true` as shown above. In general it is recommended that
179+
you disable this setting unless you know it's required.
181180

182-
A couple of caveats:
181+
A few caveats:
182+
183+
* Setting `"allowedDerivedImages" :true` will impact the startup time of
184+
containers by up to 1 extra second, as Docker Desktop needs to perform
185+
some more checks on the container image.
183186

184187
* The `allowDerivedImages` setting only applies to local-only images built from
185188
an allowed image. That is, the derived image must not be present in a remote
@@ -212,6 +215,9 @@ list to allow any container to mount the Docker socket. You do this by adding
212215
}
213216
```
214217

218+
This tells Docker Desktop to allow all containers to mount the Docker socket,
219+
which improves container startup time when using Enhanced Container Isolation.
220+
215221
It is recommended that you use this only in scenarios where explicitly listing
216222
allowed container images is not flexible enough.
217223

0 commit comments

Comments
 (0)