From c23d2906476e67024e08293dba8d2f6fdf8e2c7d Mon Sep 17 00:00:00 2001 From: Raito Bezarius Date: Sat, 5 Oct 2024 16:36:21 +0200 Subject: [PATCH] docs(README.md): explain how to deploy things Signed-off-by: Raito Bezarius --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fb3dfd..48415ce 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -Infrastructure for the donut shaped thing that is absolutely not a donut. +# Infrastructure for the donut shaped thing that is absolutely not a donut. + +## Quick start + +### Build the infrastructure + +``` +$ colmena build --on @localboot +``` + +Notice that `@localboot` is load-bearing as we have some machines that _cannot be_ deployed with vanilla Colmena. Fixing this is welcome. + +### Recommended deploy process + +``` +$ colmena apply dry-activate $machine # Verify that the nvd log is reasonable. +$ colmena apply $machine +``` + +### Recommended upgrade process + +``` +$ nix flake update +$ colmena apply dry-activate --on @localboot # Verify that the nvd log is reasonable. Run it twice to get only NVD logs shown. +$ colmena apply --on @localboot +``` + +## Troubleshooting + +### I failed to deploy `gerrit01` + +Our Gerrit source build is known to have some hiccups sometimes, we are always interested in build logs, feel free to attach information in a new issue so we can make it more reliable.