X-Git-Url: https://iankelling.org/git/?a=blobdiff_plain;f=README;h=72669bb4658496a349cd4a30f66dcf280e2cd3d8;hb=efcfb463ceda4de1d9953da31a2c0737471e5cf8;hp=ba0a7bdd483c7638e4ef2539015486f41ee9a0a2;hpb=f74458d51ebaeba827307920c7a66ed2d69d6fbd;p=automated-distro-installer diff --git a/README b/README index ba0a7bd..72669bb 100644 --- a/README +++ b/README @@ -1,28 +1,38 @@ -Multi-boot/distro btrfs provisioning - -Some things are specific to my home network. Uses PXE, designed for bare -metal but also works for pxe booted VM. - -Features people may find useful: installs encrypted arch, debian stable, -& debian testing all on the same btrfs filesystem, smartly utilizing -multiple disks, with scripts to automatically decrypt on reboots. The -partititioning and filesystem script is the biggest part and is at -fai/config/hooks/partition.DEFAULT. Other debian based distros 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. - -The repo name fai is copied from a project of the same name which this -project uses for debian installs. It stands for "fully automated -installer." - -It also fully automates configuration of an openwrt router after manual +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 +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 belenos, , +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. + +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. + +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. It supports running a fai +server on debian within android via Maru. + +It also automates configuration of an openwrt router after manual initial installation. -Provisionining is done, I sync files using unison, then automate further -setup using a different set of scripts, +After provisionining is done, I sync files using btrfs, or unison for +vps, then automate further setup using a different set of scripts, https://iankelling.org/git/?p=distro-setup;a=tree. My network is a wndr3700v2 router with openwrt on it and a few pcs/laptops. @@ -35,20 +45,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: + + +# 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" +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 with pxe-kexec +pxe-server # disable/enable pxe dhcp, tfp, and nfs +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 -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) -dsfull # install & setup a new fai distro (if data partition already synced) -fai-revm # test fai on a fresh vm -faiserver-revm # create a vm which is a fai server -faiserver-uninstall +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 -pxe-server # temporarily enable (usually) fai or arch boot server -wrt-setup-remote # setup my router + 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 rebase off their 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.