Go to file
Sandro - 7c5ec5927a
Ignore formatting in blames
2022-06-12 17:27:07 +02:00
config The big format and cleanup 2022-06-12 17:26:32 +02:00
doc README: update list-upgradable documentation 2021-09-08 01:45:28 +02:00
hosts The big format and cleanup 2022-06-12 17:26:32 +02:00
modules The big format and cleanup 2022-06-12 17:26:32 +02:00
overlay The big format and cleanup 2022-06-12 17:26:32 +02:00
proxmox The big format and cleanup 2022-06-12 17:26:32 +02:00
.git-blame-ignore-revs Ignore formatting in blames 2022-06-12 17:27:07 +02:00
.gitignore Add "result" to .gitignore 2019-11-29 14:21:52 +01:00
README.md modules/autoupdate: add update-from-hydra script 2022-01-25 23:32:02 +01:00
deploy-flake.sh deploy-flake: always use target hostname for safety 2022-01-07 00:15:54 +01:00
flake.lock flake.lock: Update 2022-06-10 10:00:36 +02:00
flake.nix riscbert: init 2022-06-08 22:55:35 +02:00
host-registry.nix riscbert: init 2022-06-08 22:55:35 +02:00
install-host.sh pulsebert: add home-manager home.nix 2019-02-19 23:30:27 +01:00
nix-maintenance.sh The big format and cleanup 2022-06-12 17:26:32 +02:00
users.nix The big format and cleanup 2022-06-12 17:26:32 +02:00

README.md

Setup

Add this repo to your local Nix registry

As an alternative to a local checkout, always pull the latest code from this repo.

nix registry add c3d2 git+https://gitea.c3d2.de/C3D2/nix-config

This enables nix commands to find this Flake given the c3d2# prefix in some arguments.

Working with this repo

If you checked out this git repository for working on the code, replace c3d2# with .# and run commands from the repository root.

Don't forget to git add new files! Flakes require that.

The secrets repo

Make sure you have access.

Install Nix Flakes

Nix Flakes ist gegenwärtig bei Nix (Version 20.09) noch keine standardmäßige Funktionalität für Nix. Die Bereitstellung der Kommandos für Nix Flakes müssen als experimentelle Funktionalität für das Kommando ''nix'' festgelegt werden, um sie verfügbar zu machen.

A Nix environment with Nix Flakes support is required.

Temporary Shell with Nix Flakes

Set up an environment (with the common command nix-shell) in which the package nixFlakes (for Nix Flakes) is available and jump into it

nix-shell -p nixFlakes

Set some configuration (do this only once):

echo 'experimental-features = nix-command flakes' >> ~/.config/nix/nix.conf

Permanent System with Nix Flakes

set this to your NixOS configuration:

{ pkgs, ... }: {
  nix = {
    package = pkgs.nixFlakes;
    extraOptions = "experimental-features = nix-command flakes";
  };
}

Deployment

Deploy a NixOS system from this Flake locally

Running nixos-rebuild --flake c3d2 switch on a machine should be sufficient to update that machine to the current configuration and Nixpkgs revision.

Deploy to a remote NixOS system with this Flake

For every host that has a nixosConfiguration in our Flake, there are two scripts that can be run for deployment via ssh.

  • nix run c3d2#glotzbert-nixos-rebuild switch

    Copies the current state to build on the target system. This may fail due to eg. container resource limits.

    The target must already be a nixFlakes system.

  • nix run c3d2#glotzbert-nixos-rebuild-local switch

    Builds locally, then uses nix copy to transfer the new NixOS system to the target.

    Help! It's needlessly rebuilding stuff that already runs on the target? If so, use nix copy to transfer where /run/current-system points to to your build machine.

Use nix flake show c3d2 to show what is available.

Remote deployment from non-NixOS

A shell script that copies the current working tree, and runs nixos-rebuild switch on the target:

./deploy-flake.sh hydra.hq.c3d2.de

It cannot not lookup hostnames in host-registry.nix. To avoid deploying the wrong container on the unrelated DNS records, the script always uses the hostname that is already configured on the target system.

Checking for updates

nix run .#list-upgradable

list-upgradable output

Checks all hosts with a nixosConfiguration in flake.nix.

Update from Hydra build

The fastest way to update a system, a manual alternative to setting c3d2.autoUpdate = true;

Just run:

update-from-hydra

Creating a new Proxmox container

Use the nixprox.sh script that should be copied to /usr/local/sbin/nixprox.sh on all of the Proxmox servers.

Secrets management

Secrets managment with PGP

Add your gpg-id to the .gpg-id file in secrets and let somebody reencrypt it for you. Maybe this works for you, maybe not. I did it somehow:

PASSWORD_STORE_DIR=`pwd` tr '\n' ' ' < .gpg-id | xargs -I{} pass init {}

Your gpg key has to have the Authenticate flag set. If not update it and push it to a keyserver and wait. This is necessary, so you can login to any machine with your gpg key.

Secrets Management Using sops-nix

Adding a new host

Edit secrets/.sops.yaml:

  1. Add an AGE key for this host. Comments in this file tell you how to do it.
  2. Add a creation_rules section for host/$host/*yaml files

Editing a hosts secrets

Edit secrets/.sops.yaml to add files for a new host and its SSH pubkey.

# Enter the secrets flake
cd secrets
# Get sops
nix develop
# Decrypt, start en EDITOR, encrypt
sops hosts/.../secrets.yaml
# Push
git commit -a -m YOLO
git push origin HEAD:master
# Go back to this flake
cd ..
# Update flake.lock file
nix flake lock . --update-input secrets

Laptops / Desktops

This repository contains a NixOS module that can be used with personal machines as well. This module appends /etc/ssh/ssh_known_hosts with the host keys of registered HQ hosts, and optionally appends /etc/hosts with static IPv6 addresses local to HQ. Simply import the lib directory to use the module. As an example:

# /etc/nixos/configuration.nix
{ config, pkgs, lib, ... }:
let
  c3d2Config =
    builtins.fetchGit { url = "https://gitea.c3d2.de/C3D2/nix-config.git"; };
in {
  imports = [
    # ...
    "${c3d2Config}/modules/c3d2.nix"
  ];

  c3d2 = {
    isInHq = false; # not in HQ, this is the default.
    mergeHostsFile = true; # Make entries in /etc/hosts form hosts.nix
    enableMotd = true; # Set the login shell message to the <<</>> logo.
  };

  # ...
}