feat: provisioning script

hack/scripts/README.md

@@ -0,0 +1,91 @@
+# Flintlock scripts
+
+This directory contains a number of useful scripts for both developing and running
+flintlock.
+
+## provision.sh
+
+The `provision.sh` script can be used to bootstrap a production or development
+ready host. The script includes commands to perform isolated setup steps.
+
+Installation:
+
+```sh
+# if you have cloned the repository
+./hack/scripts/provision.sh --help
+
+# if you have not
+wget https://raw.githubusercontent.com/Callisto13/flintlock/provision/hack/scripts/provision.sh
+chmod +x provision.sh
+./provision.sh --help
+```
+
+Available commands:
+```sh
+usage: ./provision.sh <COMMAND> <OPTIONS>
+
+Script to provision hosts for running flintlock microvms
+
+COMMANDS:
+
+  all                    Complete setup for production ready host. Component versions
+                         can be configured by setting the FLINTLOCK, CONTAINERD and FIRECRACKER
+                         environment variables.
+    OPTIONS:
+      -y                 Autoapprove all prompts (danger)
+      --skip-apt, -s     Skip installation of apt packages
+      --thinpool, -t     Name of thinpool to create (default: flintlock or flintlock-dev)
+      --disk, -d         Name blank unpartioned disk to use for direct lvm thinpool (ignored if --dev set)
+      --dev              Set up development environment. Loop thinpools will be created.
+
+  apt                    Install all apt packages required by flintlock
+
+  firecracker            Install firecracker from feature branch
+    OPTIONS:
+      --version, -v      Version to install (default: latest)
+
+  containerd             Install, configure and start containerd service
+    OPTIONS:
+      --version, -v      Version to install (default: latest)
+      --thinpool, -t     Name of thinpool to include in config toml (default: flintlock-thinpool)
+      --dev              Set up development environment. Containerd will keep state under 'dev' tagged paths.
+
+  flintlock              Install and start flintlockd service
+    OPTIONS:
+      --version, -v      Version to install (default: latest)
+      --dev              Assumes containerd has been provisioned in a dev environment
+
+  direct_lvm             Set up direct_lvm thinpool
+    OPTIONS:
+      -y                 Autoapprove all prompts (danger)
+      --thinpool, -t     Name of thinpool to create (default: flintlock)
+      --disk, -d         Name blank unpartioned disk to use for direct lvm thinpool
+      --skip-apt, -s     Skip installation of apt packages
+
+  devpool                Set up loop device thinpool (development environments)
+    OPTIONS:
+      --thinpool, -t     Name of thinpool to create (default: flintlock-dev)
+```
+
+### all
+
+The `all` subcommand will perform all the other subcommands and fully provision the
+host. The default environment for this tool is production. The tool will format a block
+device to act as a thinpool for containerd's devmapper snapshotter.
+
+> Note: It is HIGHLY RECOMMENDED that users supply the name of a block device
+they know for a fact to be unused via the `--disk` flag. The tool will make a
+very naive attempt to find a disk which is not in use, but it should not be relied
+upon in a production setting as all the data will be wiped from the selected device.
+
+If you don't want or need to use production-ready thinpools (ie for development
+environments), pass the `--dev` flag. This will provision a loop-backed thinpool,
+therefore no physical device is required.
+
+### Other commands
+
+Each step in the `all` provision command can be executed and configured
+independently.
+
+For example, `./provision.sh firecracker` will install the latest release of
+the macvtap branch of firecracker.