diff options
| author | Graham Christensen <graham@grahamc.com> | 2018-09-20 20:23:04 -0400 |
|---|---|---|
| committer | Graham Christensen <graham@grahamc.com> | 2018-09-20 20:23:04 -0400 |
| commit | 7736337916538aab67a00739c53b8434da773a3b (patch) | |
| tree | 7e916940ca4f1522c32dc7efcba8d09d97c6072c /doc/functions.xml | |
| parent | 10450ffd5b155410a6be01cda393c926639424a9 (diff) | |
Clarfy the binary reproducibility problems of created=now with dockerTools.buildImage.
Diffstat (limited to 'doc/functions.xml')
| -rw-r--r-- | doc/functions.xml | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/functions.xml b/doc/functions.xml index 31b40fb084a3..0c0d82b0342c 100644 --- a/doc/functions.xml +++ b/doc/functions.xml @@ -642,10 +642,12 @@ buildImage { <example xml:id="example-pkgs-dockerTools-buildImage-creation-date"> <title>Impurely Defining a Docker Layer's Creation Date</title> <para> - Because dates are an impurity, by default - <function>buildImage</function> will use a static date of one - second past the UNIX Epoch. This can be a bit frustrating when - listing docker images in the CLI: + By default <function>buildImage</function> will use a static + date of one second past the UNIX Epoch. This allows + <function>buildImage</function> to produce binary reproducible + images. When listing images with <command>docker list + images</command>, the newly created images will be listed like + this: </para> <screen><![CDATA[ $ docker image list @@ -653,9 +655,9 @@ REPOSITORY TAG IMAGE ID CREATED SIZE hello latest 08c791c7846e 48 years ago 25.2MB ]]></screen> <para> - If you want to trade the purity for a better user experience, - you can set <literal>created</literal> to - <literal>now</literal>. + You can break binary reproducibility but have a sorted, + meaningful <literal>CREATED</literal> column by setting + <literal>created</literal> to <literal>now</literal>. </para> <programlisting><![CDATA[ pkgs.dockerTools.buildImage { @@ -670,12 +672,13 @@ pkgs.dockerTools.buildImage { <para> and now the Docker CLI will display a reasonable date and sort the images as expected: - </para> - <screen><![CDATA[ + <screen><![CDATA[ $ docker image list REPOSITORY TAG IMAGE ID CREATED SIZE hello latest de2bf4786de6 About a minute ago 25.2MB ]]></screen> + however, the produced images will not be binary reproducible. + </para> </example> </section> |