README.md: Update image requirements

https://github.com/containers/toolbox/issues/885
This commit is contained in:
Debarshi Ray 2021-12-01 00:52:25 +01:00
parent cfffb72fb0
commit 72cccca59f
1 changed files with 12 additions and 0 deletions

View File

@ -112,6 +112,18 @@ default image to ensure a smooth user experience.
## Image requirements
Toolbox specifies the entry points of newly created containers in a certain
way. It's best if the OCI image doesn't specify any entry point of its own to
avoid interfering with the desired command line arguments. In other words,
there shouldn't be any `Entrypoint` in the `podman inspect` output for the
image. A wrong set of arguments will prevent `toolbox enter` from working.
If the image has a parent base image that does specify an entry point, then it
can be reset with this Containerfile snippet:
```Dockerfile
ENTRYPOINT []
```
Toolbox customizes newly created containers in a certain way. This requires
certain tools and paths to be present and have certain characteristics inside
the OCI image.