about summary refs log tree commit diff
path: root/doc/builders/images
AgeCommit message (Collapse)AuthorFilesLines
2023-03-27doc: assign ids to many headingspennae3-8/+8
without stable ids on headings we cannot generate stable links to these headings. nrd complains about this, but the current docbook workflow does not. a few generated ids remain, mostly in examples and footnotes. most of the examples are generated by nixdoc (which has since gained MD export functions, and the MD export does generate IDs).
2023-02-26nixos/lib/make-disk-image: expose memSize parameterNick Bathum1-0/+1
Generating large disk images can fail from out-of-memory in vm-run.
2023-02-07Doc tweak: "Build" -> "Substitute"Tom McLaughlin1-1/+1
2023-02-07Introduce mkBinaryCache functionTom McLaughlin1-0/+49
2023-01-26fix: doc typoMatthew Kenigsberg1-1/+1
2022-12-29.editorconfig: apply trailing whitespace removalNaïm Favier1-1/+1
editorconfig-checker -disable-indent-size **/*.md
2022-12-27doc,nixos/doc: unescape apostrophesNaïm Favier1-1/+1
Leftovers from the CommonMark conversion.
2022-12-24nixos/lib/make-disk-image: docs, UEFI vars recording, more determinismRaito Bezarius1-0/+107
- Extensive documentation in NixOS manual - Deterministic mode that fixes various identifiers relative to disk partitions and filesystems in ext4 case - UEFI variable recording
2022-12-08dockerTools: allowing architecture to be specifiedChristian Kemper1-0/+4
... for buildImage, buildLayeredImage and streamLayeredImage, adding docs and tests.
2022-12-04doc: use sri hash syntaxColin Arnott2-4/+4
The nixpkgs manual contains references to both sri hash and explicit sha256 attributes. This is at best confusing to new users. Since the final destination is exclusive use of sri hashes, see nixos/rfcs#131, might as well push new users in that direction gently. Notable exceptions to sri hash support are builtins.fetchTarball, cataclysm-dda, coq, dockerTools.pullimage, elixir.override, and fetchCrate. None, other than builtins.fetchTarball, are fundamentally incompatible, but all currently accept explicit sha256 attributes as input. Because adding backwards compatibility is out of scope for this change, they have been left intact, but migration to sri format has been made for any using old hash formats. All hashes have been manually tested to be accurate, and updates were only made for missing upstream artefacts or bugs.
2022-11-26Merge pull request #172736 from infinisil/docker-nix-shellSilvan Mosberger1-0/+139
2022-11-08nixpkgs/doc: fix admonition syntaxRyan Mulligan1-3/+3
Match admonition syntax in https://nixos.org/manual/nixpkgs/unstable/#chap-contributing
2022-10-07Introduce dockerTools.buildNixShellImageSilvan Mosberger1-0/+139
2022-10-07add documentation for the pkgs.portableService tool (#193081)Дамјан Георгиевски1-0/+81
* add documentation for the pkgs.portableService tool as introduced in 499aebcf340 Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-08-31Merge pull request #170906 from Sohalt/dockerTools.ca-certificates.crtRobert Hensing1-1/+38
dockerTools ca-certificates.crt helper
2022-08-16dockerTools.buildImage: make VM memSize configurableAlex James1-0/+7
Fixes #186752. This adds buildVMMemorySize (defaults to 512 MiB) to buildImage, which is passed to vm.runInLinuxVM. This is needed for larger base images, which may otherwise cause container build failures due to OOM in the VM.
2022-08-01nixos/doc: update contents to copyToRootFlorian Klink1-6/+7
contents is deprecated now, use the copyToRoot attribute.
2022-08-01Update doc/builders/images/dockertools.section.mdFlorian Klink1-1/+1
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-08-01nixos/doc: document fakeNss, binShFlorian Klink1-0/+28
2022-07-07dockerTools: document environment helperssohalt1-1/+38
2022-07-06dockerTools.buildImage: Add copyToRoot to replace contents, explain usageRobert Hensing1-3/+12
2022-06-05doc/builders/images/dockertools: improve shadowSetup exampleMirco Bauer1-1/+1
The example snippet will fail with this error as it is not self contained and assumes `shadowSetup` was given: $ nix-build docker-image.nix error: undefined variable 'shadowSetup' at docker-image.nix:20:7 Instead use the full reference to `shadowSetup` in the example so it will work as stated.
2022-03-10doc/builders: fix typosMartino Fontana3-12/+12
2021-12-04dockerTools: Keep fakechroot disabled by defaultRobert Hensing1-3/+3
Avoid risk of breaking existing images by making it opt-in.
2021-12-04dockerTools: Add fakechroot to fakeRootCommandsRobert Hensing1-1/+7
2021-06-07doc: prepare for commonmarkJan Tojnar3-5/+5
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly. Notably: - Line breaks in lists behave differently. - Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75 - The auto_identifiers uses a different algorithm – I made the previous ones explicit. - Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist While at it, I also fixed the following issues: - ShellSesssion was used - Removed some pointless docbook tags.
2021-04-24doc/builders/images/*.xml: Convert to markdownBobby Rong6-201/+119
2021-04-07Merge pull request #116749 from vroad/docker-layered-image-fakerootRobert Hensing1-0/+4
dockerTools.streamLayeredImage: add fakeRootCommands option
2021-03-31Merge pull request #108917 from bryanasdev000/doc-ocitoolsRyan Mulligan2-61/+37
ocitools: Update doc to use CommonMark
2021-03-24dockerTools.streamLayeredImage: Update documentationvroad1-1/+1
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2021-03-23Merge pull request #115857 from lbpdt/feature/docker-tools-layered-base-imageBenjamin Hipple1-0/+6
dockerTools.buildLayeredImage: support fromImage
2021-03-23dockerTools.buildLayeredImage: support fromImageLouis Blin1-0/+6
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.
2021-03-22doc/builders/images/ocitools.xml: Convert to markdownBryan A. S2-61/+37
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-19dockerTools.streamLayeredImage: document fakeRootCommandsvroad1-0/+4
2021-03-14Remove repeating words from docFlorian Engel1-1/+1
2021-03-09doc: remove unnecessary \ escapes in dockertools.section.mdBenjamin Hipple1-14/+14
These pollute the plain text and, after re-running `nix-build` and looking at the result, do not appear to have any impact on the rendered version.
2021-03-04doc/builders/images/dockertools.section.md: Fix link labelsRobert Hensing1-2/+2
2021-03-04doc/builders/images/dockertools.section.md: Fix anchor errorsBryan A. S1-4/+7
Also change note notation Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-04doc/builders/images/dockertools.section.md: Indent nix codeBryan A. S1-68/+67
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-04doc/builders/images/dockertools.xml: Convert to markdown and start improvementsBryan A. S2-499/+296
Need to verify things like `error: IDREF "" without matching ID` and `::: {.note}` Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2020-09-23doc: Improve code listingsJan Tojnar2-8/+7
By adding prompts and removing unnecessary indentation.
2020-06-22Add docs for dockerTools.streamLayeredImageSteve Purcell1-1/+22
2020-04-18treewide: per RFC45, remove more unquoted URLsPavol Rusnak1-1/+1
2020-02-16doc/ociTools: exec is a shell builtin, not an external commandedef1-1/+1
2020-01-23doc: Fix callout reference in appimagetoolsadisbladis1-1/+1
2019-12-16dockerTools: the API has basically never changedGraham Christensen1-6/+0
2019-10-21doc: move image builders into new images chapterFrederik Rietdijk6-0/+747