From 21880fc3c55e9507a6eec0da946abf6dae464082 Mon Sep 17 00:00:00 2001 From: kat witch Date: Sat, 28 Aug 2021 21:30:38 +0100 Subject: [PATCH] Further README updates --- README.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2a5759be..2f5bf47e 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,25 @@ [![nodes](https://github.com/kittywitch/nixfiles/actions/workflows/nodes.yml/badge.svg)](https://github.com/kittywitch/nixfiles/actions/workflows/nodes.yml) +These are the NixOS configurations for my systems. I run nothing but NixOS on my hardware, aside from virtual machines. + +## CI + +CI for this repository uses [arcnmx/ci](https://github.com/arcnmx/ci) and aims to achieve two goals: + +| Action | Purpose | +| --- | --- | +| [nodes](ci/nodes.nix) | Build and cache host closures, show state of host evaluability/buildability | +| [niv-cron](ci/niv-cron.nix) | Automatically update the dependencies used by the repository, cache them and host closure build results with them. | + ## Dependencies | Dependency | Reasoning | | --- | --- | -| [nmattia/niv](https://github.com/nmattia/niv) | Dependency management. | +| [nmattia/niv](https://github.com/nmattia/niv) | Dependency management. Will move to flakes when stable. | | [nix-community/home-manager](https://github.com/nix-community/home-manager) | home-manager. Self-explanatory. | | [nix-community/NUR](https://github.com/nix-community/NUR) | Firefox extensions and such. | -| [arcnmx/tf-nix](https://github.com/arcnmx/tf-nix) | The deploy system used. | +| [arcnmx/tf-nix](https://github.com/arcnmx/tf-nix) | The deploy system used, also provides DNS, secrets and node provisioning. (Anything terraform can do.) | | [arcnmx/ci](https://github.com/arcnmx/ci) | The CI integration system used. | | [arcnmx/nixexprs](https://github.com/arcnmx/nixexprs) | Packages and modules I heavily make use of. | | [nix-community/impermanence](https://github.com/nix-community/impermanence) | Impermanence! Erase your darlings. | @@ -22,11 +33,16 @@ ## Commands -### Deployment +The commands here aside from the `nix build` command are provided through the shell. The `` and `` commands are runners provided through [arcnmx/tf-nix](https://github.com/arcnmx/tf-nix). -* `-apply` -* `-tf` +Please use `nix-shell` or [direnv/direnv](https://github.com/direnv/direnv). The shell is not compatible with [nix-community/nix-direnv](https://github.com/nix-community/nix-direnv). -### Host Building - -* `nix build -f . network.nodes..deploy.system` +| Command | Purpose | +| --- | --- | +| `nf-update` | Fancier `niv update`. | +| `nf-actions` | Updates CI integrations. | +| `nf-test` | Tests CI actions. | +| `-apply` | Deploys to the provided target. | +| `-tf` | Provides you a terraform shell for the provided target. | +| `-ssh` | SSH into the provided host. | +| `nix build -f . network.nodes..deploy.system` | Build a system closure for the provided host. |