mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-25 08:23:09 +00:00
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.
319 lines
14 KiB
Nix
319 lines
14 KiB
Nix
{ lib, pkgs, config, options, ... }:
|
|
|
|
let
|
|
cfg = config.services.nifi;
|
|
opt = options.services.nifi;
|
|
|
|
env = {
|
|
NIFI_OVERRIDE_NIFIENV = "true";
|
|
NIFI_HOME = "/var/lib/nifi";
|
|
NIFI_PID_DIR = "/run/nifi";
|
|
NIFI_LOG_DIR = "/var/log/nifi";
|
|
};
|
|
|
|
envFile = pkgs.writeText "nifi.env" (lib.concatMapStrings (s: s + "\n") (
|
|
(lib.concatLists (lib.mapAttrsToList (name: value:
|
|
if value != null then [
|
|
"${name}=\"${toString value}\""
|
|
] else []
|
|
) env))));
|
|
|
|
nifiEnv = pkgs.writeShellScriptBin "nifi-env" ''
|
|
set -a
|
|
source "${envFile}"
|
|
eval -- "\$@"
|
|
'';
|
|
|
|
in {
|
|
options = {
|
|
services.nifi = {
|
|
enable = lib.mkEnableOption "Apache NiFi";
|
|
|
|
package = lib.mkOption {
|
|
type = lib.types.package;
|
|
default = pkgs.nifi;
|
|
defaultText = lib.literalExpression "pkgs.nifi";
|
|
description = lib.mdDoc "Apache NiFi package to use.";
|
|
};
|
|
|
|
user = lib.mkOption {
|
|
type = lib.types.str;
|
|
default = "nifi";
|
|
description = lib.mdDoc "User account where Apache NiFi runs.";
|
|
};
|
|
|
|
group = lib.mkOption {
|
|
type = lib.types.str;
|
|
default = "nifi";
|
|
description = lib.mdDoc "Group account where Apache NiFi runs.";
|
|
};
|
|
|
|
enableHTTPS = lib.mkOption {
|
|
type = lib.types.bool;
|
|
default = true;
|
|
description = lib.mdDoc "Enable HTTPS protocol. Don`t use in production.";
|
|
};
|
|
|
|
listenHost = lib.mkOption {
|
|
type = lib.types.str;
|
|
default = if cfg.enableHTTPS then "0.0.0.0" else "127.0.0.1";
|
|
defaultText = lib.literalExpression ''
|
|
if config.${opt.enableHTTPS}
|
|
then "0.0.0.0"
|
|
else "127.0.0.1"
|
|
'';
|
|
description = lib.mdDoc "Bind to an ip for Apache NiFi web-ui.";
|
|
};
|
|
|
|
listenPort = lib.mkOption {
|
|
type = lib.types.int;
|
|
default = if cfg.enableHTTPS then 8443 else 8080;
|
|
defaultText = lib.literalExpression ''
|
|
if config.${opt.enableHTTPS}
|
|
then "8443"
|
|
else "8000"
|
|
'';
|
|
description = lib.mdDoc "Bind to a port for Apache NiFi web-ui.";
|
|
};
|
|
|
|
proxyHost = lib.mkOption {
|
|
type = lib.types.nullOr lib.types.str;
|
|
default = if cfg.enableHTTPS then "0.0.0.0" else null;
|
|
defaultText = lib.literalExpression ''
|
|
if config.${opt.enableHTTPS}
|
|
then "0.0.0.0"
|
|
else null
|
|
'';
|
|
description = lib.mdDoc "Allow requests from a specific host.";
|
|
};
|
|
|
|
proxyPort = lib.mkOption {
|
|
type = lib.types.nullOr lib.types.int;
|
|
default = if cfg.enableHTTPS then 8443 else null;
|
|
defaultText = lib.literalExpression ''
|
|
if config.${opt.enableHTTPS}
|
|
then "8443"
|
|
else null
|
|
'';
|
|
description = lib.mdDoc "Allow requests from a specific port.";
|
|
};
|
|
|
|
initUser = lib.mkOption {
|
|
type = lib.types.nullOr lib.types.str;
|
|
default = null;
|
|
description = lib.mdDoc "Initial user account for Apache NiFi. Username must be at least 4 characters.";
|
|
};
|
|
|
|
initPasswordFile = lib.mkOption {
|
|
type = lib.types.nullOr lib.types.path;
|
|
default = null;
|
|
example = "/run/keys/nifi/password-nifi";
|
|
description = lib.mdDoc "nitial password for Apache NiFi. Password must be at least 12 characters.";
|
|
};
|
|
|
|
initJavaHeapSize = lib.mkOption {
|
|
type = lib.types.nullOr lib.types.int;
|
|
default = null;
|
|
example = 1024;
|
|
description = lib.mdDoc "Set the initial heap size for the JVM in MB.";
|
|
};
|
|
|
|
maxJavaHeapSize = lib.mkOption {
|
|
type = lib.types.nullOr lib.types.int;
|
|
default = null;
|
|
example = 2048;
|
|
description = lib.mdDoc "Set the initial heap size for the JVM in MB.";
|
|
};
|
|
};
|
|
};
|
|
|
|
config = lib.mkIf cfg.enable {
|
|
assertions = [
|
|
{ assertion = cfg.initUser!=null || cfg.initPasswordFile==null;
|
|
message = ''
|
|
<option>services.nifi.initUser</option> needs to be set if <option>services.nifi.initPasswordFile</option> enabled.
|
|
'';
|
|
}
|
|
{ assertion = cfg.initUser==null || cfg.initPasswordFile!=null;
|
|
message = ''
|
|
<option>services.nifi.initPasswordFile</option> needs to be set if <option>services.nifi.initUser</option> enabled.
|
|
'';
|
|
}
|
|
{ assertion = cfg.proxyHost==null || cfg.proxyPort!=null;
|
|
message = ''
|
|
<option>services.nifi.proxyPort</option> needs to be set if <option>services.nifi.proxyHost</option> value specified.
|
|
'';
|
|
}
|
|
{ assertion = cfg.proxyHost!=null || cfg.proxyPort==null;
|
|
message = ''
|
|
<option>services.nifi.proxyHost</option> needs to be set if <option>services.nifi.proxyPort</option> value specified.
|
|
'';
|
|
}
|
|
{ assertion = cfg.initJavaHeapSize==null || cfg.maxJavaHeapSize!=null;
|
|
message = ''
|
|
<option>services.nifi.maxJavaHeapSize</option> needs to be set if <option>services.nifi.initJavaHeapSize</option> value specified.
|
|
'';
|
|
}
|
|
{ assertion = cfg.initJavaHeapSize!=null || cfg.maxJavaHeapSize==null;
|
|
message = ''
|
|
<option>services.nifi.initJavaHeapSize</option> needs to be set if <option>services.nifi.maxJavaHeapSize</option> value specified.
|
|
'';
|
|
}
|
|
];
|
|
|
|
warnings = lib.optional (cfg.enableHTTPS==false) ''
|
|
Please do not disable HTTPS mode in production. In this mode, access to the nifi is opened without authentication.
|
|
'';
|
|
|
|
systemd.tmpfiles.rules = [
|
|
"d '/var/lib/nifi/conf' 0750 ${cfg.user} ${cfg.group}"
|
|
"L+ '/var/lib/nifi/lib' - - - - ${cfg.package}/lib"
|
|
];
|
|
|
|
|
|
systemd.services.nifi = {
|
|
description = "Apache NiFi";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
environment = env;
|
|
path = [ pkgs.gawk ];
|
|
|
|
serviceConfig = {
|
|
Type = "forking";
|
|
PIDFile = "/run/nifi/nifi.pid";
|
|
ExecStartPre = pkgs.writeScript "nifi-pre-start.sh" ''
|
|
#!/bin/sh
|
|
umask 077
|
|
test -f '/var/lib/nifi/conf/authorizers.xml' || (cp '${cfg.package}/share/nifi/conf/authorizers.xml' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/authorizers.xml')
|
|
test -f '/var/lib/nifi/conf/bootstrap.conf' || (cp '${cfg.package}/share/nifi/conf/bootstrap.conf' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/bootstrap.conf')
|
|
test -f '/var/lib/nifi/conf/bootstrap-hashicorp-vault.conf' || (cp '${cfg.package}/share/nifi/conf/bootstrap-hashicorp-vault.conf' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/bootstrap-hashicorp-vault.conf')
|
|
test -f '/var/lib/nifi/conf/bootstrap-notification-services.xml' || (cp '${cfg.package}/share/nifi/conf/bootstrap-notification-services.xml' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/bootstrap-notification-services.xml')
|
|
test -f '/var/lib/nifi/conf/logback.xml' || (cp '${cfg.package}/share/nifi/conf/logback.xml' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/logback.xml')
|
|
test -f '/var/lib/nifi/conf/login-identity-providers.xml' || (cp '${cfg.package}/share/nifi/conf/login-identity-providers.xml' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/login-identity-providers.xml')
|
|
test -f '/var/lib/nifi/conf/nifi.properties' || (cp '${cfg.package}/share/nifi/conf/nifi.properties' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/nifi.properties')
|
|
test -f '/var/lib/nifi/conf/stateless-logback.xml' || (cp '${cfg.package}/share/nifi/conf/stateless-logback.xml' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/stateless-logback.xml')
|
|
test -f '/var/lib/nifi/conf/stateless.properties' || (cp '${cfg.package}/share/nifi/conf/stateless.properties' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/stateless.properties')
|
|
test -f '/var/lib/nifi/conf/state-management.xml' || (cp '${cfg.package}/share/nifi/conf/state-management.xml' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/state-management.xml')
|
|
test -f '/var/lib/nifi/conf/zookeeper.properties' || (cp '${cfg.package}/share/nifi/conf/zookeeper.properties' '/var/lib/nifi/conf/' && chmod 0640 '/var/lib/nifi/conf/zookeeper.properties')
|
|
test -d '/var/lib/nifi/docs/html' || (mkdir -p /var/lib/nifi/docs && cp -r '${cfg.package}/share/nifi/docs/html' '/var/lib/nifi/docs/html')
|
|
${lib.optionalString ((cfg.initUser != null) && (cfg.initPasswordFile != null)) ''
|
|
awk -F'[<|>]' '/property name="Username"/ {if ($3!="") f=1} END{exit !f}' /var/lib/nifi/conf/login-identity-providers.xml || ${cfg.package}/bin/nifi.sh set-single-user-credentials ${cfg.initUser} $(cat ${cfg.initPasswordFile})
|
|
''}
|
|
${lib.optionalString (cfg.enableHTTPS == false) ''
|
|
sed -i /var/lib/nifi/conf/nifi.properties \
|
|
-e 's|nifi.remote.input.secure=.*|nifi.remote.input.secure=false|g' \
|
|
-e 's|nifi.web.http.host=.*|nifi.web.http.host=${cfg.listenHost}|g' \
|
|
-e 's|nifi.web.http.port=.*|nifi.web.http.port=${(toString cfg.listenPort)}|g' \
|
|
-e 's|nifi.web.https.host=.*|nifi.web.https.host=|g' \
|
|
-e 's|nifi.web.https.port=.*|nifi.web.https.port=|g' \
|
|
-e 's|nifi.security.keystore=.*|nifi.security.keystore=|g' \
|
|
-e 's|nifi.security.keystoreType=.*|nifi.security.keystoreType=|g' \
|
|
-e 's|nifi.security.truststore=.*|nifi.security.truststore=|g' \
|
|
-e 's|nifi.security.truststoreType=.*|nifi.security.truststoreType=|g' \
|
|
-e '/nifi.security.keystorePasswd/s|^|#|' \
|
|
-e '/nifi.security.keyPasswd/s|^|#|' \
|
|
-e '/nifi.security.truststorePasswd/s|^|#|'
|
|
''}
|
|
${lib.optionalString (cfg.enableHTTPS == true) ''
|
|
sed -i /var/lib/nifi/conf/nifi.properties \
|
|
-e 's|nifi.remote.input.secure=.*|nifi.remote.input.secure=true|g' \
|
|
-e 's|nifi.web.http.host=.*|nifi.web.http.host=|g' \
|
|
-e 's|nifi.web.http.port=.*|nifi.web.http.port=|g' \
|
|
-e 's|nifi.web.https.host=.*|nifi.web.https.host=${cfg.listenHost}|g' \
|
|
-e 's|nifi.web.https.port=.*|nifi.web.https.port=${(toString cfg.listenPort)}|g' \
|
|
-e 's|nifi.security.keystore=.*|nifi.security.keystore=./conf/keystore.p12|g' \
|
|
-e 's|nifi.security.keystoreType=.*|nifi.security.keystoreType=PKCS12|g' \
|
|
-e 's|nifi.security.truststore=.*|nifi.security.truststore=./conf/truststore.p12|g' \
|
|
-e 's|nifi.security.truststoreType=.*|nifi.security.truststoreType=PKCS12|g' \
|
|
-e '/nifi.security.keystorePasswd/s|^#\+||' \
|
|
-e '/nifi.security.keyPasswd/s|^#\+||' \
|
|
-e '/nifi.security.truststorePasswd/s|^#\+||'
|
|
''}
|
|
${lib.optionalString ((cfg.enableHTTPS == true) && (cfg.proxyHost != null) && (cfg.proxyPort != null)) ''
|
|
sed -i /var/lib/nifi/conf/nifi.properties \
|
|
-e 's|nifi.web.proxy.host=.*|nifi.web.proxy.host=${cfg.proxyHost}:${(toString cfg.proxyPort)}|g'
|
|
''}
|
|
${lib.optionalString ((cfg.enableHTTPS == false) || (cfg.proxyHost == null) && (cfg.proxyPort == null)) ''
|
|
sed -i /var/lib/nifi/conf/nifi.properties \
|
|
-e 's|nifi.web.proxy.host=.*|nifi.web.proxy.host=|g'
|
|
''}
|
|
${lib.optionalString ((cfg.initJavaHeapSize != null) && (cfg.maxJavaHeapSize != null))''
|
|
sed -i /var/lib/nifi/conf/bootstrap.conf \
|
|
-e 's|java.arg.2=.*|java.arg.2=-Xms${(toString cfg.initJavaHeapSize)}m|g' \
|
|
-e 's|java.arg.3=.*|java.arg.3=-Xmx${(toString cfg.maxJavaHeapSize)}m|g'
|
|
''}
|
|
${lib.optionalString ((cfg.initJavaHeapSize == null) && (cfg.maxJavaHeapSize == null))''
|
|
sed -i /var/lib/nifi/conf/bootstrap.conf \
|
|
-e 's|java.arg.2=.*|java.arg.2=-Xms512m|g' \
|
|
-e 's|java.arg.3=.*|java.arg.3=-Xmx512m|g'
|
|
''}
|
|
'';
|
|
ExecStart = "${cfg.package}/bin/nifi.sh start";
|
|
ExecStop = "${cfg.package}/bin/nifi.sh stop";
|
|
# User and group
|
|
User = cfg.user;
|
|
Group = cfg.group;
|
|
# Runtime directory and mode
|
|
RuntimeDirectory = "nifi";
|
|
RuntimeDirectoryMode = "0750";
|
|
# State directory and mode
|
|
StateDirectory = "nifi";
|
|
StateDirectoryMode = "0750";
|
|
# Logs directory and mode
|
|
LogsDirectory = "nifi";
|
|
LogsDirectoryMode = "0750";
|
|
# Proc filesystem
|
|
ProcSubset = "pid";
|
|
ProtectProc = "invisible";
|
|
# Access write directories
|
|
ReadWritePaths = [ cfg.initPasswordFile ];
|
|
UMask = "0027";
|
|
# Capabilities
|
|
CapabilityBoundingSet = "";
|
|
# Security
|
|
NoNewPrivileges = true;
|
|
# Sandboxing
|
|
ProtectSystem = "strict";
|
|
ProtectHome = true;
|
|
PrivateTmp = true;
|
|
PrivateDevices = true;
|
|
PrivateIPC = true;
|
|
PrivateUsers = true;
|
|
ProtectHostname = true;
|
|
ProtectClock = true;
|
|
ProtectKernelTunables = true;
|
|
ProtectKernelModules = true;
|
|
ProtectKernelLogs = true;
|
|
ProtectControlGroups = true;
|
|
RestrictAddressFamilies = [ "AF_INET AF_INET6" ];
|
|
RestrictNamespaces = true;
|
|
LockPersonality = true;
|
|
MemoryDenyWriteExecute = false;
|
|
RestrictRealtime = true;
|
|
RestrictSUIDSGID = true;
|
|
RemoveIPC = true;
|
|
PrivateMounts = true;
|
|
# System Call Filtering
|
|
SystemCallArchitectures = "native";
|
|
SystemCallFilter = [ "~@cpu-emulation @debug @keyring @memlock @mount @obsolete @resources @privileged @setuid" "@chown" ];
|
|
};
|
|
};
|
|
|
|
users.users = lib.mkMerge [
|
|
(lib.mkIf (cfg.user == "nifi") {
|
|
nifi = {
|
|
group = cfg.group;
|
|
isSystemUser = true;
|
|
home = cfg.package;
|
|
};
|
|
})
|
|
(lib.attrsets.setAttrByPath [ cfg.user "packages" ] [ cfg.package nifiEnv ])
|
|
];
|
|
|
|
users.groups = lib.optionalAttrs (cfg.group == "nifi") {
|
|
nifi = { };
|
|
};
|
|
};
|
|
}
|