JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc/builders/images/dockertools.section.md: Indent nix code

Browse Source 
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
This commit is contained in:
Bryan A. S 2021-01-10 02:12:12 -03:00 committed by Robert Hensing
parent 4b99dbbbcc
commit 06e40b3caf
1 changed files with 62 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

125
doc/builders/images/dockertools.section.md
View File

@ -9,28 +9,26 @@ This function is analogous to the `docker build` command, in that it can be used
The parameters of `buildImage` with relative example values are described below: The parameters of `buildImage` with relative example values are described below:
```nix ```nix
buildImage { buildImage {
name = "redis"; name = "redis";
tag = "latest"; tag = "latest";
fromImage = someBaseImage; fromImage = someBaseImage;
fromImageName = null; fromImageName = null;
fromImageTag = "latest"; fromImageTag = "latest";
contents = pkgs.redis; contents = pkgs.redis;
runAsRoot = '' runAsRoot = ''
#!${pkgs.runtimeShell} #!${pkgs.runtimeShell}
mkdir -p /data mkdir -p /data
''; '';
config = { config = {
Cmd = [ "/bin/redis-server" ]; Cmd = [ "/bin/redis-server" ];
WorkingDir = "/data"; WorkingDir = "/data";
Volumes = { Volumes = { "/data" = { }; };
"/data" = {}; };
}; }
};
}
``` ```
The above example will build a Docker image `redis/latest` from the given base image. Loading and running this image in Docker results in `redis-server` being started automatically. The above example will build a Docker image `redis/latest` from the given base image. Loading and running this image in Docker results in `redis-server` being started automatically.
@ -76,14 +74,14 @@ hello latest 08c791c7846e 48 years ago 25.2MB
You can break binary reproducibility but have a sorted, meaningful `CREATED` column by setting `created` to `now`. You can break binary reproducibility but have a sorted, meaningful `CREATED` column by setting `created` to `now`.
```nix ```nix
pkgs.dockerTools.buildImage { pkgs.dockerTools.buildImage {
name = "hello"; name = "hello";
tag = "latest"; tag = "latest";
created = "now"; created = "now";
contents = pkgs.hello; contents = pkgs.hello;
config.Cmd = [ "/bin/hello" ]; config.Cmd = [ "/bin/hello" ];
} }
``` ```
and now the Docker CLI will display a reasonable date and sort the images as expected: and now the Docker CLI will display a reasonable date and sort the images as expected:
@ -147,18 +145,18 @@ Each path directly listed in `contents` will have a symlink in the root of the i
For example: For example:
```nix ```nix
pkgs.dockerTools.buildLayeredImage { pkgs.dockerTools.buildLayeredImage {
name = "hello"; name = "hello";
contents = [ pkgs.hello ]; contents = [ pkgs.hello ];
} }
``` ```
will create symlinks for all the paths in the `hello` package: will create symlinks for all the paths in the `hello` package:
```ShellSession ```ShellSession
/bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello /bin/hello -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/bin/hello
/share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info /share/info/hello.info -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/info/hello.info
/share/locale/bg/LC_MESSAGES/hello.mo -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/locale/bg/LC_MESSAGES/hello.mo /share/locale/bg/LC_MESSAGES/hello.mo -> /nix/store/h1zb1padqbbb7jicsvkmrym3r6snphxg-hello-2.10/share/locale/bg/LC_MESSAGES/hello.mo
``` ```
### Automatic inclusion of `config` references {#dockerTools-buildLayeredImage-arg-config} ### Automatic inclusion of `config` references {#dockerTools-buildLayeredImage-arg-config}
@ -168,10 +166,10 @@ The closure of `config` is automatically included in the closure of the final im
This allows you to make very simple Docker images with very little code. This container will start up and run `hello`: This allows you to make very simple Docker images with very little code. This container will start up and run `hello`:
```nix ```nix
pkgs.dockerTools.buildLayeredImage { pkgs.dockerTools.buildLayeredImage {
name = "hello"; name = "hello";
config.Cmd = [ "${pkgs.hello}/bin/hello" ]; config.Cmd = [ "${pkgs.hello}/bin/hello" ];
} }
``` ```
### Adjusting `maxLayers` {#dockerTools-buildLayeredImage-arg-maxLayers} ### Adjusting `maxLayers` {#dockerTools-buildLayeredImage-arg-maxLayers}
@ -209,15 +207,16 @@ This function is analogous to the `docker pull` command, in that it can be used
Its parameters are described in the example below: Its parameters are described in the example below:
```nix ```nix
pullImage { pullImage {
imageName = "nixos/nix"; imageName = "nixos/nix";
imageDigest = "sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b"; imageDigest =
finalImageName = "nix"; "sha256:20d9485b25ecfd89204e843a962c1bd70e9cc6858d65d7f5fadc340246e2116b";
finalImageTag = "1.11"; finalImageName = "nix";
sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8"; finalImageTag = "1.11";
os = "linux"; sha256 = "0mqjy3zq2v6rrhizgb9nvhczl87lcfphq9601wcprdika2jz7qh8";
arch = "x86_64"; os = "linux";
} arch = "x86_64";
}
``` ```
- `imageName` specifies the name of the image to be downloaded, which can also include the registry namespace (e.g. `nixos`). This argument is required. - `imageName` specifies the name of the image to be downloaded, which can also include the registry namespace (e.g. `nixos`). This argument is required.
@ -261,13 +260,13 @@ This function is analogous to the `docker export` command, in that it can be use
The parameters of `exportImage` are the following: The parameters of `exportImage` are the following:
```nix ```nix
exportImage { exportImage {
fromImage = someLayeredImage; fromImage = someLayeredImage;
fromImageName = null; fromImageName = null;
fromImageTag = null; fromImageTag = null;
name = someLayeredImage.name; name = someLayeredImage.name;
} }
``` ```
The parameters relative to the base image have the same synopsis as described in [buildImage](#ssec-pkgs-dockerTools-buildImage), except that `fromImage` is the only required argument in this case. The parameters relative to the base image have the same synopsis as described in [buildImage](#ssec-pkgs-dockerTools-buildImage), except that `fromImage` is the only required argument in this case.
@ -279,18 +278,18 @@ The `name` argument is the name of the derivation output, which defaults to `fro
This constant string is a helper for setting up the base files for managing users and groups, only if such files don\'t exist already. It is suitable for being used in a `runAsRoot` [co_title](#ex-dockerTools-buildImage-runAsRoot) script for cases like in the example below: This constant string is a helper for setting up the base files for managing users and groups, only if such files don\'t exist already. It is suitable for being used in a `runAsRoot` [co_title](#ex-dockerTools-buildImage-runAsRoot) script for cases like in the example below:
```nix ```nix
buildImage { buildImage {
name = "shadow-basic"; name = "shadow-basic";
runAsRoot = '' runAsRoot = ''
#!${pkgs.runtimeShell} #!${pkgs.runtimeShell}
${shadowSetup} ${shadowSetup}
groupadd -r redis groupadd -r redis
useradd -r -g redis redis useradd -r -g redis redis
mkdir /data mkdir /data
chown redis:redis /data chown redis:redis /data
''; '';
} }
``` ```
Creating base files like `/etc/passwd` or `/etc/login.defs` is necessary for shadow-utils to manipulate users and groups. Creating base files like `/etc/passwd` or `/etc/login.defs` is necessary for shadow-utils to manipulate users and groups.