diff --git a/terraform/README.md b/terraform/README.md index 3c080d3..cdc8c30 100644 --- a/terraform/README.md +++ b/terraform/README.md @@ -1,6 +1,16 @@ -# List of terraform modules +# nixos-anywhere terraform modules -- [all-in-one](all-in-one.md) -- [install](install.md) -- [nix-build](nix-build.md) -- [nixos-rebuild](nixos-rebuild.md) +These terraform module can run nixos-anywhere from terraform to install nixos as +well as deploying nixos afterwards. + +See what each module does with examples by clicking on the terraform module in +the following links below: + +- [all-in-one](all-in-one.md): Combines the install and nixos-rebuild module in + one interface to install NixOS with nixos-anywhere and than keep it up-to-date + with nixos-rebuild. +- [install](install.md): Install NixOS with nixos-anywhere +- [nixos-rebuild](nixos-rebuild.md): Update NixOS machine with nixos-rebuild on + a remote machine +- [nix-build](nix-build.md): Small helper module to run do build a flake + attribute or attribute from a nix file. diff --git a/terraform/all-in-one.md b/terraform/all-in-one.md index 63cc7fa..9fe38d0 100644 --- a/terraform/all-in-one.md +++ b/terraform/all-in-one.md @@ -1,5 +1,8 @@ # All-in-one +Combines the install and nixos-rebuild module in one interface to install NixOS +with nixos-anywhere and than keep it up-to-date with nixos-rebuild. + ## Example ```hcl diff --git a/terraform/install.md b/terraform/install.md index e054af8..4681b53 100644 --- a/terraform/install.md +++ b/terraform/install.md @@ -1,5 +1,7 @@ # Install +Install NixOS with nixos-anywhere + ## Example ```hcl diff --git a/terraform/nix-build.md b/terraform/nix-build.md index c862dca..932b8fd 100644 --- a/terraform/nix-build.md +++ b/terraform/nix-build.md @@ -1,5 +1,8 @@ # Nix-build +Small helper module to run do build a flake attribute or attribute from a nix +file. + ## Example - See [install](install.md) or [nixos-rebuild](nixos-rebuild.md) diff --git a/terraform/nixos-rebuild.md b/terraform/nixos-rebuild.md index bd4f26c..3ace6dd 100644 --- a/terraform/nixos-rebuild.md +++ b/terraform/nixos-rebuild.md @@ -1,5 +1,7 @@ # Nixos-rebuild +Update NixOS machine with nixos-rebuild on a remote machine + ## Example ```hcl