commit 06aa64684c6746eb54aea86f981d82b60f544657 · pyrox.dev/nixpkgs

+94

nixos/doc/manual/from_md/installation/installing-kexec.section.xml

···

       1
       1
       +
       <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec-booting-via-kexec">

     

       2
       2
       +
         <title><quote>Booting</quote> into NixOS via kexec</title>

     

       3
       3
       +
         <para>

     

       4
       4
       +
           In some cases, your system might already be booted into/preinstalled

     

       5
       5
       +
           with another Linux distribution, and booting NixOS by attaching an

     

       6
       6
       +
           installation image is quite a manual process.

     

       7
       7
       +
         </para>

     

       8
       8
       +
         <para>

     

       9
       9
       +
           This is particularly useful for (cloud) providers where you can’t

     

       10
       10
       +
           boot a custom image, but get some Debian or Ubuntu installation.

     

       11
       11
       +
         </para>

     

       12
       12
       +
         <para>

     

       13
       13
       +
           In these cases, it might be easier to use <literal>kexec</literal>

     

       14
       14
       +
           to <quote>jump into NixOS</quote> from the running system, which

     

       15
       15
       +
           only assumes <literal>bash</literal> and <literal>kexec</literal> to

     

       16
       16
       +
           be installed on the machine.

     

       17
       17
       +
         </para>

     

       18
       18
       +
         <para>

     

       19
       19
       +
           Note that kexec may not work correctly on some hardware, as devices

     

       20
       20
       +
           are not fully re-initialized in the process. In practice, this

     

       21
       21
       +
           however is rarely the case.

     

       22
       22
       +
         </para>

     

       23
       23
       +
         <para>

     

       24
       24
       +
           To build the necessary files from your current version of nixpkgs,

     

       25
       25
       +
           you can run:

     

       26
       26
       +
         </para>

     

       27
       27
       +
         <programlisting>

     

       28
       28
       +
       nix-build -A kexec.x86_64-linux '&lt;nixpkgs/nixos/release.nix&gt;'

     

       29
       29
       +
       </programlisting>

     

       30
       30
       +
         <para>

     

       31
       31
       +
           This will create a <literal>result</literal> directory containing

     

       32
       32
       +
           the following:

     

       33
       33
       +
         </para>

     

       34
       34
       +
         <itemizedlist spacing="compact">

     

       35
       35
       +
           <listitem>

     

       36
       36
       +
             <para>

     

       37
       37
       +
               <literal>bzImage</literal> (the Linux kernel)

     

       38
       38
       +
             </para>

     

       39
       39
       +
           </listitem>

     

       40
       40
       +
           <listitem>

     

       41
       41
       +
             <para>

     

       42
       42
       +
               <literal>initrd</literal> (the initrd file)

     

       43
       43
       +
             </para>

     

       44
       44
       +
           </listitem>

     

       45
       45
       +
           <listitem>

     

       46
       46
       +
             <para>

     

       47
       47
       +
               <literal>kexec-boot</literal> (a shellscript invoking

     

       48
       48
       +
               <literal>kexec</literal>)

     

       49
       49
       +
             </para>

     

       50
       50
       +
           </listitem>

     

       51
       51
       +
         </itemizedlist>

     

       52
       52
       +
         <para>

     

       53
       53
       +
           These three files are meant to be copied over to the other already

     

       54
       54
       +
           running Linux Distribution.

     

       55
       55
       +
         </para>

     

       56
       56
       +
         <para>

     

       57
       57
       +
           Note it’s symlinks pointing elsewhere, so <literal>cd</literal> in,

     

       58
       58
       +
           and use <literal>scp * root@$destination</literal> to copy it over,

     

       59
       59
       +
           rather than rsync.

     

       60
       60
       +
         </para>

     

       61
       61
       +
         <para>

     

       62
       62
       +
           Once you finished copying, execute <literal>kexec-boot</literal>

     

       63
       63
       +
           <emphasis>on the destination</emphasis>, and after some seconds, the

     

       64
       64
       +
           machine should be booting into an (ephemeral) NixOS installation

     

       65
       65
       +
           medium.

     

       66
       66
       +
         </para>

     

       67
       67
       +
         <para>

     

       68
       68
       +
           In case you want to describe your own system closure to kexec into,

     

       69
       69
       +
           instead of the default installer image, you can build your own

     

       70
       70
       +
           <literal>configuration.nix</literal>:

     

       71
       71
       +
         </para>

     

       72
       72
       +
         <programlisting language="bash">

     

       73
       73
       +
       { modulesPath, ... }: {

     

       74
       74
       +
         imports = [

     

       75
       75
       +
           (modulesPath + &quot;/installer/netboot/netboot-minimal.nix&quot;)

     

       76
       76
       +
         ];

     

       77
       77
       +
       

     

       78
       78
       +
         services.openssh.enable = true;

     

       79
       79
       +
         users.users.root.openssh.authorizedKeys.keys = [

     

       80
       80
       +
           &quot;my-ssh-pubkey&quot;

     

       81
       81
       +
         ];

     

       82
       82
       +
       }

     

       83
       83
       +
       </programlisting>

     

       84
       84
       +
         <programlisting>

     

       85
       85
       +
       nix-build '&lt;nixpkgs/nixos&gt;' \

     

       86
       86
       +
         --arg configuration ./configuration.nix

     

       87
       87
       +
         --attr config.system.build.kexecTree

     

       88
       88
       +
       </programlisting>

     

       89
       89
       +
         <para>

     

       90
       90
       +
           Make sure your <literal>configuration.nix</literal> does still

     

       91
       91
       +
           import <literal>netboot-minimal.nix</literal> (or

     

       92
       92
       +
           <literal>netboot-base.nix</literal>).

     

       93
       93
       +
         </para>

     

       94
       94
       +
       </section>

nixos/doc/manual/from_md/installation/installing.chapter.xml

···

       638
       638
        
           <title>Additional installation notes</title>

     

       639
       639
        
           <xi:include href="installing-usb.section.xml" />

     

       640
       640
        
           <xi:include href="installing-pxe.section.xml" />

     

       641
       641
       +
           <xi:include href="installing-kexec.section.xml" />

     

       641
       642
        
           <xi:include href="installing-virtualbox-guest.section.xml" />

     

       642
       643
        
           <xi:include href="installing-from-other-distro.section.xml" />

     

       643
       644
        
           <xi:include href="installing-behind-a-proxy.section.xml" />

+64

nixos/doc/manual/installation/installing-kexec.section.md

···

       1
       1
       +
       # "Booting" into NixOS via kexec {#sec-booting-via-kexec}

     

       2
       2
       +
       

     

       3
       3
       +
       In some cases, your system might already be booted into/preinstalled with

     

       4
       4
       +
       another Linux distribution, and booting NixOS by attaching an installation

     

       5
       5
       +
       image is quite a manual process.

     

       6
       6
       +
       

     

       7
       7
       +
       This is particularly useful for (cloud) providers where you can't boot a custom

     

       8
       8
       +
       image, but get some Debian or Ubuntu installation.

     

       9
       9
       +
       

     

       10
       10
       +
       In these cases, it might be easier to use `kexec` to "jump into NixOS" from the

     

       11
       11
       +
       running system, which only assumes `bash` and `kexec` to be installed on the

     

       12
       12
       +
       machine.

     

       13
       13
       +
       

     

       14
       14
       +
       Note that kexec may not work correctly on some hardware, as devices are not

     

       15
       15
       +
       fully re-initialized in the process. In practice, this however is rarely the

     

       16
       16
       +
       case.

     

       17
       17
       +
       

     

       18
       18
       +
       To build the necessary files from your current version of nixpkgs,

     

       19
       19
       +
       you can run:

     

       20
       20
       +
       

     

       21
       21
       +
       ```ShellSession

     

       22
       22
       +
       nix-build -A kexec.x86_64-linux '<nixpkgs/nixos/release.nix>'

     

       23
       23
       +
       ```

     

       24
       24
       +
       

     

       25
       25
       +
       This will create a `result` directory containing the following:

     

       26
       26
       +
        - `bzImage` (the Linux kernel)

     

       27
       27
       +
        - `initrd` (the initrd file)

     

       28
       28
       +
        - `kexec-boot` (a shellscript invoking `kexec`)

     

       29
       29
       +
       

     

       30
       30
       +
       These three files are meant to be copied over to the other already running

     

       31
       31
       +
       Linux Distribution.

     

       32
       32
       +
       

     

       33
       33
       +
       Note it's symlinks pointing elsewhere, so `cd` in, and use

     

       34
       34
       +
       `scp * root@$destination` to copy it over, rather than rsync.

     

       35
       35
       +
       

     

       36
       36
       +
       Once you finished copying, execute `kexec-boot` *on the destination*, and after

     

       37
       37
       +
       some seconds, the machine should be booting into an (ephemeral) NixOS

     

       38
       38
       +
       installation medium.

     

       39
       39
       +
       

     

       40
       40
       +
       In case you want to describe your own system closure to kexec into, instead of

     

       41
       41
       +
       the default installer image, you can build your own `configuration.nix`:

     

       42
       42
       +
       

     

       43
       43
       +
       ```nix

     

       44
       44
       +
       { modulesPath, ... }: {

     

       45
       45
       +
         imports = [

     

       46
       46
       +
           (modulesPath + "/installer/netboot/netboot-minimal.nix")

     

       47
       47
       +
         ];

     

       48
       48
       +
       

     

       49
       49
       +
         services.openssh.enable = true;

     

       50
       50
       +
         users.users.root.openssh.authorizedKeys.keys = [

     

       51
       51
       +
           "my-ssh-pubkey"

     

       52
       52
       +
         ];

     

       53
       53
       +
       }

     

       54
       54
       +
       ```

     

       55
       55
       +
       

     

       56
       56
       +
       

     

       57
       57
       +
       ```ShellSession

     

       58
       58
       +
       nix-build '<nixpkgs/nixos>' \

     

       59
       59
       +
         --arg configuration ./configuration.nix

     

       60
       60
       +
         --attr config.system.build.kexecTree

     

       61
       61
       +
       ```

     

       62
       62
       +
       

     

       63
       63
       +
       Make sure your `configuration.nix` does still import `netboot-minimal.nix` (or

     

       64
       64
       +
       `netboot-base.nix`).

nixos/doc/manual/installation/installing.chapter.md

···

       476
       476
        
       ```{=docbook}

     

       477
       477
        
       <xi:include href="installing-usb.section.xml" />

     

       478
       478
        
       <xi:include href="installing-pxe.section.xml" />

     

       479
       479
       +
       <xi:include href="installing-kexec.section.xml" />

     

       479
       480
        
       <xi:include href="installing-virtualbox-guest.section.xml" />

     

       480
       481
        
       <xi:include href="installing-from-other-distro.section.xml" />

     

       481
       482
        
       <xi:include href="installing-behind-a-proxy.section.xml" />