diff options
Diffstat (limited to 'nixpkgs/doc/functions/ocitools.xml')
| -rw-r--r-- | nixpkgs/doc/functions/ocitools.xml | 30 |
1 files changed, 8 insertions, 22 deletions
diff --git a/nixpkgs/doc/functions/ocitools.xml b/nixpkgs/doc/functions/ocitools.xml index 4500c41a34ae..f61075b242f8 100644 --- a/nixpkgs/doc/functions/ocitools.xml +++ b/nixpkgs/doc/functions/ocitools.xml @@ -5,36 +5,28 @@ <title>pkgs.ociTools</title> <para> - <varname>pkgs.ociTools</varname> is a set of functions for creating - containers according to the - <link xlink:href="https://github.com/opencontainers/runtime-spec">OCI - container specification v1.0.0</link>. Beyond that it makes no assumptions - about the container runner you choose to use to run the created container. + <varname>pkgs.ociTools</varname> is a set of functions for creating containers according to the <link xlink:href="https://github.com/opencontainers/runtime-spec">OCI container specification v1.0.0</link>. Beyond that it makes no assumptions about the container runner you choose to use to run the created container. </para> <section xml:id="ssec-pkgs-ociTools-buildContainer"> <title>buildContainer</title> <para> - This function creates a simple OCI container that runs a single command - inside of it. An OCI container consists of a <varname>config.json</varname> - and a rootfs directory.The nix store of the container will contain all - referenced dependencies of the given command. + This function creates a simple OCI container that runs a single command inside of it. An OCI container consists of a <varname>config.json</varname> and a rootfs directory.The nix store of the container will contain all referenced dependencies of the given command. </para> <para> - The parameters of <varname>buildContainer</varname> with an example value - are described below: + The parameters of <varname>buildContainer</varname> with an example value are described below: </para> <example xml:id='ex-ociTools-buildContainer'> <title>Build Container</title> <programlisting> buildContainer { - cmd = with pkgs; writeScript "run.sh" '' + args = [ (with pkgs; writeScript "run.sh" '' #!${bash}/bin/bash ${coreutils}/bin/exec ${bash}/bin/bash - ''; <co xml:id='ex-ociTools-buildContainer-1' /> + '').outPath ]; <co xml:id='ex-ociTools-buildContainer-1' /> mounts = { "/data" = { @@ -51,23 +43,17 @@ buildContainer { <calloutlist> <callout arearefs='ex-ociTools-buildContainer-1'> <para> - <varname>cmd</varname> specifies the program to run inside the container. - This is the only required argument for <varname>buildContainer</varname>. - All referenced packages inside the derivation will be made available - inside the container + <varname>args</varname> specifies a set of arguments to run inside the container. This is the only required argument for <varname>buildContainer</varname>. All referenced packages inside the derivation will be made available inside the container </para> </callout> <callout arearefs='ex-ociTools-buildContainer-2'> <para> - <varname>mounts</varname> specifies additional mount points chosen by the - user. By default only a minimal set of necessary filesystems are mounted - into the container (e.g procfs, cgroupfs) + <varname>mounts</varname> specifies additional mount points chosen by the user. By default only a minimal set of necessary filesystems are mounted into the container (e.g procfs, cgroupfs) </para> </callout> <callout arearefs='ex-ociTools-buildContainer-3'> <para> - <varname>readonly</varname> makes the container's rootfs read-only if it is set to true. - The default value is false <literal>false</literal>. + <varname>readonly</varname> makes the container's rootfs read-only if it is set to true. The default value is false <literal>false</literal>. </para> </callout> </calloutlist> |