c9c9112155
* Add Package.Dockerfile as flexible build source * Add docker-compose.package.yml as intermediary config * CI will use new github action YAML format it only publish the docker image on git tag * Add debian:latest, debian:slim, and alpine as base image * Add documentation
3.3 KiB
Docker Guide
| tag | base image | plugins | package manager | libs & bins | size |
|---|---|---|---|---|---|
latest,debian |
debian:latest |
yes | apt | a lot, including glibc | ~(48+62) MB |
slim |
debian:stable-slim |
yes | apt | all nu:debian image but exclude this list |
~(26+62) MB |
alpine |
alpine:latest |
yes | apk | all nu:musl-busybox image but include libcrypto, libssl, libtls, libz |
~(3+61) MB |
Image Variants
nu:<version>
This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It is designed to be used both as a throw away container (mount your source code and start the container to start your app), as well as the base to build other images off of.
example
Let say you create a plugin in Rust.
- create a Dockerfile in your root project
FROM nu:0.2
COPY /target/debug/nu_plugin_cowsay /bin/
ENTRYPOINT ["nu"]
- build your project first then run it via docker
cargo build
docker run -it .
nu:<version>-slim
This image does not contain the common packages contained in the default tag and only contains the minimal packages needed to run nu. Unless you are working in an environment where only the nu image will be deployed and you have space constraints, we highly recommend using the alpine image if you aim for small image size. Only use this image if you really need both glibc and small image size.
nu:<version>-alpine
This image is based on the popular Alpine Linux project, available in the alpine official image. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.
This variant is highly recommended when final image size being as small as possible is desired. The main caveat to note is that it does use musl libc instead of glibc and friends, so certain software might run into issues depending on the depth of their libc requirements. However, most software doesn't have an issue with this, so this variant is usually a very safe choice. See this Hacker News comment thread for more discussion of the issues that might arise and some pro/con comparisons of using Alpine-based images.
To minimize image size, it's uncommon for additional related tools (such as git or bash) to be included in Alpine-based images. Using this image as a base, add the things you need in your own Dockerfile (see the alpine image description for examples of how to install packages if you are unfamiliar).