From 387c55582b4ef7eea31b73984bf0766ad7b284b7 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Thu, 16 Sep 2021 21:47:25 +0300 Subject: refactor(ops/restic): Move restic configuration into a new module Relates to b/147. First step towards giving depot modules the ability to declare their own backup directories by moving all restic configuration into a new module and adding a NixOS option for inclusion/exclusion paths for backups. This still keeps all backup paths within the whitby config. Change-Id: Ia96833668f1a3d02da892261153d8b02156b8ac0 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3565 Tested-by: BuildkiteCI Reviewed-by: flokli --- ops/modules/restic.nix | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 ops/modules/restic.nix (limited to 'ops/modules/restic.nix') diff --git a/ops/modules/restic.nix b/ops/modules/restic.nix new file mode 100644 index 000000000000..f107609586ed --- /dev/null +++ b/ops/modules/restic.nix @@ -0,0 +1,57 @@ +# Configure restic backups to Google Cloud Storage. +# +# Conventions: Restic state is kept in /var/backup/restic, with +# secrets in /var/backup/restic/secret. +{ config, lib, pkgs, ... }: + +let + cfg = config.services.depot.restic; + description = "Restic backups to GCS"; + mkStringOption = default: lib.mkOption { + inherit default; + type = lib.types.string; + }; +in { + options.services.depot.restic = { + enable = lib.mkEnableOption description; + project = mkStringOption "tazjins-infrastructure"; + credentialPath = mkStringOption "/var/backup/restic/gcp-key.json"; + repository = mkStringOption "gs:tvl-fyi-backups:/whitby"; + interval = mkStringOption "hourly"; + + paths = with lib; mkOption { + description = "Directories that should be backed up"; + type = types.listOf types.string; + }; + + exclude = with lib; mkOption { + description = "Files that should be excluded from backups"; + type = types.listOf types.string; + }; + }; + + config = lib.mkIf cfg.enable { + # Regularly back up whitby to Google Cloud Storage. + systemd.services.restic = { + description = "Backups to Google Cloud Storage"; + + script = "${pkgs.restic}/bin/restic backup ${lib.concatStringsSep " " cfg.paths}"; + + environment = { + GOOGLE_PROJECT_ID = cfg.project; + GOOGLE_APPLICATION_CREDENTIALS = cfg.credentialPath; + RESTIC_REPOSITORY = cfg.repository; + RESTIC_PASSWORD_FILE = "/var/backup/restic/secret"; + RESTIC_CACHE_DIR = "/var/backup/restic/cache"; + + RESTIC_EXCLUDE_FILE = + builtins.toFile "exclude-files" (lib.concatStringsSep "\n" cfg.exclude); + }; + }; + + systemd.timers.restic = { + wantedBy = [ "multi-user.target" ]; + timerConfig.OnCalendar = cfg.interval; + }; + }; +} -- cgit 1.4.1