X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README;h=3e6123b51c2ef09566d1c740010769115b7c0bad;hb=5f680f6bea2faae10ca8e5ccea0d08d18ccc9aa1;hp=5e09791e75d4c320ecb0a752f7090c9fa8e6a475;hpb=83828fe2683227f4d8ecb2343eff28439741b490;p=automated-distro-installer diff --git a/README b/README index 5e09791..3e6123b 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -Multi-boot/distro btrfs provisioning +PXE install w multi-boot, btrfs & Libreboot support Some things are specific to my home network, and uses files with secrets that are not in this repo. Uses pxe or pxe-kexec (on libreboot, I have @@ -6,26 +6,25 @@ not added a pxe rom, I use a minimal debian stable subvolume which acts like a pxe rom). I use this for bare metal and vms, and two scripts which can run post boot so I use them on vps distributed image as well. -Features people may find useful: installs encrypted trisquel belanos, , -debian jessie, debian stretch, ubuntu 16.04, and arch (havne't done -recently, probably a bit broken), in a multi-boot setup using multiple -subvolumes of a single btrfs filesystem. Utilizes multiple disks, with -scripts to automatically decrypt on intentional reboots, but not after -shutdown or power loss. +Features people may find useful: installs encrypted trisquel, debian, +ubuntu, and arch (havne't done recently, probably a bit broken), in a +multi-boot setup using multiple subvolumes of a single btrfs filesystem. +Utilizes multiple disks, with scripts to automatically decrypt on +intentional reboots, but not after shutdown or power loss. The partititioning and filesystem script is at -fai/config/hooks/partition.DEFAULT. Other debian based distros at least -as new as ubuntu 14.04 should work fine, and I'm planning to add Fedora -support. Disks are grouped as ssd or hdd and raided in raid 1 or raid 0 -per configuration. The base partitions are divided into boot, swap, and -root, (only boot is unencrypted). There are scripts to resize those -partitions post-provision and while the system is running. +fai/config/hooks/partition.DEFAULT. Disks are grouped as ssd or hdd and +raided in raid 1 or raid 0 per configuration. The base partitions are +divided into boot, swap, and root, (only boot is unencrypted). There are +scripts to resize those partitions post-provision and while the system +is running. People who use fai may find these things as useful examples: it uses dnsmasq (on a openwrt machine) for dhcp instead of the isc dhcp. fai-wrapper is a small script to use basic fai classes outside of fai. It does not use the fai partitioning tool, but the script is -inspired from it and works outside of fai. +inspired from it and works outside of fai. It supports running a fai +server on debian within android via Maru. It also automates configuration of an openwrt router after manual initial installation. @@ -44,29 +43,47 @@ Some of the scripts have dependencies for some simple obvious utility scripts from https://iankelling.org/git, and of course there are some hostnames that are specific to my network. -Main scripts meant to be called interactively: +All scripts meant to be used directly are listed here: -arch-init-remote # install arch (after it's been booted into it's setup env) -chboot # Set grub to boot into a different distro (installed earlier) -install-chboot # reinstall chboot to /boot subvols, for when it changes -dsfull # install & setup a new fai distro (if data partition already synced) -eboot # reboot without automatic disk decryption -fai-kexec # kexec to fai tftp server that pxe would normally point to + +# Scripts to setup the environment for the install + +arch-pxe # Setup arch pxe boot server from an arch base image fai-redep # Deploy fai configuration to host "faiserver" -fai-revm # test fai on a fresh vm -fai-wrapper # Evaluate and use fai classes outside of fai. -faiserver-revm # create a vm which is a fai server using pxe & preseed file +faiserver-revm # using pxe & preseed, create a vm which is a fai server faiserver-uninstall # uninstall fai-server faiserver-setup # install fai-server on the current machine +myfai-chboot # setup fai tftp and nfs. useful for doing pxe-kexec +pxe-server # disable/enable pxe dhcp, tfp, and nfs. calls myfai-chboot +wrt-setup-remote # setup my router in general: dhcp, dns, etc. + + +# Script to do a distro install + +dsfull # install & post-install a new fai distro +arch-init-remote # install arch after it's been booted into it's setup env +fai-kexec # Kexec this or a remote machine using host faiserver +live-kexec # fai kexec from upstream live cds, e.g. curl live-kexec|bash + + +# Test scripts + +arch-revm # test arch install on a fresh vm +fai-revm # test fai install on a fresh vm + + +# Scripts to call after a distro install for various reasons + +chboot # Set grub to boot into a different distro (installed earlier) +install-chboot # reinstall chboot to /boot subvols, for chboot updates. +eboot # reboot without automatic disk decryption +fai-wrapper # use fai classes outside of fai. sourced, not called. +faiserver-disable # Disable the fai nfs server exports fresize # resize swap or boot partitions in a host -myfai-chboot # Sets up tftp pxe config on fai server -pxe-server # temporarily enable (usually) fai or arch boot server -wrt-setup-remote # setup my router -ubuntu-xenial-live-fai-kexec # do fai install from xenial live cd using kexec -myfai-chboot # use instead of pxe-server for fai kexec based install + License stuff: -The license for the project is GPLv2 or later, mostly because fai is -and I periodically rebase off their example setup for debian. Also, -there is a modified encrypt.upstream, which is from the cryptsetup -package in arch, which is under the same license. +The license for the project is GPLv2 or later, mostly because fai is and +I periodically merge the upstream example config, which contains small +scripts. Also, there is a modified encrypt.upstream, which is from the +cryptsetup package in arch, which is under the same license.