Fix a few typos in the ECI docs. (#21538)

<!--Delete sections as needed -->

## Description

Fix a few typos in the ECI docs.

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [X] Editorial review
- [ ] Product review

---------

Signed-off-by: Cesar Talledo <cesar.talledo@docker.com>
This commit is contained in:
Cesar Talledo 2024-12-02 00:33:49 -08:00 committed by GitHub
parent c650b54ffc
commit c9be6e267b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 19 additions and 11 deletions

View File

@ -47,7 +47,8 @@ This can be done via the Docker Socket mount permissions section in the
"docker.io/localstack/localstack:*", "docker.io/localstack/localstack:*",
"docker.io/testcontainers/ryuk:*", "docker.io/testcontainers/ryuk:*",
"docker:cli" "docker:cli"
] ],
"allowDerivedImages": true
}, },
"commandList": { "commandList": {
"type": "deny", "type": "deny",
@ -119,9 +120,9 @@ memory. Then, when a container is started with a Docker socket bind-mount,
Docker Desktop checks if the container's image digest matches one of the allowed Docker Desktop checks if the container's image digest matches one of the allowed
digests. If so, the container is allowed to start, otherwise it's blocked. digests. If so, the container is allowed to start, otherwise it's blocked.
Due to the digest comparison, it's not possible to bypass the Docker socket mount permissions by re-tagging a Due to the digest comparison, it's not possible to bypass the Docker socket
disallowed image to the name of an allowed one. In other words, if a user mount permissions by re-tagging a disallowed image to the name of an allowed
does: one. In other words, if a user does:
```console ```console
$ docker image rm <allowed_image> $ docker image rm <allowed_image>
@ -135,7 +136,7 @@ ones in the repository.
### Docker Socket Mount Permissions for derived images ### Docker Socket Mount Permissions for derived images
{{ introduced desktop 4.34.0 "../../../../desktop/release-notes.md#4340" }} {{< introduced desktop 4.34.0 "../../../../desktop/release-notes.md#4340" >}}
As described in the prior section, administrators can configure the list of container As described in the prior section, administrators can configure the list of container
images that are allowed to mount the Docker socket via the `imageList`. images that are allowed to mount the Docker socket via the `imageList`.
@ -162,7 +163,7 @@ simply add the following image to the `imageList`:
```json ```json
"imageList": { "imageList": {
"images": [ "images": [
"paketobuildpacks/builder:base", "paketobuildpacks/builder:base"
], ],
"allowDerivedImages": true "allowDerivedImages": true
} }
@ -173,12 +174,15 @@ When the buildpack runs, it will create an ephemeral image derived from
allow this because it will notice that the ephemeral image is derived from an allow this because it will notice that the ephemeral image is derived from an
allowed image. allowed image.
The behavior is enabled by default. It can be disabled by setting The behavior is disabled by default and must be explicitly enabled by setting
`allowDerivedImages=false` in the `admin-settings.json` file. In general it is `"allowDerivedImages": true` as shown above. In general it is recommended that
not recommended that you disable this setting unless you know it won't be you disable this setting unless you know it's required.
required.
A couple of caveats: A few caveats:
* Setting `"allowedDerivedImages" :true` will impact the startup time of
containers by up to 1 extra second, as Docker Desktop needs to perform
some more checks on the container image.
* The `allowDerivedImages` setting only applies to local-only images built from * The `allowDerivedImages` setting only applies to local-only images built from
an allowed image. That is, the derived image must not be present in a remote an allowed image. That is, the derived image must not be present in a remote
@ -211,6 +215,10 @@ list to allow any container to mount the Docker socket. You do this by adding
} }
``` ```
This tells Docker Desktop to allow all containers to mount the Docker socket
which increases flexibility but reduces security. It also improves container
startup time when using Enhanced Container Isolation.
It is recommended that you use this only in scenarios where explicitly listing It is recommended that you use this only in scenarios where explicitly listing
allowed container images is not flexible enough. allowed container images is not flexible enough.