From b27f8c138006a73dc9e66a9c344c24d32ddf8d46 Mon Sep 17 00:00:00 2001 From: teutat3s Date: Fri, 5 Apr 2024 23:02:15 +0200 Subject: [PATCH] docs: include notes regarding rollback in deploy docs, misc updates --- docs/deploying.md | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/docs/deploying.md b/docs/deploying.md index 43e748f..4c9f7ff 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -1,20 +1,32 @@ # Deploying new versions -We use [deploy-rs](https://github.com/serokell/deploy-rs) to deploy changes. Currently this process is not automated, so configuration changes will have to be manually deployed. +We use [deploy-rs](https://github.com/serokell/deploy-rs) to deploy changes. +Currently this process is not automated, so configuration changes will have to +be manually deployed. -To deploy, make sure you have a [working development shell](./development-shell.md). Then, run `deploy-rs` with the hostname of the server you want to deploy: +To deploy, make sure you have a [working development shell](./development-shell.md). +Then, run `deploy-rs` with the hostname of the server you want to deploy: For nachtigall.pub.solar: ``` -deploy '.#nachtigall' +deploy --targets '.#nachtigall' --magic-rollback false --auto-rollback false ``` For flora-6.pub.solar: ``` -deploy '.#flora-6' +deploy --targets '.#flora-6' --magic-rollback false --auto-rollback false ``` -You'll need to have SSH Access to the boxes to be able to do this. +Usually we skip all rollback functionality, but if you want to deploy a change +that might lock you out, e.g. to SSH, it might make sense to set these to `true`. -### SSH access -Ensure your SSH public key is in place [here](./public-keys/admins.nix) and was deployed by someone with access. +To skip flake checks, e.g. because you already ran them manually before +deployment, add the flag `--skip-checks` at the end of the command. + +`--dry-activate` can be used to only put all files in place without switching, +to enable switching to the new config quickly at a later moment. + +You'll need to have SSH Access to the boxes to be able to run `deploy`. + +### Getting SSH access +See [administrative-access.md](./administrative-access.md).