summary refs log tree commit diff
path: root/doc/builders/images
diff options
context:
space:
mode:
authorLouis Blin <45168934+lbpdt@users.noreply.github.com>2021-03-08 20:36:13 +0000
committerLouis Blin <45168934+lbpdt@users.noreply.github.com>2021-03-23 14:50:42 +0000
commitaae8588182913549435332d0ac120e18d7afdab5 (patch)
tree1d39c7c857583ec8668df58dc39d71f0b4ae21b8 /doc/builders/images
parent148e686044c37e08062b2df597b85d2898e52408 (diff)
downloadnixpkgs-aae8588182913549435332d0ac120e18d7afdab5.tar
nixpkgs-aae8588182913549435332d0ac120e18d7afdab5.tar.gz
nixpkgs-aae8588182913549435332d0ac120e18d7afdab5.tar.bz2
nixpkgs-aae8588182913549435332d0ac120e18d7afdab5.tar.lz
nixpkgs-aae8588182913549435332d0ac120e18d7afdab5.tar.xz
nixpkgs-aae8588182913549435332d0ac120e18d7afdab5.tar.zst
nixpkgs-aae8588182913549435332d0ac120e18d7afdab5.zip
dockerTools.buildLayeredImage: support fromImage
It is now possible to pass a `fromImage` to `buildLayeredImage` and
`streamLayeredImage`, similar to what `buildImage` currently supports.

This will prepend the layers of the given base image to the resulting
image, while ensuring that at most `maxLayers` are used. It will also
ensure that environment variables from the base image are propagated
to the final image.
Diffstat (limited to 'doc/builders/images')
-rw-r--r--doc/builders/images/dockertools.section.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/builders/images/dockertools.section.md b/doc/builders/images/dockertools.section.md
index 40d4dba1b85..23662f9bbfe 100644
--- a/doc/builders/images/dockertools.section.md
+++ b/doc/builders/images/dockertools.section.md
@@ -111,6 +111,12 @@ Create a Docker image with many of the store paths being on their own layer to i
 
     *Default:* the output path's hash
 
+`fromImage` _optional_
+
+: The repository tarball containing the base image. It must be a valid Docker image, such as one exported by `docker save`.
+
+    *Default:* `null`, which can be seen as equivalent to `FROM scratch` of a `Dockerfile`.
+
 `contents` _optional_
 
 : Top level paths in the container. Either a single derivation, or a list of derivations.