mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(book): Update information on new layering strategy

Browse source
This commit is contained in:
Vincent Ambo 2019-08-15 11:50:23 +01:00 committed by Vincent Ambo
parent ca1ffb397d
commit 0ec369d76c
2 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
tools/nixery/docs/src/nixery.md
View file

@ -7,8 +7,11 @@ contain packages from the [Nix][] package manager. Images with arbitrary
packages can be requested via the image name. packages can be requested via the image name.
Nix not only provides the packages to include in the images, but also builds the Nix not only provides the packages to include in the images, but also builds the
images themselves by using an interesting layering strategy described in [this images themselves by using a special [layering strategy][] that optimises for
blog post][layers]. cache efficiency.
For general information on why using Nix makes sense for container images, check
out [this blog post][layers].
## Quick start ## Quick start
@ -65,13 +68,11 @@ availability.
### Who made this? ### Who made this?
Nixery was written mostly by [tazjin][]. Nixery was written by [tazjin][], but many people have contributed to Nix over
time, maybe you could become one of them?
[grahamc][] authored the image layering strategy. Many people have contributed
to Nix over time, maybe you could become one of them?
[Nixery]: https://github.com/google/nixery [Nixery]: https://github.com/google/nixery
[Nix]: https://nixos.org/nix [Nix]: https://nixos.org/nix
[layering-strategy]: https://storage.googleapis.com/nixdoc/nixery-layers.html
[layers]: https://grahamc.com/blog/nix-and-layered-docker-images [layers]: https://grahamc.com/blog/nix-and-layered-docker-images
[tazjin]: https://github.com/tazjin [tazjin]: https://github.com/tazjin
[grahamc]: https://github.com/grahamc

4
tools/nixery/docs/src/under-the-hood.md
View file

@ -51,7 +51,8 @@ does not allow uppercase characters, so the Nix code will translate something
like `haskellpackages` (lowercased) to the correct attribute name. like `haskellpackages` (lowercased) to the correct attribute name.
After identifying all contents, Nix determines the contents of each layer while After identifying all contents, Nix determines the contents of each layer while
optimising for the best possible cache efficiency. optimising for the best possible cache efficiency (see the [layering design
doc][] for details).
Finally it builds each layer, assembles the image manifest as JSON structure, Finally it builds each layer, assembles the image manifest as JSON structure,
and yields this manifest back to the web server. and yields this manifest back to the web server.
@ -103,3 +104,4 @@ to run the image produced by Nixery.
[gcs]: https://cloud.google.com/storage/ [gcs]: https://cloud.google.com/storage/
[signed URLs]: https://cloud.google.com/storage/docs/access-control/signed-urls [signed URLs]: https://cloud.google.com/storage/docs/access-control/signed-urls
[layering design doc]: https://storage.googleapis.com/nixdoc/nixery-layers.html