2022-04-11 17:41:06 +01:00
|
|
|
{ config, lib, pkgs, utils, ... }:
|
2018-04-10 02:16:33 +01:00
|
|
|
|
|
|
|
with lib;
|
|
|
|
|
|
|
|
let
|
|
|
|
cfg = config.services.cockroachdb;
|
|
|
|
crdb = cfg.package;
|
|
|
|
|
2022-04-11 17:41:06 +01:00
|
|
|
startupCommand = utils.escapeSystemdExecArgs
|
2022-04-11 17:36:55 +01:00
|
|
|
([
|
|
|
|
# Basic startup
|
2022-04-11 17:41:06 +01:00
|
|
|
"${crdb}/bin/cockroach"
|
|
|
|
"start"
|
2018-04-10 02:16:33 +01:00
|
|
|
"--logtostderr"
|
nixos/cockroachdb: simplify dataDir management, tweaks
This cleans up the CockroachDB expression, with a few suggestions from
@aszlig.
However, it brought up the note of using systemd's StateDirectory=
directive, which is a nice feature for managing long-term data files,
especially for UID/GID assigned services. However, it can only manage
directories under /var/lib (for global services), so it has to introduce
a special path to make use of it at all in the case someone wants a path
at a different root.
While the dataDir directive at the NixOS level is _occasionally_ useful,
I've gone ahead and removed it for now, as this expression is so new,
and it makes the expression cleaner, while other kinks can be worked out
and people can test drive it.
CockroachDB's dataDir directive, instead, has been replaced with
systemd's StateDirectory management to place the data under
/var/lib/cockroachdb for all uses.
There's an included RequiresMountsFor= clause like usual though, so if
people want dependencies for any kind of mounted device at boot
time/before database startup, it's easy to specify using their own
mount/filesystems clause.
This can also be reverted if necessary, but, we can see if anyone ever
actually wants that later on before doing it -- it's a backwards
compatible change, anyway.
Signed-off-by: Austin Seipp <aseipp@pobox.com>
2018-12-04 23:35:16 +00:00
|
|
|
"--store=/var/lib/cockroachdb"
|
2018-04-10 02:16:33 +01:00
|
|
|
|
|
|
|
# WebUI settings
|
2022-04-11 17:41:06 +01:00
|
|
|
"--http-addr=${cfg.http.address}:${toString cfg.http.port}"
|
2018-04-10 02:16:33 +01:00
|
|
|
|
|
|
|
# Cluster listen address
|
2022-04-11 17:41:06 +01:00
|
|
|
"--listen-addr=${cfg.listen.address}:${toString cfg.listen.port}"
|
2018-04-10 02:16:33 +01:00
|
|
|
|
2022-04-11 17:41:06 +01:00
|
|
|
# Cache and memory settings.
|
|
|
|
"--cache=${cfg.cache}"
|
|
|
|
"--max-sql-memory=${cfg.maxSqlMemory}"
|
2018-04-10 02:16:33 +01:00
|
|
|
|
|
|
|
# Certificate/security settings.
|
|
|
|
(if cfg.insecure then "--insecure" else "--certs-dir=${cfg.certsDir}")
|
2022-04-11 17:41:06 +01:00
|
|
|
]
|
|
|
|
++ lib.optional (cfg.join != null) "--join=${cfg.join}"
|
|
|
|
++ lib.optional (cfg.locality != null) "--locality=${cfg.locality}"
|
|
|
|
++ cfg.extraArgs);
|
2018-04-10 02:16:33 +01:00
|
|
|
|
2022-04-11 17:41:06 +01:00
|
|
|
addressOption = descr: defaultPort: {
|
|
|
|
address = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "localhost";
|
|
|
|
description = "Address to bind to for ${descr}";
|
|
|
|
};
|
2018-04-10 02:16:33 +01:00
|
|
|
|
2022-04-11 17:41:06 +01:00
|
|
|
port = mkOption {
|
|
|
|
type = types.port;
|
|
|
|
default = defaultPort;
|
|
|
|
description = "Port to bind to for ${descr}";
|
2018-04-10 02:16:33 +01:00
|
|
|
};
|
2022-04-11 17:41:06 +01:00
|
|
|
};
|
2018-04-10 02:16:33 +01:00
|
|
|
in
|
|
|
|
|
|
|
|
{
|
|
|
|
options = {
|
|
|
|
services.cockroachdb = {
|
|
|
|
enable = mkEnableOption "CockroachDB Server";
|
|
|
|
|
|
|
|
listen = addressOption "intra-cluster communication" 26257;
|
|
|
|
|
|
|
|
http = addressOption "http-based Admin UI" 8080;
|
|
|
|
|
|
|
|
locality = mkOption {
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
default = null;
|
|
|
|
description = ''
|
|
|
|
An ordered, comma-separated list of key-value pairs that describe the
|
|
|
|
topography of the machine. Topography might include country,
|
|
|
|
datacenter or rack designations. Data is automatically replicated to
|
|
|
|
maximize diversities of each tier. The order of tiers is used to
|
|
|
|
determine the priority of the diversity, so the more inclusive
|
|
|
|
localities like country should come before less inclusive localities
|
|
|
|
like datacenter. The tiers and order must be the same on all nodes.
|
|
|
|
Including more tiers is better than including fewer. For example:
|
|
|
|
|
nixos/cockroachdb: simplify dataDir management, tweaks
This cleans up the CockroachDB expression, with a few suggestions from
@aszlig.
However, it brought up the note of using systemd's StateDirectory=
directive, which is a nice feature for managing long-term data files,
especially for UID/GID assigned services. However, it can only manage
directories under /var/lib (for global services), so it has to introduce
a special path to make use of it at all in the case someone wants a path
at a different root.
While the dataDir directive at the NixOS level is _occasionally_ useful,
I've gone ahead and removed it for now, as this expression is so new,
and it makes the expression cleaner, while other kinks can be worked out
and people can test drive it.
CockroachDB's dataDir directive, instead, has been replaced with
systemd's StateDirectory management to place the data under
/var/lib/cockroachdb for all uses.
There's an included RequiresMountsFor= clause like usual though, so if
people want dependencies for any kind of mounted device at boot
time/before database startup, it's easy to specify using their own
mount/filesystems clause.
This can also be reverted if necessary, but, we can see if anyone ever
actually wants that later on before doing it -- it's a backwards
compatible change, anyway.
Signed-off-by: Austin Seipp <aseipp@pobox.com>
2018-12-04 23:35:16 +00:00
|
|
|
<literal>
|
2018-04-10 02:16:33 +01:00
|
|
|
country=us,region=us-west,datacenter=us-west-1b,rack=12
|
|
|
|
country=ca,region=ca-east,datacenter=ca-east-2,rack=4
|
|
|
|
|
|
|
|
planet=earth,province=manitoba,colo=secondary,power=3
|
nixos/cockroachdb: simplify dataDir management, tweaks
This cleans up the CockroachDB expression, with a few suggestions from
@aszlig.
However, it brought up the note of using systemd's StateDirectory=
directive, which is a nice feature for managing long-term data files,
especially for UID/GID assigned services. However, it can only manage
directories under /var/lib (for global services), so it has to introduce
a special path to make use of it at all in the case someone wants a path
at a different root.
While the dataDir directive at the NixOS level is _occasionally_ useful,
I've gone ahead and removed it for now, as this expression is so new,
and it makes the expression cleaner, while other kinks can be worked out
and people can test drive it.
CockroachDB's dataDir directive, instead, has been replaced with
systemd's StateDirectory management to place the data under
/var/lib/cockroachdb for all uses.
There's an included RequiresMountsFor= clause like usual though, so if
people want dependencies for any kind of mounted device at boot
time/before database startup, it's easy to specify using their own
mount/filesystems clause.
This can also be reverted if necessary, but, we can see if anyone ever
actually wants that later on before doing it -- it's a backwards
compatible change, anyway.
Signed-off-by: Austin Seipp <aseipp@pobox.com>
2018-12-04 23:35:16 +00:00
|
|
|
</literal>
|
2018-04-10 02:16:33 +01:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
join = mkOption {
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
default = null;
|
|
|
|
description = "The addresses for connecting the node to a cluster.";
|
|
|
|
};
|
|
|
|
|
|
|
|
insecure = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = "Run in insecure mode.";
|
|
|
|
};
|
|
|
|
|
|
|
|
certsDir = mkOption {
|
|
|
|
type = types.nullOr types.path;
|
|
|
|
default = null;
|
|
|
|
description = "The path to the certificate directory.";
|
|
|
|
};
|
|
|
|
|
|
|
|
user = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "cockroachdb";
|
|
|
|
description = "User account under which CockroachDB runs";
|
|
|
|
};
|
|
|
|
|
|
|
|
group = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "cockroachdb";
|
|
|
|
description = "User account under which CockroachDB runs";
|
|
|
|
};
|
|
|
|
|
|
|
|
openPorts = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
|
|
|
description = "Open firewall ports for cluster communication by default";
|
|
|
|
};
|
|
|
|
|
|
|
|
cache = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "25%";
|
|
|
|
description = ''
|
|
|
|
The total size for caches.
|
|
|
|
|
|
|
|
This can be a percentage, expressed with a fraction sign or as a
|
nixos/cockroachdb: simplify dataDir management, tweaks
This cleans up the CockroachDB expression, with a few suggestions from
@aszlig.
However, it brought up the note of using systemd's StateDirectory=
directive, which is a nice feature for managing long-term data files,
especially for UID/GID assigned services. However, it can only manage
directories under /var/lib (for global services), so it has to introduce
a special path to make use of it at all in the case someone wants a path
at a different root.
While the dataDir directive at the NixOS level is _occasionally_ useful,
I've gone ahead and removed it for now, as this expression is so new,
and it makes the expression cleaner, while other kinks can be worked out
and people can test drive it.
CockroachDB's dataDir directive, instead, has been replaced with
systemd's StateDirectory management to place the data under
/var/lib/cockroachdb for all uses.
There's an included RequiresMountsFor= clause like usual though, so if
people want dependencies for any kind of mounted device at boot
time/before database startup, it's easy to specify using their own
mount/filesystems clause.
This can also be reverted if necessary, but, we can see if anyone ever
actually wants that later on before doing it -- it's a backwards
compatible change, anyway.
Signed-off-by: Austin Seipp <aseipp@pobox.com>
2018-12-04 23:35:16 +00:00
|
|
|
decimal-point number, or any bytes-based unit. For example,
|
|
|
|
<literal>"25%"</literal>, <literal>"0.25"</literal> both represent
|
|
|
|
25% of the available system memory. The values
|
|
|
|
<literal>"1000000000"</literal> and <literal>"1GB"</literal> both
|
|
|
|
represent 1 gigabyte of memory.
|
|
|
|
|
2018-04-10 02:16:33 +01:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
maxSqlMemory = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "25%";
|
|
|
|
description = ''
|
|
|
|
The maximum in-memory storage capacity available to store temporary
|
|
|
|
data for SQL queries.
|
|
|
|
|
|
|
|
This can be a percentage, expressed with a fraction sign or as a
|
nixos/cockroachdb: simplify dataDir management, tweaks
This cleans up the CockroachDB expression, with a few suggestions from
@aszlig.
However, it brought up the note of using systemd's StateDirectory=
directive, which is a nice feature for managing long-term data files,
especially for UID/GID assigned services. However, it can only manage
directories under /var/lib (for global services), so it has to introduce
a special path to make use of it at all in the case someone wants a path
at a different root.
While the dataDir directive at the NixOS level is _occasionally_ useful,
I've gone ahead and removed it for now, as this expression is so new,
and it makes the expression cleaner, while other kinks can be worked out
and people can test drive it.
CockroachDB's dataDir directive, instead, has been replaced with
systemd's StateDirectory management to place the data under
/var/lib/cockroachdb for all uses.
There's an included RequiresMountsFor= clause like usual though, so if
people want dependencies for any kind of mounted device at boot
time/before database startup, it's easy to specify using their own
mount/filesystems clause.
This can also be reverted if necessary, but, we can see if anyone ever
actually wants that later on before doing it -- it's a backwards
compatible change, anyway.
Signed-off-by: Austin Seipp <aseipp@pobox.com>
2018-12-04 23:35:16 +00:00
|
|
|
decimal-point number, or any bytes-based unit. For example,
|
|
|
|
<literal>"25%"</literal>, <literal>"0.25"</literal> both represent
|
|
|
|
25% of the available system memory. The values
|
|
|
|
<literal>"1000000000"</literal> and <literal>"1GB"</literal> both
|
|
|
|
represent 1 gigabyte of memory.
|
2018-04-10 02:16:33 +01:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
package = mkOption {
|
|
|
|
type = types.package;
|
|
|
|
default = pkgs.cockroachdb;
|
2021-10-03 17:06:03 +01:00
|
|
|
defaultText = literalExpression "pkgs.cockroachdb";
|
2018-04-10 02:16:33 +01:00
|
|
|
description = ''
|
|
|
|
The CockroachDB derivation to use for running the service.
|
2019-11-22 21:28:17 +00:00
|
|
|
|
2018-04-10 02:16:33 +01:00
|
|
|
This would primarily be useful to enable Enterprise Edition features
|
|
|
|
in your own custom CockroachDB build (Nixpkgs CockroachDB binaries
|
|
|
|
only contain open source features and open source code).
|
|
|
|
'';
|
|
|
|
};
|
2022-04-11 17:36:55 +01:00
|
|
|
|
|
|
|
extraArgs = mkOption {
|
|
|
|
type = types.listOf types.str;
|
|
|
|
default = [];
|
|
|
|
example = [ "--advertise-addr" "[fe80::f6f2:::]" ];
|
|
|
|
description = ''
|
|
|
|
Extra CLI arguments passed to <command>cockroach start</command>.
|
|
|
|
For the full list of supported argumemnts, check <link xlink:href="https://www.cockroachlabs.com/docs/stable/cockroach-start.html#flags"/>
|
|
|
|
'';
|
|
|
|
};
|
2018-04-10 02:16:33 +01:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
config = mkIf config.services.cockroachdb.enable {
|
|
|
|
assertions = [
|
2019-04-24 04:48:22 +01:00
|
|
|
{ assertion = !cfg.insecure -> cfg.certsDir != null;
|
2018-04-10 02:16:33 +01:00
|
|
|
message = "CockroachDB must have a set of SSL certificates (.certsDir), or run in Insecure Mode (.insecure = true)";
|
|
|
|
}
|
|
|
|
];
|
|
|
|
|
|
|
|
environment.systemPackages = [ crdb ];
|
|
|
|
|
2019-09-14 18:51:29 +01:00
|
|
|
users.users = optionalAttrs (cfg.user == "cockroachdb") {
|
|
|
|
cockroachdb = {
|
2018-04-10 02:16:33 +01:00
|
|
|
description = "CockroachDB Server User";
|
|
|
|
uid = config.ids.uids.cockroachdb;
|
|
|
|
group = cfg.group;
|
2019-09-14 18:51:29 +01:00
|
|
|
};
|
|
|
|
};
|
2018-04-10 02:16:33 +01:00
|
|
|
|
2019-09-14 18:51:29 +01:00
|
|
|
users.groups = optionalAttrs (cfg.group == "cockroachdb") {
|
|
|
|
cockroachdb.gid = config.ids.gids.cockroachdb;
|
|
|
|
};
|
2018-04-10 02:16:33 +01:00
|
|
|
|
|
|
|
networking.firewall.allowedTCPPorts = lib.optionals cfg.openPorts
|
|
|
|
[ cfg.http.port cfg.listen.port ];
|
|
|
|
|
|
|
|
systemd.services.cockroachdb =
|
|
|
|
{ description = "CockroachDB Server";
|
|
|
|
documentation = [ "man:cockroach(1)" "https://www.cockroachlabs.com" ];
|
|
|
|
|
|
|
|
after = [ "network.target" "time-sync.target" ];
|
|
|
|
requires = [ "time-sync.target" ];
|
|
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
|
nixos/cockroachdb: simplify dataDir management, tweaks
This cleans up the CockroachDB expression, with a few suggestions from
@aszlig.
However, it brought up the note of using systemd's StateDirectory=
directive, which is a nice feature for managing long-term data files,
especially for UID/GID assigned services. However, it can only manage
directories under /var/lib (for global services), so it has to introduce
a special path to make use of it at all in the case someone wants a path
at a different root.
While the dataDir directive at the NixOS level is _occasionally_ useful,
I've gone ahead and removed it for now, as this expression is so new,
and it makes the expression cleaner, while other kinks can be worked out
and people can test drive it.
CockroachDB's dataDir directive, instead, has been replaced with
systemd's StateDirectory management to place the data under
/var/lib/cockroachdb for all uses.
There's an included RequiresMountsFor= clause like usual though, so if
people want dependencies for any kind of mounted device at boot
time/before database startup, it's easy to specify using their own
mount/filesystems clause.
This can also be reverted if necessary, but, we can see if anyone ever
actually wants that later on before doing it -- it's a backwards
compatible change, anyway.
Signed-off-by: Austin Seipp <aseipp@pobox.com>
2018-12-04 23:35:16 +00:00
|
|
|
unitConfig.RequiresMountsFor = "/var/lib/cockroachdb";
|
2018-04-10 02:16:33 +01:00
|
|
|
|
|
|
|
serviceConfig =
|
|
|
|
{ ExecStart = startupCommand;
|
|
|
|
Type = "notify";
|
|
|
|
User = cfg.user;
|
nixos/cockroachdb: simplify dataDir management, tweaks
This cleans up the CockroachDB expression, with a few suggestions from
@aszlig.
However, it brought up the note of using systemd's StateDirectory=
directive, which is a nice feature for managing long-term data files,
especially for UID/GID assigned services. However, it can only manage
directories under /var/lib (for global services), so it has to introduce
a special path to make use of it at all in the case someone wants a path
at a different root.
While the dataDir directive at the NixOS level is _occasionally_ useful,
I've gone ahead and removed it for now, as this expression is so new,
and it makes the expression cleaner, while other kinks can be worked out
and people can test drive it.
CockroachDB's dataDir directive, instead, has been replaced with
systemd's StateDirectory management to place the data under
/var/lib/cockroachdb for all uses.
There's an included RequiresMountsFor= clause like usual though, so if
people want dependencies for any kind of mounted device at boot
time/before database startup, it's easy to specify using their own
mount/filesystems clause.
This can also be reverted if necessary, but, we can see if anyone ever
actually wants that later on before doing it -- it's a backwards
compatible change, anyway.
Signed-off-by: Austin Seipp <aseipp@pobox.com>
2018-12-04 23:35:16 +00:00
|
|
|
StateDirectory = "cockroachdb";
|
|
|
|
StateDirectoryMode = "0700";
|
2018-04-10 02:16:33 +01:00
|
|
|
|
|
|
|
Restart = "always";
|
nixos/cockroachdb: simplify dataDir management, tweaks
This cleans up the CockroachDB expression, with a few suggestions from
@aszlig.
However, it brought up the note of using systemd's StateDirectory=
directive, which is a nice feature for managing long-term data files,
especially for UID/GID assigned services. However, it can only manage
directories under /var/lib (for global services), so it has to introduce
a special path to make use of it at all in the case someone wants a path
at a different root.
While the dataDir directive at the NixOS level is _occasionally_ useful,
I've gone ahead and removed it for now, as this expression is so new,
and it makes the expression cleaner, while other kinks can be worked out
and people can test drive it.
CockroachDB's dataDir directive, instead, has been replaced with
systemd's StateDirectory management to place the data under
/var/lib/cockroachdb for all uses.
There's an included RequiresMountsFor= clause like usual though, so if
people want dependencies for any kind of mounted device at boot
time/before database startup, it's easy to specify using their own
mount/filesystems clause.
This can also be reverted if necessary, but, we can see if anyone ever
actually wants that later on before doing it -- it's a backwards
compatible change, anyway.
Signed-off-by: Austin Seipp <aseipp@pobox.com>
2018-12-04 23:35:16 +00:00
|
|
|
|
|
|
|
# A conservative-ish timeout is alright here, because for Type=notify
|
|
|
|
# cockroach will send systemd pings during startup to keep it alive
|
|
|
|
TimeoutStopSec = 60;
|
|
|
|
RestartSec = 10;
|
2018-04-10 02:16:33 +01:00
|
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
meta.maintainers = with lib.maintainers; [ thoughtpolice ];
|
|
|
|
}
|