commit 0eff947d0b8c28338d9c082485c346f5028deb53 · pyrox.dev/nixpkgs

doc/builders/special.xml

···

       9
       9
        
        <xi:include href="special/makesetuphook.section.xml" />

     

       10
       10
        
        <xi:include href="special/mkshell.section.xml" />

     

       11
       11
        
        <xi:include href="special/darwin-builder.section.xml" />

     

       12
       12
       +
        <xi:include href="special/vm-tools.section.xml" />

     

       12
       13
        
       </chapter>

+116

doc/builders/special/vm-tools.section.md

···

       1
       1
       +
       # vmTools {#sec-vm-tools}

     

       2
       2
       +
       

     

       3
       3
       +
       A set of VM related utilities, that help in building some packages in more advanced scenarios.

     

       4
       4
       +
       

     

       5
       5
       +
       ## `vmTools.createEmptyImage` {#vm-tools-createEmptyImage}

     

       6
       6
       +
       

     

       7
       7
       +
       A bash script fragment that produces a disk image at `destination`.

     

       8
       8
       +
       

     

       9
       9
       +
       ### Attributes

     

       10
       10
       +
       

     

       11
       11
       +
       * `size`. The disk size, in MiB.

     

       12
       12
       +
       * `fullName`. Name that will be written to `${destination}/nix-support/full-name`.

     

       13
       13
       +
       * `destination` (optional, default `$out`). Where to write the image files.

     

       14
       14
       +
       

     

       15
       15
       +
       ## `vmTools.runInLinuxVM` {#vm-tools-runInLinuxVM}

     

       16
       16
       +
       

     

       17
       17
       +
       Run a derivation in a Linux virtual machine (using Qemu/KVM). By default, there is no disk image; the root filesystem is

     

       18
       18
       +
       a `tmpfs`, and the nix store is shared with the host (via the 9P protocol). Thus, any pure Nix derivation should run

     

       19
       19
       +
       unmodified.

     

       20
       20
       +
       

     

       21
       21
       +
       If the build fails and Nix is run with the `-K` option, a script `run-vm` will be left behind in the temporary build

     

       22
       22
       +
       directory that allows you to boot into the VM and debug it interactively.

     

       23
       23
       +
       

     

       24
       24
       +
       ### Attributes

     

       25
       25
       +
       

     

       26
       26
       +
       * `preVM` (optional). Shell command to be evaluated *before* the VM is started (i.e., on the host).

     

       27
       27
       +
       * `memSize` (optional, default `512`). The memory size of the VM in megabytes.

     

       28
       28
       +
       * `diskImage` (optional). A file system image to be attached to `/dev/sda` (Note that currently we expect the image to

     

       29
       29
       +
         contain a filesystem, not a full disk image with a partition table etc).

     

       30
       30
       +
       

     

       31
       31
       +
       ### Examples

     

       32
       32
       +
       

     

       33
       33
       +
       ```nix

     

       34
       34
       +
       # Build the derivation hello inside a VM

     

       35
       35
       +
       runInLinuxVM hello

     

       36
       36
       +
       

     

       37
       37
       +
       # Build inside a VM with extra memory

     

       38
       38
       +
       runInLinuxVM (hello.overrideAttrs (_: { memSize = 1024; }))

     

       39
       39
       +
       

     

       40
       40
       +
       # Use VM with a disk image (implicitly sets `diskImage`, see `vmTools.createEmptyImage`)

     

       41
       41
       +
       runInLinuxVM (hello.overrideAttrs (_: { preVM = createEmptyImage { size = 1024; fullName = "vm-image"; }; }))

     

       42
       42
       +
       ```

     

       43
       43
       +
       

     

       44
       44
       +
       <!-- TODO

     

       45
       45
       +
       ## `vmTools.extractFs` {#vm-tools-extractFs}

     

       46
       46
       +
       ## `vmTools.extractMTDfs` {#vm-tools-extractMTDfs}

     

       47
       47
       +
       -->

     

       48
       48
       +
       

     

       49
       49
       +
       ## `vmTools.runInLinuxImage` {#vm-tools-runInLinuxImage}

     

       50
       50
       +
       

     

       51
       51
       +
       Like [](#vm-tools-runInLinuxVM), but run the build not using the `stdenv` from the Nix store, but using the tools

     

       52
       52
       +
       provided by `/bin`, `/usr/bin`, etc. from the specified filesystem image, which typically is a filesystem containing a

     

       53
       53
       +
       non-NixOS Linux distribution.

     

       54
       54
       +
       

     

       55
       55
       +
       ## `vmTools.makeImageTestScript` {#vm-tools-makeImageTestScript}

     

       56
       56
       +
       

     

       57
       57
       +
       Generate a script that can be used to run an interactive session in the given image.

     

       58
       58
       +
       

     

       59
       59
       +
       ### Examples

     

       60
       60
       +
       

     

       61
       61
       +
       ```nix

     

       62
       62
       +
       # Create a script for running a Fedora 27 VM

     

       63
       63
       +
       makeImageTestScript diskImages.fedora27x86_64

     

       64
       64
       +
       

     

       65
       65
       +
       # Create a script for running an Ubuntu 20.04 VM

     

       66
       66
       +
       makeImageTestScript diskImages.ubuntu2004x86_64

     

       67
       67
       +
       ```

     

       68
       68
       +
       

     

       69
       69
       +
       ## `vmTools.diskImageFuns` {#vm-tools-diskImageFuns}

     

       70
       70
       +
       

     

       71
       71
       +
       A set of functions that build a predefined set of minimal Linux distributions images.

     

       72
       72
       +
       

     

       73
       73
       +
       ### Images

     

       74
       74
       +
       

     

       75
       75
       +
       * Fedora

     

       76
       76
       +
         * `fedora26x86_64`

     

       77
       77
       +
         * `fedora27x86_64`

     

       78
       78
       +
       * CentOS

     

       79
       79
       +
         * `centos6i386`

     

       80
       80
       +
         * `centos6x86_64`

     

       81
       81
       +
         * `centos7x86_64`

     

       82
       82
       +
       * Ubuntu

     

       83
       83
       +
         * `ubuntu1404i386`

     

       84
       84
       +
         * `ubuntu1404x86_64`

     

       85
       85
       +
         * `ubuntu1604i386`

     

       86
       86
       +
         * `ubuntu1604x86_64`

     

       87
       87
       +
         * `ubuntu1804i386`

     

       88
       88
       +
         * `ubuntu1804x86_64`

     

       89
       89
       +
         * `ubuntu2004i386`

     

       90
       90
       +
         * `ubuntu2004x86_64`

     

       91
       91
       +
       * Debian

     

       92
       92
       +
         * `debian9i386`

     

       93
       93
       +
         * `debian9x86_64`

     

       94
       94
       +
         * `debian10i386`

     

       95
       95
       +
         * `debian10x86_64`

     

       96
       96
       +
       

     

       97
       97
       +
       ### Attributes

     

       98
       98
       +
       

     

       99
       99
       +
       * `size` (optional, defaults to `4096`). The size of the image, in megabytes.

     

       100
       100
       +
       * `extraPackages` (optional). A list names of additional packages from the distribution that should be included in the

     

       101
       101
       +
         image.

     

       102
       102
       +
       

     

       103
       103
       +
       ### Examples

     

       104
       104
       +
       

     

       105
       105
       +
       ```nix

     

       106
       106
       +
       # 8G image containing Firefox in addition to the default packages.

     

       107
       107
       +
       diskImageFuns.ubuntu2004x86_64 { extraPackages = [ "firefox" ]; size = 8192; }

     

       108
       108
       +
       ```

     

       109
       109
       +
       

     

       110
       110
       +
       ## `vmTools.diskImageExtraFuns` {#vm-tools-diskImageExtraFuns}

     

       111
       111
       +
       

     

       112
       112
       +
       Shorthand for `vmTools.diskImageFuns.<attr> { extraPackages = ... }`.

     

       113
       113
       +
       

     

       114
       114
       +
       ## `vmTools.diskImages` {#vm-tools-diskImages}

     

       115
       115
       +
       

     

       116
       116
       +
       Shorthand for `vmTools.diskImageFuns.<attr> { }`.

doc/manpage-urls.json

···

       3
       3
        
         "mpd(1)": "https://mpd.readthedocs.io/en/latest/mpd.1.html",

     

       4
       4
        
         "mpd.conf(5)": "https://mpd.readthedocs.io/en/latest/mpd.conf.5.html",

     

       5
       5
        
         "nix.conf(5)": "https://nixos.org/manual/nix/stable/command-ref/conf-file.html",

     

       6
       6
       +
         "mount(5)": "https://linux.die.net/man/8/mount",

     

       6
       7
        
       

     

       7
       8
        
         "journald.conf(5)": "https://www.freedesktop.org/software/systemd/man/journald.conf.html",

     

       8
       9
        
         "logind.conf(5)": "https://www.freedesktop.org/software/systemd/man/logind.conf.html",