Commit graph

48 commits

Author SHA1 Message Date
Jade Lovelace b7665da7e1 dockerTools: support meta attribute
I want to be able to set descriptions on my docker image derivations
since these can be ingested by various tooling for helpfulness.
2025-10-30 15:53:00 -07:00
Joel Holdsworth db13980434
dockerTools: Updated Docker and OCI spec links
Co-authored-by: commiterate <111539270+commiterate@users.noreply.github.com>
2025-10-09 11:04:44 -07:00
Arne Keller d6199f835b
doc/build-helpers: fix appimage example where postExtract is used (#402756) 2025-09-23 08:48:42 +02:00
Ben Siraphob cc5b731ed3
doc: fix typos 2025-08-27 11:46:26 -07:00
Wolfgang Walther 62fe016519
treewide: run treefmt with mdcr/nixfmt 2025-07-24 13:52:31 +02:00
Axel Karjalainen 7159ab6f43 treewide: specify where mebibytes are used when it's ambiguous 2025-07-11 00:44:23 +03:00
FliegendeWurst 855da9ad35 doc/build-helpers: don't overuse pname
See #277994
2025-04-29 09:41:46 +02:00
FliegendeWurst 244b31e61b doc/build-helpers: fix appimage example where postExtract is used 2025-04-29 09:41:46 +02:00
Pol Dellaiera 3218a4204f doc: do not reuse pname 2025-04-21 07:02:49 +02:00
Pol Dellaiera bcea0cf344 doc: update Nix code snippets format
Command: `mdcr --config doc/tests/mdcr-config.toml doc/`
2025-04-17 01:30:34 +02:00
thomasjm 00a218abb2 mkBinaryCache: support different compression methods: xz (default), zstd, none 2025-02-04 05:49:39 -08:00
Jörg Thalheim ff8576f191
dockerTools.pullImage: accept hash parameter (#342400) 2024-12-09 15:32:15 +01:00
nicoo 5720f42c32 nix-prefetch-docker: provide hash in SRI format 2024-12-09 14:28:25 +01:00
nicoo d0e6b0e170 dockerTools.pullImage: accept hash parameter 2024-12-09 14:28:24 +01:00
Daniel Baker 052431ce98 doc: replace references to --replace for the substitute command
The `--replace` argument for `substitute` and `substituteInPlace` was
deprecated in e07a2fab7f. Updating all
references in the nixpkgs manual to use `--replace-fail`.
2024-11-06 14:08:28 -08:00
Tom Bereknyei d0b3364822 dockerTools: set mtime to epoch by default 2024-09-25 00:31:16 -04:00
WxNzEMof 847b4732e4 dockerTools: Allow separately specifying metadata and filesystem timestamps
Setting the image creation timestamp in the image metadata to a
constant date can cause problems with self-hosted container
registries, that need to e.g. prune old images.  This timestamp is
also useful for debugging.

However, it is almost never useful to set the filesystem timestamp to
a constant value.  Doing so not only causes the image to possibly no
longer be reproducible, but also removes any possibility of
deduplicating layers with other images, causing unnecessary storage
space usage.

Therefore, this commit introduces "mtime", a new parameter to
streamLayeredImage, which allows specifying the filesystem timestamps
separately from "created".  For backwards compatibility, "mtime"
defaults to the value of "created".
2024-09-25 00:23:20 -04:00
nicoo 19cf0942e3 doc: update all fetchurl invocations with a hash in SRI format 2024-09-17 10:47:31 +02:00
Robert Hensing ce974f8107
doc/dockertools: add note about base image config inheritance (#339555) 2024-09-04 17:49:09 +01:00
Mathias Sven 138d76c31b
doc/dockertools: add note about base image config inheritance 2024-09-04 15:41:32 +01:00
Robert Hensing c5e5aa7266
Merge pull request #308822 from yorickvP/yorickvp/streamLayeredImage-overridable
dockerTools.streamLayeredImage: add includeNixDB argument, expose conf and streamScript
2024-07-24 16:02:35 +02:00
Travis A. Everett 9ff9bbdb34
doc: add stdenv passthru chapter (#315909)
* doc: add stdenv passthru chapter

Broad strokes:
- create the chapter
- move existing stdenv passthru coverage into it
- move out-of-place coverage of passthru.tests from the stdenv meta chapter into it
- (try to) apply 1-sentence-per-line to text I've touched
- add legacy anchors for everything moved
- update existing links to the new anchors
- add tentative motivating text
- make nixpkgs-internal links relative/branchless

razor: if it is only ever needed by contributors, which is likely if links
refer to the latest revision of the source code, then it's for
the contributor guide

Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2024-06-11 10:51:03 +02:00
Alyssa Ross ba96c1f7e5 doc: fix make-disk-image.nix example 2024-06-04 21:46:41 +01:00
Yorick van Pelt 4d51990bc5
dockerTools: document streamLayeredImage's includeNixDB argument 2024-05-06 15:06:50 +02:00
Yorick van Pelt 62e9e0f963
dockerTools: add includeNixDB to buildImage and document 2024-05-06 14:57:08 +02:00
Janne Heß fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
DS 1d85557b50 snapTools: remove
`snapTools.makeSnap` has produced broken snaps since at least Oct 2020,
as indicated by the following issue: https://github.com/NixOS/nixpkgs/issues/100618

No person has shown interest in maintaining it, and given that there is
no fix available, it's assumed that all attempts made to fix that
function have not succeeded.

Given that `snapTools` only contained `makeSnap`, it was removed
completely.
2024-03-04 22:22:14 -08:00
DS 62552e3683 doc: update docs for portableService, follow doc conventions 2024-02-29 17:10:01 +01:00
Silvan Mosberger 67e55070eb
Merge pull request #290886 from DanielSidhion/update-ocitools
doc: update docs in ociTools, follow doc conventions
2024-02-29 16:32:36 +01:00
DS c73de6fac3 doc: update docs in ociTools, follow doc conventions 2024-02-29 16:30:04 +01:00
WxNzEMof 7799f4695b Document the new streamLayeredImage parameters 2024-02-26 18:41:07 +00:00
Robert Hensing d2dfcfcfad
Merge pull request #289584 from athre0z/docker-zstd
dockerTools: configurable compression schema
2024-02-19 18:06:54 +01:00
Joel Höner 4b603ad9cd dockerTools: configurable compression schema
This commit adds support for swapping out the compression algorithm
used in all major docker-tools commands that generate images. The
default algorithm remains unchanged (gzip).
2024-02-17 18:52:42 +01:00
DS ba79b098ea doc: use long-form docker commands, improve wording 2024-02-12 15:38:00 -08:00
DS 5677230de3 doc: update buildNixShellImage docs, add streamNixShellImage docs 2024-02-08 07:49:16 -08:00
Silvan Mosberger b94e9dd7a5
Merge pull request #285223 from DanielSidhion/update-dockertools-envhelpers
doc: update environment helpers in dockerTools docs, add fakeNss section
2024-02-08 16:31:33 +01:00
Daniel Sidhion 2f61aff9ae
doc: update dockerTools.exportImage content and use doc conventions (#283392)
* doc: update dockerTools.exportImage content and use doc conventions

* Apply suggestions from code review

Co-authored-by: Silvan Mosberger <github@infinisil.com>

---------

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-02-01 16:54:26 +01:00
DS 0445c39047 doc: update environment helpers in dockerTools docs, add fakeNss section
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2024-02-01 01:37:31 -08:00
Silvan Mosberger 2c2b366c59
Merge pull request #283106 from DanielSidhion/update-dockertools-pullimage
doc: update dockerTools.pullImage content and use doc conventions
2024-01-25 16:54:18 +01:00
DS e08482a601 doc: update dockerTools.pullImage content and use doc conventions 2024-01-25 16:51:27 +01:00
Silvan Mosberger f7609960db
Merge pull request #283394 from DanielSidhion/fix-dockertools-example
doc: add missing attribute to example in dockerTools
2024-01-25 16:19:30 +01:00
Kevin Brubeck Unhammer ad99ac9356
doc: Note on how to use shadowSetup with buildLayeredImage (#267220)
* Note on how to use shadowSetup with buildLayeredImage

* Update doc/build-helpers/images/dockertools.section.md

---------

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-01-25 16:10:21 +01:00
DS ad83240aad doc: add missing attribute to example in dockerTools 2024-01-23 20:58:41 -08:00
DS 2004205b7a doc: update content on dockerTools layered images and follow doc conventions 2024-01-18 17:26:24 +01:00
DS 2c9e2b6569 doc: update content on dockerTools.buildImage and follow doc conventions 2024-01-16 23:56:59 -08:00
DS f0fb6f0a26 doc: update mkBinaryCache section with admonitions and conventions
The mkBinaryCache section now follows the convention of using one
line per sentence, as well as using admonitions for notes and
examples.

The example syntax was updated to define a fully-working nix package.
2023-12-25 17:34:59 -08:00
Daniel Sidhion e525be5a07
doc: update the appimageTools section content and examples (#276029)
The following changes are made:
- Document how `wrapType2` and `wrapType1` are the same thing.
- Expand on how `wrapType2` works and additional arguments it uses.
- Document `extract` and show how it's used in combination with
  `wrapType2`.
- Provide full working examples using the new admonition syntax.
2023-12-23 11:36:25 +01:00
Yueh-Shun Li 9963ad5c5f doc: builders -> build helpers to reduce ambigualty 2023-11-07 19:58:53 +00:00