History

Florian Klink f7439d2526 fix(ops/terraform): s/TARGET_ADDRESS/TARGET_HOST We missed renaming this as well while iterating over https://cl.tvl.fyi/c/depot/+/7950. Change-Id: I704d3b60bb3beb1a2148e27bdd4a49075a6649b3 Reviewed-on: https://cl.tvl.fyi/c/depot/+/8230 Autosubmit: flokli <flokli@flokli.de> Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI		2023-03-08 16:59:19 +00:00
..
main.tf	feat(ops/terraform): add trigger to deploy-nixos, remove target_name	2023-03-03 14:53:43 +00:00
nixos-copy.sh	fix(ops/terraform): s/TARGET_ADDRESS/TARGET_HOST	2023-03-08 16:59:19 +00:00
nixos-eval.sh	feat(ops/terraform): allow specifying an entrypoint for the attrset	2023-03-03 14:53:43 +00:00
README.md	feat(ops/terraform): add trigger to deploy-nixos, remove target_name	2023-03-03 14:53:43 +00:00

README.md

deploy-nixos

This is a Terraform module to deploy a NixOS system closure to a remote machine.

The system closure must be accessible by Nix-importing the repository root and building a specific attribute (e.g. nix-build -A ops.machines.machine-name).

The target machine must be accessible normally over SSH, and an SSH key must be used for access.

Notably this module separates the evaluation of the system closure from building and deploying it, and uses the closure's derivation hash to determine whether a deploy is necessary.

Usage example:

module "deploy_somehost" {
  source              = "git::https://code.tvl.fyi/depot.git:/ops/terraform/deploy-nixos.git"
  attrpath            = "ops.nixos.somehost"
  target_host         = "somehost.tvl.su"
  target_user         = "someone"
  target_user_ssh_key = tls_private_key.somehost.private_key_pem
}

Future work

Several things can be improved about this module, for example:

The repository root (relative to which the attribute path is evaluated) could be made configurable.
The remote system closure could be discovered to restore remote system state after manual deploys on the target (i.e. "stomping" of changes).

More ideas and contributions are, of course, welcome.

Acknowledgements

Development of this module was sponsored by Resoptima.