hwe kernel to fix btrfs-send bug
[automated-distro-installer] / README
1 PXE install w multi-boot, btrfs & Libreboot support
2
3 Some things are specific to my home network, and uses files with secrets
4 that are not in this repo. I use this for bare metal and vms, and two
5 scripts which can run post boot so I use them on vps distributed image
6 as well.
7
8 Features people may find useful: installs encrypted trisquel, debian,
9 ubuntu, arch, and parabola (archlike install is likely broken, I've only
10 done pxe boots recently), in a multi-boot setup using multiple
11 subvolumes of a single btrfs filesystem. Utilizes multiple disks, with
12 scripts to automatically decrypt on intentional reboots, but not after
13 shutdown or power loss.
14
15 Normal install mode for fai is using pxe, but on a libreboot system,
16 there is no pxe. The pxe in a normal computer is nonfree
17 firmware. Alternatives to normal pxe that I've tried:
18
19 * libreboot + seabios + ipxe
20
21 * Use a live cd to call pxe-kexec, this is described later in this file.
22
23 * Use the fai autodiscover iso. This is more automated, so nicer.
24
25 * Use an install method above to setup a gnu/linux disk partition that
26 coordinates with libreboot grub to acts like a pxe boot using
27 kexec. The boot process takes a bit longer than normal pxe. This is
28 the bootstrap partition in my scripts.
29
30 Things I haven't tried:
31
32 * The bios chip has enough room for an initrd. This could be setup to
33 work like the partition I use to kexec, but it would be faster, and
34 not require installing to disk.
35
36 The partititioning and filesystem script is at
37 fai/config/hooks/partition.DEFAULT. Disks are grouped as ssd or hdd and
38 raided in raid 1 or raid 0 per configuration. The base partitions are
39 divided into boot, swap, and root, (only boot is unencrypted). There are
40 scripts to resize those partitions post-provision and while the system
41 is running.
42
43 People who use fai may find these things as useful examples: it uses
44 dnsmasq (on a openwrt machine) for dhcp instead of the isc
45 dhcp. fai-wrapper is a small script to use basic fai classes outside of
46 fai. It does not use the fai partitioning tool, but the script is
47 inspired from it and works outside of fai. It supports running a fai
48 server on debian within android via Maru.
49
50 It also automates configuration of an openwrt router after manual
51 initial installation.
52
53 After provisionining is done, I sync files using btrfs, or unison for
54 vps, then automate further setup using a different set of scripts,
55 https://iankelling.org/git/?p=distro-setup;a=tree.
56
57 My network is a wndr3700v2 router with openwrt on it and a few pcs/laptops.
58
59 Since fai requires a debian server as the fai server, there are also
60 scripts to automate a debian install using pxe and preseeding, which can
61 be done from any distro.
62
63 Some of the scripts have dependencies for some simple obvious utility
64 scripts from https://iankelling.org/git, and of course there are some
65 hostnames that are specific to my network.
66
67 Before doing a fai install, you will need to populate a class file. I
68 use one called 5-multi-boot, which you can see example of in
69 fai/config/class/50-host-classes.
70
71
72
73 All scripts meant to be used directly are listed here:
74
75
76 # Scripts to setup the environment for the install
77
78 sudo fai-cd -g grub.cfg.autodiscover -f -A $BASEFILE_DIR/autodiscover.iso # create autodiscover cd
79 mymk-basefile # Create basefiles for various distros
80 archlike-pxe # Setup pxe boot server from an archlike base image
81 fai-redep # Deploy fai configuration to host "faiserver"
82 faiserver-uninstall # uninstall fai-server
83 faiserver-setup # install fai-server on the current machine
84 myfai-chboot # setup fai tftp and nfs. useful for doing pxe-kexec
85 pxe-server # disable/enable pxe dhcp, tfp, and nfs. calls myfai-chboot
86 wrt-setup # setup my router in general: dhcp, dns, etc.
87
88
89 # Script to do a distro install
90
91 faiserver-revm # using pxe & preseed, create a vm which is a fai server
92 dsfull # install & post-install a new fai distro
93 arch-init-remote # install arch after it's been booted into it's setup env
94 fai-kexec # Kexec this or a remote machine using host faiserver
95 live-kexec # fai kexec from upstream live cds, e.g. curl live-kexec|bash
96
97
98 # Test scripts
99
100 arch-revm # test arch install on a fresh vm
101 fai-revm # test fai install on a fresh vm
102
103
104 # Scripts to call after a distro install for various reasons
105
106 chboot # Set grub to boot into a different distro (installed earlier)
107 install-chboot # reinstall chboot to /boot subvols, for chboot updates.
108 eboot # reboot without automatic disk decryption
109 fai-wrapper # use fai classes outside of fai. sourced, not called.
110 faiserver-disable # Disable the fai nfs server exports
111 fresize # resize swap or boot partitions in a host
112
113
114 # Replacing a raid 10 disk
115
116 pxe-server -S HOST fai
117 ssh root@HOST
118 cat >p
119 for x in /target/*; do umount $x; done
120 PASSWORD HERE(ctrl-d ctrl-d)
121 for d in /dev/disk/by-id/ata*part1; do cryptsetup luksOpen --key-file p $d crypt_dev_${d##*/}; done
122 # btrfs replace disk # i forget the actual command
123 x=(/dev/mapper/*part1); mount -o subvol=root_trisquelflidas $x /mnt
124 mount -o subvol=boot_trisquelflidas /dev/sda3 /mnt/boot
125 for x in dev proc sys; do mount -o bind /$x /mnt/$x; done
126 chroot /mnt /bin/bash
127 # replace disk in fstab
128 # replace disk in /etc/crypttab
129 update-grub
130 update-initramfs -u
131 mount /a
132 /a/exe/keyscript-on
133 exit
134 reboot
135
136
137 # Expected output in fai logs
138
139 For flidas, when installing systemd, this error happens, and it's
140 a superflous upstream bug based on reading the post install script:
141
142 addgroup: The group `systemd-journal' already exists as a system group. Exiting.
143 Operation failed: No such file or directory
144
145
146 # TODO
147 Change arch to archlike and to support arch and parabola
148
149
150 # License
151
152 The license for the project is GPLv2 or later, mostly because fai is and
153 I periodically merge the upstream example config, which contains small
154 scripts. Also, there is a modified encrypt.upstream, which is from the
155 cryptsetup package in arch, which is under the same license.