mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(ops/terraform/deploy-nixos): document variables in README

Browse source 
Give some more context about what these mean. Mostly copied from the
descriptions in nix-eval.sh

Change-Id: I845f4227206f7035bcd185a708c14877a040c46a
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11778
Tested-by: BuildkiteCI
Reviewed-by: Ilan Joselevich <personal@ilanjoselevich.com>
Autosubmit: flokli <flokli@flokli.de>
Reviewed-by: flokli <flokli@flokli.de>
This commit is contained in:
Florian Klink 2024-06-10 14:41:39 +03:00 committed by flokli
parent d3bc358bbc
commit 33e15aa950
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
ops/terraform/deploy-nixos/README.md
View file

@ -25,8 +25,17 @@ deploy is necessary.
```terraform ```terraform
module "deploy_somehost" { module "deploy_somehost" {
# Clone just this directory through josh. Add a `ref=` parameter to pin to a specific commit.
source = "git::https://code.tvl.fyi/depot.git:/ops/terraform/deploy-nixos.git" source = "git::https://code.tvl.fyi/depot.git:/ops/terraform/deploy-nixos.git"
# The attribute.path pointing to the expression to instantiate.
attrpath = "ops.nixos.somehost" attrpath = "ops.nixos.somehost"
# The path to the Nix file to invoke. Optional.
# If omitted, will shell out to git to determine the repo root, and Nix will
# use `default.nix` in there.
entrypoint = "${path.module}/../../somewhere.nix"
target_host = "somehost.tvl.su" target_host = "somehost.tvl.su"
target_user = "someone" target_user = "someone"
target_user_ssh_key = tls_private_key.somehost.private_key_pem target_user_ssh_key = tls_private_key.somehost.private_key_pem
@ -37,9 +46,6 @@ module "deploy_somehost" {
Several things can be improved about this module, for example: 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 * The remote system closure could be discovered to restore remote system state
after manual deploys on the target (i.e. "stomping" of changes). after manual deploys on the target (i.e. "stomping" of changes).