b12f/nixpkgs
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

nixos/oci-containers: improve description of imageFile

Browse source 
As a novice to using this module, I found the existing description to be
quite misleading. It does not at all disable pulling from the registry,
it just loads some image archive that may or may not be related to the
container you're specifying. I had thought there was extra magic behind
this option, but it's just a `docker load`. You need foreknowledge of
the contents of the archive so that whatever it contained is actually
used to run the container.

I've reworded the description to hopefully make this behavior clearer.
This commit is contained in:
Ian Kerins 2022-03-08 03:11:47 -05:00 committed by Bjørn Forsman
parent c91456e4d3
commit 4c6772e2a1
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
nixos/modules/virtualisation/oci-containers.nix
View file

@ -22,11 +22,13 @@ let
type = with types; nullOr package;
default = null;
description = ''
Path to an image file to load instead of pulling from a registry.
If defined, do not pull from registry.
Path to an image file to load before running the image. This can
be used to bypass pulling the image from the registry.
You still need to set the <literal>image</literal> attribute, as it
will be used as the image name for docker to start a container.
The <literal>image</literal> attribute must match the name and
tag of the image contained in this file, as they will be used to
run the container with that image. If they do not match, the
image will be pulled from the registry as usual.
'';
example = literalExpression "pkgs.dockerTools.buildImage {...};";
};