diff options
author | Jaka Hudoklin <jaka@gatehub.net> | 2019-03-26 10:35:21 +0100 |
---|---|---|
committer | Jaka Hudoklin <jaka@gatehub.net> | 2019-03-26 19:35:14 +0100 |
commit | 468df177c4f01bce239da426710484fbc7b5a89d (patch) | |
tree | af590b97a67010b7c99f768817c71bd19ec85f6d /doc | |
parent | c10bc73988d520b8a6c3051a58583f2d73c95e99 (diff) |
dockerTools: add finalImageName parameter for pullImage
Diffstat (limited to 'doc')
-rw-r--r-- | doc/functions/dockertools.xml | 23 |
1 files changed, 16 insertions, 7 deletions
diff --git a/doc/functions/dockertools.xml b/doc/functions/dockertools.xml index 75db0bd3918c6..cb32db74b424c 100644 --- a/doc/functions/dockertools.xml +++ b/doc/functions/dockertools.xml @@ -417,10 +417,11 @@ pkgs.dockerTools.buildLayeredImage { pullImage { imageName = "nixos/nix"; <co xml:id='ex-dockerTools-pullImage-1' /> imageDigest = "sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b"; <co xml:id='ex-dockerTools-pullImage-2' /> - finalImageTag = "1.11"; <co xml:id='ex-dockerTools-pullImage-3' /> - sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; <co xml:id='ex-dockerTools-pullImage-4' /> - os = "linux"; <co xml:id='ex-dockerTools-pullImage-5' /> - arch = "x86_64"; <co xml:id='ex-dockerTools-pullImage-6' /> + finalImageName = "nix"; <co xml:id='ex-dockerTools-pullImage-3' /> + finalImageTag = "1.11"; <co xml:id='ex-dockerTools-pullImage-4' /> + sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; <co xml:id='ex-dockerTools-pullImage-5' /> + os = "linux"; <co xml:id='ex-dockerTools-pullImage-6' /> + arch = "x86_64"; <co xml:id='ex-dockerTools-pullImage-7' /> } </programlisting> </example> @@ -452,25 +453,33 @@ sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b </callout> <callout arearefs='ex-dockerTools-pullImage-3'> <para> + <varname>finalImageName</varname>, if specified, this is the name of the + image to be created. Note it is never used to fetch the image since we + prefer to rely on the immutable digest ID. By default it's equal to + <varname>imageName</varname>. + </para> + </callout> + <callout arearefs='ex-dockerTools-pullImage-4'> + <para> <varname>finalImageTag</varname>, if specified, this is the tag of the image to be created. Note it is never used to fetch the image since we prefer to rely on the immutable digest ID. By default it's <literal>latest</literal>. </para> </callout> - <callout arearefs='ex-dockerTools-pullImage-4'> + <callout arearefs='ex-dockerTools-pullImage-5'> <para> <varname>sha256</varname> is the checksum of the whole fetched image. This argument is required. </para> </callout> - <callout arearefs='ex-dockerTools-pullImage-5'> + <callout arearefs='ex-dockerTools-pullImage-6'> <para> <varname>os</varname>, if specified, is the operating system of the fetched image. By default it's <literal>linux</literal>. </para> </callout> - <callout arearefs='ex-dockerTools-pullImage-6'> + <callout arearefs='ex-dockerTools-pullImage-7'> <para> <varname>arch</varname>, if specified, is the cpu architecture of the fetched image. By default it's <literal>x86_64</literal>. |