conversions were done using https://github.com/pennae/nix-doc-munge using (probably) rev f34e145 running nix-doc-munge nixos/**/*.nix nix-doc-munge --import nixos/**/*.nix the tool ensures that only changes that could affect the generated manual *but don't* are committed, other changes require manual review and are discarded.
119 lines
3 KiB
Nix
119 lines
3 KiB
Nix
{ config, pkgs, lib, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.oxidized;
|
|
in
|
|
{
|
|
options.services.oxidized = {
|
|
enable = mkEnableOption (lib.mdDoc "the oxidized configuration backup service");
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = "oxidized";
|
|
description = lib.mdDoc ''
|
|
User under which the oxidized service runs.
|
|
'';
|
|
};
|
|
|
|
group = mkOption {
|
|
type = types.str;
|
|
default = "oxidized";
|
|
description = lib.mdDoc ''
|
|
Group under which the oxidized service runs.
|
|
'';
|
|
};
|
|
|
|
dataDir = mkOption {
|
|
type = types.path;
|
|
default = "/var/lib/oxidized";
|
|
description = lib.mdDoc "State directory for the oxidized service.";
|
|
};
|
|
|
|
configFile = mkOption {
|
|
type = types.path;
|
|
example = literalExpression ''
|
|
pkgs.writeText "oxidized-config.yml" '''
|
|
---
|
|
debug: true
|
|
use_syslog: true
|
|
input:
|
|
default: ssh
|
|
ssh:
|
|
secure: true
|
|
interval: 3600
|
|
model_map:
|
|
dell: powerconnect
|
|
hp: procurve
|
|
source:
|
|
default: csv
|
|
csv:
|
|
delimiter: !ruby/regexp /:/
|
|
file: "/var/lib/oxidized/.config/oxidized/router.db"
|
|
map:
|
|
name: 0
|
|
model: 1
|
|
username: 2
|
|
password: 3
|
|
pid: "/var/lib/oxidized/.config/oxidized/pid"
|
|
rest: 127.0.0.1:8888
|
|
retries: 3
|
|
# ... additional config
|
|
''';
|
|
'';
|
|
description = lib.mdDoc ''
|
|
Path to the oxidized configuration file.
|
|
'';
|
|
};
|
|
|
|
routerDB = mkOption {
|
|
type = types.path;
|
|
example = literalExpression ''
|
|
pkgs.writeText "oxidized-router.db" '''
|
|
hostname-sw1:powerconnect:username1:password2
|
|
hostname-sw2:procurve:username2:password2
|
|
# ... additional hosts
|
|
'''
|
|
'';
|
|
description = lib.mdDoc ''
|
|
Path to the file/database which contains the targets for oxidized.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
users.groups.${cfg.group} = { };
|
|
users.users.${cfg.user} = {
|
|
description = "Oxidized service user";
|
|
group = cfg.group;
|
|
home = cfg.dataDir;
|
|
createHome = true;
|
|
isSystemUser = true;
|
|
};
|
|
|
|
systemd.services.oxidized = {
|
|
wantedBy = [ "multi-user.target" ];
|
|
after = [ "network.target" ];
|
|
|
|
preStart = ''
|
|
mkdir -p ${cfg.dataDir}/.config/oxidized
|
|
ln -f -s ${cfg.routerDB} ${cfg.dataDir}/.config/oxidized/router.db
|
|
ln -f -s ${cfg.configFile} ${cfg.dataDir}/.config/oxidized/config
|
|
'';
|
|
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.oxidized}/bin/oxidized";
|
|
User = cfg.user;
|
|
Group = cfg.group;
|
|
UMask = "0077";
|
|
NoNewPrivileges = true;
|
|
Restart = "always";
|
|
WorkingDirectory = cfg.dataDir;
|
|
KillSignal = "SIGKILL";
|
|
PIDFile = "${cfg.dataDir}/.config/oxidized/pid";
|
|
};
|
|
};
|
|
};
|
|
}
|