dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

nixos/tomcat: remove with lib; and use mkEnableOption

Browse Source
This commit is contained in:
Anthony Roussel 2023-10-26 11:06:32 +02:00
parent 6b6bc55a6f
commit 0908cc1a9e
No known key found for this signature in database
GPG Key ID: 9DC4987B1A55E75E
1 changed files with 70 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

165
nixos/modules/services/web-servers/tomcat.nix
View File

@ -1,7 +1,5 @@
{ config, lib, pkgs, ... }: { config, lib, pkgs, ... }:
with lib;
let let
cfg = config.services.tomcat; cfg = config.services.tomcat;
@ -9,30 +7,20 @@ let
in in
{ {
meta = { meta = {
maintainers = with maintainers; [ danbst ]; maintainers = with lib.maintainers; [ danbst ];
}; };
###### interface ###### interface
options = { options = {
services.tomcat = { services.tomcat = {
enable = mkEnableOption (lib.mdDoc "Apache Tomcat"); enable = lib.mkEnableOption (lib.mdDoc "Apache Tomcat");
package = mkOption { package = lib.mkPackageOptionMD pkgs "tomcat9" { };
type = types.package;
default = pkgs.tomcat9;
defaultText = literalExpression "pkgs.tomcat9";
example = lib.literalExpression "pkgs.tomcat9";
description = lib.mdDoc ''
Which tomcat package to use.
'';
};
purifyOnStart = mkOption { purifyOnStart = lib.mkOption {
type = types.bool; type = lib.types.bool;
default = false; default = false;
description = lib.mdDoc '' description = lib.mdDoc ''
On startup, the `baseDir` directory is populated with various files, On startup, the `baseDir` directory is populated with various files,
@ -43,7 +31,7 @@ in
''; '';
}; };
baseDir = mkOption { baseDir = lib.mkOption {
type = lib.types.path; type = lib.types.path;
default = "/var/tomcat"; default = "/var/tomcat";
description = lib.mdDoc '' description = lib.mdDoc ''
@ -53,64 +41,64 @@ in
''; '';
}; };
logDirs = mkOption { logDirs = lib.mkOption {
default = []; default = [ ];
type = types.listOf types.path; type = lib.types.listOf lib.types.path;
description = lib.mdDoc "Directories to create in baseDir/logs/"; description = lib.mdDoc "Directories to create in baseDir/logs/";
}; };
extraConfigFiles = mkOption { extraConfigFiles = lib.mkOption {
default = []; default = [ ];
type = types.listOf types.path; type = lib.types.listOf lib.types.path;
description = lib.mdDoc "Extra configuration files to pull into the tomcat conf directory"; description = lib.mdDoc "Extra configuration files to pull into the tomcat conf directory";
}; };
extraEnvironment = mkOption { extraEnvironment = lib.mkOption {
type = types.listOf types.str; type = lib.types.listOf lib.types.str;
default = []; default = [ ];
example = [ "ENVIRONMENT=production" ]; example = [ "ENVIRONMENT=production" ];
description = lib.mdDoc "Environment Variables to pass to the tomcat service"; description = lib.mdDoc "Environment Variables to pass to the tomcat service";
}; };
extraGroups = mkOption { extraGroups = lib.mkOption {
default = []; default = [ ];
type = types.listOf types.str; type = lib.types.listOf lib.types.str;
example = [ "users" ]; example = [ "users" ];
description = lib.mdDoc "Defines extra groups to which the tomcat user belongs."; description = lib.mdDoc "Defines extra groups to which the tomcat user belongs.";
}; };
user = mkOption { user = lib.mkOption {
type = types.str; type = lib.types.str;
default = "tomcat"; default = "tomcat";
description = lib.mdDoc "User account under which Apache Tomcat runs."; description = lib.mdDoc "User account under which Apache Tomcat runs.";
}; };
group = mkOption { group = lib.mkOption {
type = types.str; type = lib.types.str;
default = "tomcat"; default = "tomcat";
description = lib.mdDoc "Group account under which Apache Tomcat runs."; description = lib.mdDoc "Group account under which Apache Tomcat runs.";
}; };
javaOpts = mkOption { javaOpts = lib.mkOption {
type = types.either (types.listOf types.str) types.str; type = lib.types.either (lib.types.listOf lib.types.str) lib.types.str;
default = ""; default = "";
description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns Apache Tomcat"; description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns Apache Tomcat";
}; };
catalinaOpts = mkOption { catalinaOpts = lib.mkOption {
type = types.either (types.listOf types.str) types.str; type = lib.types.either (lib.types.listOf lib.types.str) lib.types.str;
default = ""; default = "";
description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns the Catalina servlet container"; description = lib.mdDoc "Parameters to pass to the Java Virtual Machine which spawns the Catalina servlet container";
}; };
sharedLibs = mkOption { sharedLibs = lib.mkOption {
type = types.listOf types.str; type = lib.types.listOf lib.types.str;
default = []; default = [ ];
description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications"; description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications";
}; };
serverXml = mkOption { serverXml = lib.mkOption {
type = types.lines; type = lib.types.lines;
default = ""; default = "";
description = lib.mdDoc '' description = lib.mdDoc ''
Verbatim server.xml configuration. Verbatim server.xml configuration.
@ -118,87 +106,74 @@ in
''; '';
}; };
commonLibs = mkOption { commonLibs = lib.mkOption {
type = types.listOf types.str; type = lib.types.listOf lib.types.str;
default = []; default = [ ];
description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications and the servlet container"; description = lib.mdDoc "List containing JAR files or directories with JAR files which are libraries shared by the web applications and the servlet container";
}; };
webapps = mkOption { webapps = lib.mkOption {
type = types.listOf types.path; type = lib.types.listOf lib.types.path;
default = [ tomcat.webapps ]; default = [ tomcat.webapps ];
defaultText = literalExpression "[ config.services.tomcat.package.webapps ]"; defaultText = lib.literalExpression "[ config.services.tomcat.package.webapps ]";
description = lib.mdDoc "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat"; description = lib.mdDoc "List containing WAR files or directories with WAR files which are web applications to be deployed on Tomcat";
}; };
virtualHosts = mkOption { virtualHosts = lib.mkOption {
type = types.listOf (types.submodule { type = lib.types.listOf (lib.types.submodule {
options = { options = {
name = mkOption { name = lib.mkOption {
type = types.str; type = lib.types.str;
description = lib.mdDoc "name of the virtualhost"; description = lib.mdDoc "name of the virtualhost";
}; };
aliases = mkOption { aliases = lib.mkOption {
type = types.listOf types.str; type = lib.types.listOf lib.types.str;
description = lib.mdDoc "aliases of the virtualhost"; description = lib.mdDoc "aliases of the virtualhost";
default = []; default = [ ];
}; };
webapps = mkOption { webapps = lib.mkOption {
type = types.listOf types.path; type = lib.types.listOf lib.types.path;
description = lib.mdDoc '' description = lib.mdDoc ''
List containing web application WAR files and/or directories containing List containing web application WAR files and/or directories containing
web applications and configuration files for the virtual host. web applications and configuration files for the virtual host.
''; '';
default = []; default = [ ];
}; };
}; };
}); });
default = []; default = [ ];
description = lib.mdDoc "List consisting of a virtual host name and a list of web applications to deploy on each virtual host"; description = lib.mdDoc "List consisting of a virtual host name and a list of web applications to deploy on each virtual host";
}; };
logPerVirtualHost = mkOption { logPerVirtualHost = lib.mkOption {
type = types.bool; type = lib.types.bool;
default = false; default = false;
description = lib.mdDoc "Whether to enable logging per virtual host."; description = lib.mdDoc "Whether to enable logging per virtual host.";
}; };
jdk = mkOption { jdk = lib.mkPackageOptionMD pkgs "jdk" { };
type = types.package;
default = pkgs.jdk;
defaultText = literalExpression "pkgs.jdk";
description = lib.mdDoc "Which JDK to use.";
};
axis2 = { axis2 = {
enable = lib.mkEnableOption "Apache Axis2 container";
enable = mkOption { services = lib.mkOption {
default = false; default = [ ];
type = types.bool; type = lib.types.listOf lib.types.str;
description = lib.mdDoc "Whether to enable an Apache Axis2 container";
};
services = mkOption {
default = [];
type = types.listOf types.str;
description = lib.mdDoc "List containing AAR files or directories with AAR files which are web services to be deployed on Axis2"; description = lib.mdDoc "List containing AAR files or directories with AAR files which are web services to be deployed on Axis2";
}; };
}; };
}; };
}; };
###### implementation ###### implementation
config = mkIf config.services.tomcat.enable { config = lib.mkIf config.services.tomcat.enable {
users.groups.tomcat.gid = config.ids.gids.tomcat; users.groups.tomcat.gid = config.ids.gids.tomcat;
users.users.tomcat = users.users.tomcat =
{ uid = config.ids.uids.tomcat; {
uid = config.ids.uids.tomcat;
description = "Tomcat user"; description = "Tomcat user";
home = "/homeless-shelter"; home = "/homeless-shelter";
group = "tomcat"; group = "tomcat";
@ -234,7 +209,7 @@ in
ln -sfn ${tomcat}/conf/$i ${cfg.baseDir}/conf/`basename $i` ln -sfn ${tomcat}/conf/$i ${cfg.baseDir}/conf/`basename $i`
done done
${optionalString (cfg.extraConfigFiles != []) '' ${lib.optionalString (cfg.extraConfigFiles != []) ''
for i in ${toString cfg.extraConfigFiles}; do for i in ${toString cfg.extraConfigFiles}; do
ln -sfn $i ${cfg.baseDir}/conf/`basename $i` ln -sfn $i ${cfg.baseDir}/conf/`basename $i`
done done
@ -253,32 +228,32 @@ in
hostElementForVirtualHost = virtualHost: '' hostElementForVirtualHost = virtualHost: ''
<Host name="${virtualHost.name}" appBase="virtualhosts/${virtualHost.name}/webapps" <Host name="${virtualHost.name}" appBase="virtualhosts/${virtualHost.name}/webapps"
unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false"> unpackWARs="true" autoDeploy="true" xmlValidation="false" xmlNamespaceAware="false">
'' + concatStrings (innerElementsForVirtualHost virtualHost) + '' '' + lib.concatStrings (innerElementsForVirtualHost virtualHost) + ''
</Host> </Host>
''; '';
innerElementsForVirtualHost = virtualHost: innerElementsForVirtualHost = virtualHost:
(map (alias: '' (map (alias: ''
<Alias>${alias}</Alias> <Alias>${alias}</Alias>
'') virtualHost.aliases) '') virtualHost.aliases)
++ (optional cfg.logPerVirtualHost '' ++ (lib.optional cfg.logPerVirtualHost ''
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs/${virtualHost.name}" <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs/${virtualHost.name}"
prefix="${virtualHost.name}_access_log." pattern="combined" resolveHosts="false"/> prefix="${virtualHost.name}_access_log." pattern="combined" resolveHosts="false"/>
''); '');
hostElementsString = concatMapStringsSep "\n" hostElementForVirtualHost cfg.virtualHosts; hostElementsString = lib.concatMapStringsSep "\n" hostElementForVirtualHost cfg.virtualHosts;
hostElementsSedString = replaceStrings ["\n"] ["\\\n"] hostElementsString; hostElementsSedString = lib.replaceStrings ["\n"] ["\\\n"] hostElementsString;
in '' in ''
# Create a modified server.xml which also includes all virtual hosts # Create a modified server.xml which also includes all virtual hosts
sed -e "/<Engine name=\"Catalina\" defaultHost=\"localhost\">/a\\"${escapeShellArg hostElementsSedString} \ sed -e "/<Engine name=\"Catalina\" defaultHost=\"localhost\">/a\\"${lib.escapeShellArg hostElementsSedString} \
${tomcat}/conf/server.xml > ${cfg.baseDir}/conf/server.xml ${tomcat}/conf/server.xml > ${cfg.baseDir}/conf/server.xml
'' ''
} }
${optionalString (cfg.logDirs != []) '' ${lib.optionalString (cfg.logDirs != []) ''
for i in ${toString cfg.logDirs}; do for i in ${toString cfg.logDirs}; do
mkdir -p ${cfg.baseDir}/logs/$i mkdir -p ${cfg.baseDir}/logs/$i
chown ${cfg.user}:${cfg.group} ${cfg.baseDir}/logs/$i chown ${cfg.user}:${cfg.group} ${cfg.baseDir}/logs/$i
done done
''} ''}
${optionalString cfg.logPerVirtualHost (toString (map (h: '' ${lib.optionalString cfg.logPerVirtualHost (toString (map (h: ''
mkdir -p ${cfg.baseDir}/logs/${h.name} mkdir -p ${cfg.baseDir}/logs/${h.name}
chown ${cfg.user}:${cfg.group} ${cfg.baseDir}/logs/${h.name} chown ${cfg.user}:${cfg.group} ${cfg.baseDir}/logs/${h.name}
'') cfg.virtualHosts))} '') cfg.virtualHosts))}
@ -345,7 +320,7 @@ in
# Symlink all the given web applications files or paths into the webapps/ directory # Symlink all the given web applications files or paths into the webapps/ directory
# of this virtual host # of this virtual host
for i in "${optionalString (virtualHost ? webapps) (toString virtualHost.webapps)}"; do for i in "${lib.optionalString (virtualHost ? webapps) (toString virtualHost.webapps)}"; do
if [ -f $i ]; then if [ -f $i ]; then
# If the given web application is a file, symlink it into the webapps/ directory # If the given web application is a file, symlink it into the webapps/ directory
ln -sfn $i ${cfg.baseDir}/virtualhosts/${virtualHost.name}/webapps/`basename $i` ln -sfn $i ${cfg.baseDir}/virtualhosts/${virtualHost.name}/webapps/`basename $i`
@ -368,7 +343,7 @@ in
done done
'') cfg.virtualHosts)} '') cfg.virtualHosts)}
${optionalString cfg.axis2.enable '' ${lib.optionalString cfg.axis2.enable ''
# Copy the Axis2 web application # Copy the Axis2 web application
cp -av ${pkgs.axis2}/webapps/axis2 ${cfg.baseDir}/webapps cp -av ${pkgs.axis2}/webapps/axis2 ${cfg.baseDir}/webapps
@ -405,10 +380,10 @@ in
serviceConfig = { serviceConfig = {
Type = "forking"; Type = "forking";
PermissionsStartOnly = true; PermissionsStartOnly = true;
PIDFile="/run/tomcat/tomcat.pid"; PIDFile = "/run/tomcat/tomcat.pid";
RuntimeDirectory = "tomcat"; RuntimeDirectory = "tomcat";
User = cfg.user; User = cfg.user;
Environment=[ Environment = [
"CATALINA_BASE=${cfg.baseDir}" "CATALINA_BASE=${cfg.baseDir}"
"CATALINA_PID=/run/tomcat/tomcat.pid" "CATALINA_PID=/run/tomcat/tomcat.pid"
"JAVA_HOME='${cfg.jdk}'" "JAVA_HOME='${cfg.jdk}'"