1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
{ config, pkgs, ... }:
with pkgs.lib;
let
cfg = config.services.redis;
redisBool = b: if b then "yes" else "no";
condOption = name: value: if value != null then "${name} ${toString value}" else "";
redisConfig = pkgs.writeText "redis.conf" ''
pidfile ${cfg.pidFile}
port ${toString cfg.port}
${condOption "bind" cfg.bind}
${condOption "unixsocket" cfg.unixSocket}
loglevel ${cfg.logLevel}
logfile ${cfg.logfile}
databases ${toString cfg.databases}
${concatMapStrings (d: "save ${toString (builtins.elemAt d 0)} ${toString (builtins.elemAt d 1)}\n") cfg.save}
dbfilename ${cfg.dbFilename}
dir ${toString cfg.dbpath}
${if cfg.slaveOf != null then "slaveof ${cfg.slaveOf.ip} ${toString cfg.slaveOf.port}" else ""}
${condOption "masterauth" cfg.masterAuth}
${condOption "requirepass" cfg.requirePass}
appendOnly ${redisBool cfg.appendOnly}
appendfsync ${cfg.appendFsync}
slowlog-log-slower-than ${toString cfg.slowLogLogSlowerThan}
slowlog-max-len ${toString cfg.slowLogMaxLen}
${cfg.extraConfig}
'';
in
{
###### interface
options = {
services.redis = {
enable = mkOption {
default = false;
description = "Whether to enable the Redis server.";
};
package = mkOption {
default = pkgs.redis;
description = "Which Redis derivation to use.";
};
user = mkOption {
default = "redis";
description = "User account under which Redis runs";
};
pidFile = mkOption {
default = "/var/lib/redis/redis.pid";
description = "";
};
port = mkOption {
default = 6379;
description = "The port for Redis to listen to";
type = with types; int;
};
bind = mkOption {
default = null; # All interfaces
description = "The IP interface to bind to";
example = "127.0.0.1";
};
unixSocket = mkOption {
default = null;
description = "The path to the socket to bind to";
example = "/var/run/redis.sock";
};
logLevel = mkOption {
default = "notice"; # debug, verbose, notice, warning
example = "debug";
description = "Specify the server verbosity level, options: debug, verbose, notice, warning";
type = with types; string;
};
logfile = mkOption {
default = "stdout";
description = "Specify the log file name. Also 'stdout' can be used to force Redis to log on the standard output.";
example = "/var/log/redis.log";
type = with types; string;
};
databases = mkOption {
default = 16;
description = "Set the number of databases.";
type = with types; int;
};
save = mkOption {
default = [ [900 1] [300 10] [60 10000] ];
description = "The schedule in which data is persisted to disk, represented as a list of lists where the first element represent the amount of seconds and the second the number of changes.";
example = [ [900 1] [300 10] [60 10000] ];
};
dbFilename = mkOption {
default = "dump.rdb";
description = "The filename where to dump the DB";
type = with types; string;
};
dbpath = mkOption {
default = "/var/lib/redis";
description = "The DB will be written inside this directory, with the filename specified using the 'dbFilename' configuration";
type = with types; string;
};
slaveOf = mkOption {
default = null; # { ip, port }
description = "An attribute set with two attributes: ip and port to which this redis instance acts as a slave";
example = { ip = "192.168.1.100"; port = 6379; };
};
masterAuth = mkOption {
default = null;
description = ''If the master is password protected (using the requirePass configuration)
it is possible to tell the slave to authenticate before starting the replication synchronization
process, otherwise the master will refuse the slave request.
(STORED PLAIN TEXT, WORLD-READABLE IN NIX STORE)'';
};
requirePass = mkOption {
default = null;
description = "Password for database (STORED PLAIN TEXT, WORLD-READABLE IN NIX STORE)";
example = "letmein!";
};
appendOnly = mkOption {
default = false;
description = "By default data is only periodically persisted to disk, enable this option to use an append-only file for improved persistence.";
type = with types; bool;
};
appendOnlyFilename = mkOption {
default = "appendonly.aof";
description = "Filename for the append-only file (stored inside of dbpath)";
type = with types; string;
};
appendFsync = mkOption {
default = "everysec"; # no, always, everysec
description = "How often to fsync the append-only log, options: no, always, everysec";
type = with types; string;
};
slowLogLogSlowerThan = mkOption {
default = 10000;
description = "Log queries whose execution take longer than X in milliseconds";
example = 1000;
type = with types; int;
};
slowLogMaxLen = mkOption {
default = 128;
description = "Maximum number of items to keep in slow log";
type = with types; int;
};
extraConfig = mkOption {
default = "";
description = "Extra configuration options for redis.conf";
type = with types; string;
};
};
};
###### implementation
config = mkIf config.services.redis.enable {
users.extraUsers = singleton
{ name = cfg.user;
description = "Redis database user";
};
environment.systemPackages = [ cfg.package ];
systemd.services.redis_init =
{ description = "Redis server initialisation";
wantedBy = [ "redis.service" ];
before = [ "redis.service" ];
serviceConfig.Type = "oneshot";
script = ''
if ! test -e ${cfg.dbpath}; then
install -d -m0700 -o ${cfg.user} ${cfg.dbpath}
fi
'';
};
systemd.services.redis =
{ description = "Redis server";
wantedBy = [ "multi-user.target" ];
after = [ "network.target" ];
serviceConfig = {
ExecStart = "${cfg.package}/bin/redis-server ${redisConfig}";
User = cfg.user;
};
};
};
}
|