forked from mirrors/nixpkgs
2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
120 lines
3.3 KiB
Nix
120 lines
3.3 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
let
|
|
|
|
inherit (lib) concatMapStringsSep concatStringsSep isInt isList literalExpression;
|
|
inherit (lib) mapAttrs mapAttrsToList mkDefault mkEnableOption mkIf mkOption optional types;
|
|
|
|
cfg = config.services.automysqlbackup;
|
|
pkg = pkgs.automysqlbackup;
|
|
user = "automysqlbackup";
|
|
group = "automysqlbackup";
|
|
|
|
toStr = val:
|
|
if isList val then "( ${concatMapStringsSep " " (val: "'${val}'") val} )"
|
|
else if isInt val then toString val
|
|
else if true == val then "'yes'"
|
|
else if false == val then "'no'"
|
|
else "'${toString val}'";
|
|
|
|
configFile = pkgs.writeText "automysqlbackup.conf" ''
|
|
#version=${pkg.version}
|
|
# DONT'T REMOVE THE PREVIOUS VERSION LINE!
|
|
#
|
|
${concatStringsSep "\n" (mapAttrsToList (name: value: "CONFIG_${name}=${toStr value}") cfg.config)}
|
|
'';
|
|
|
|
in
|
|
{
|
|
# interface
|
|
options = {
|
|
services.automysqlbackup = {
|
|
|
|
enable = mkEnableOption "AutoMySQLBackup";
|
|
|
|
calendar = mkOption {
|
|
type = types.str;
|
|
default = "01:15:00";
|
|
description = lib.mdDoc ''
|
|
Configured when to run the backup service systemd unit (DayOfWeek Year-Month-Day Hour:Minute:Second).
|
|
'';
|
|
};
|
|
|
|
config = mkOption {
|
|
type = with types; attrsOf (oneOf [ str int bool (listOf str) ]);
|
|
default = {};
|
|
description = lib.mdDoc ''
|
|
automysqlbackup configuration. Refer to
|
|
{file}`''${pkgs.automysqlbackup}/etc/automysqlbackup.conf`
|
|
for details on supported values.
|
|
'';
|
|
example = literalExpression ''
|
|
{
|
|
db_names = [ "nextcloud" "matomo" ];
|
|
table_exclude = [ "nextcloud.oc_users" "nextcloud.oc_whats_new" ];
|
|
mailcontent = "log";
|
|
mail_address = "admin@example.org";
|
|
}
|
|
'';
|
|
};
|
|
|
|
};
|
|
};
|
|
|
|
# implementation
|
|
config = mkIf cfg.enable {
|
|
|
|
assertions = [
|
|
{ assertion = !config.services.mysqlBackup.enable;
|
|
message = "Please choose one of services.mysqlBackup or services.automysqlbackup.";
|
|
}
|
|
];
|
|
|
|
services.automysqlbackup.config = mapAttrs (name: mkDefault) {
|
|
mysql_dump_username = user;
|
|
mysql_dump_host = "localhost";
|
|
mysql_dump_socket = "/run/mysqld/mysqld.sock";
|
|
backup_dir = "/var/backup/mysql";
|
|
db_exclude = [ "information_schema" "performance_schema" ];
|
|
mailcontent = "stdout";
|
|
mysql_dump_single_transaction = true;
|
|
};
|
|
|
|
systemd.timers.automysqlbackup = {
|
|
description = "automysqlbackup timer";
|
|
wantedBy = [ "timers.target" ];
|
|
timerConfig = {
|
|
OnCalendar = cfg.calendar;
|
|
AccuracySec = "5m";
|
|
};
|
|
};
|
|
|
|
systemd.services.automysqlbackup = {
|
|
description = "automysqlbackup service";
|
|
serviceConfig = {
|
|
User = user;
|
|
Group = group;
|
|
ExecStart = "${pkg}/bin/automysqlbackup ${configFile}";
|
|
};
|
|
};
|
|
|
|
environment.systemPackages = [ pkg ];
|
|
|
|
users.users.${user} = {
|
|
group = group;
|
|
isSystemUser = true;
|
|
};
|
|
users.groups.${group} = { };
|
|
|
|
systemd.tmpfiles.rules = [
|
|
"d '${cfg.config.backup_dir}' 0750 ${user} ${group} - -"
|
|
];
|
|
|
|
services.mysql.ensureUsers = optional (config.services.mysql.enable && cfg.config.mysql_dump_host == "localhost") {
|
|
name = user;
|
|
ensurePermissions = { "*.*" = "SELECT, SHOW VIEW, TRIGGER, LOCK TABLES, EVENT"; };
|
|
};
|
|
|
|
};
|
|
}
|