Github url

distroless

by GoogleContainerTools

GoogleContainerTools /distroless

🥑 Language focused docker images, minus the operating system.

7.5K Stars 423 Forks Last release: Not found Apache License 2.0 410 Commits 0 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

"Distroless" Docker Images

Build Status

"Distroless" images contain only your application and its runtime dependencies. They do not contain package managers, shells or any other programs you would expect to find in a standard Linux distribution.

For more information, see this talk (video).

Why should I use distroless images?

Restricting what's in your runtime container to precisely what's necessary for your app is a best practice employed by Google and other tech giants that have used containers in production for many years. It improves the signal to noise of scanners (e.g. CVE) and reduces the burden of establishing provenance to just what you need.

How do I use distroless images?

These images are built using the bazel tool, but they can also be used through other Docker image build tooling.

Entrypoints

Note that distroless images by default do not contain a shell. That means the Dockerfile

ENTRYPOINT

command, when defined, must be specified in

vector

form, to avoid the container runtime prefixing with a shell.

This works:

ENTRYPOINT ["myapp"]

But this does not work:

ENTRYPOINT "myapp"

For the same reasons, if the entrypoint is left to the default empty vector, the CMD command should be specified in

vector

form (see examples below).

Docker

Docker multi-stage builds make using distroless images easy. Follow these steps to get started:

  • Pick the right base image for your application stack. We publish the following distroless base images on

gcr.io

:

The following images are also published on

gcr.io

, but are considered experimental and not recommended for production usage:

The basic idea is that you'll have one stage to build your application artifacts, and insert them into your runtime distroless image. If you'd like to learn more, please see the documentation on multi-stage builds.

Examples with Docker

Here's a quick example for go:

# Start by building the application. FROM golang:1.13-buster as build WORKDIR /go/src/app ADD . /go/src/app RUN go get -d -v ./... RUN go build -o /go/bin/app # Now copy it into our base image. FROM gcr.io/distroless/base-debian10 COPY --from=build /go/bin/app / CMD ["/app"]

You can find other examples here:

To run any example, go the the directory for the language and run

docker build -t myapp . docker run -t myapp

To run the Node.js Express app node-express and expose the container's ports:

npm install #Install express and its transitive dependencies docker build -t myexpressapp . # Normal build command docker run -p 3000:3000 -t myexpressapp

This should expose the Express application to your localhost:3000

Bazel

For full documentation on how to use bazel to generate Docker images, see the bazelbuild/rules_docker repository.

For documentation and examples on how to use the bazel package manager rules, see ./package_manager

Examples can be found in this repository in the examples directory.

Examples with Bazel

We have some examples on how to run some common application stacks in the /examples directory. See here for:

See here for examples on how to complete some common tasks in your image:

See here for more information on how these images are built and released.

Jib

For full documentation on how to use Jib to generate Docker images from Maven and Gradle, see the GoogleContainerTools/jib repository.

Base Operating System

Originally these images were based on Debian 9 (stretch). We now also provide images based on Debian 10 (buster), and tag images with

-debian9

or

-debian10

suffixes. We recommend referencing the appropriate distribution explicitly, since otherwise your build will break when the next Debian version is released.

CVE and Patching

Distroless tracks Debian 9 (stretch, oldstable currently) and Debian 10. A commit is needed in this repository to update the snapshot version when security fixes are release. Check https://www.debian.org/security/ for any patches to address security issues and update. Check issues and PRs for the patch and update your builds.

Debug Images

Distroless images are minimal and lack shell access. The

:debug

image set for each language provides a busybox shell to enter.

For example:

cd examples/python2.7/

edit the

Dockerfile

to change the final image to

:debug

:

FROM gcr.io/distroless/python2.7:debug COPY . /app WORKDIR /app CMD ["hello.py", "/etc"]

then build and launch with an shell entrypoint:

$ docker build -t my\_debug\_image .
$ docker run --entrypoint=sh -ti my\_debug\_image /app # ls BUILD Dockerfile hello.py

Note: If the image you are using already has a tag, for example

gcr.io/distroless/java-debian10:11

, use the tag

<existing tag>-debug</existing>

instead, for example

gcr.io/distroless/java-debian10:11-debug

.

Note: ldd is not installed in the base image as it's a shell script, you can copy it in or download it.

Community Discussion

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.