commit 4c3f1d321aa9292f59455099c7107f42ac9b3c47 · pyrox.dev/nixpkgs

+85 -40

nixos/modules/services/web-servers/traefik.nix

···

       4
       4
        
       

     

       5
       5
        
       let

     

       6
       6
        
         cfg = config.services.traefik;

     

       7
       7
       -
         configFile =

     

       8
       8
       -
           if cfg.configFile == null then

     

       9
       9
       -
             pkgs.runCommand "config.toml" {

     

       10
       10
       -
               buildInputs = [ pkgs.remarshal ];

     

       11
       11
       -
               preferLocalBuild = true;

     

       12
       12
       -
             } ''

     

       13
       13
       -
               remarshal -if json -of toml \

     

       14
       14
       -
                 < ${pkgs.writeText "config.json" (builtins.toJSON cfg.configOptions)} \

     

       15
       15
       -
                 > $out

     

       16
       16
       -
             ''

     

       17
       17
       -
           else cfg.configFile;

     

       18
       18
       -
       

     

       7
       7
       +
         jsonValue = with types;

     

       8
       8
       +
           let

     

       9
       9
       +
             valueType = nullOr (oneOf [

     

       10
       10
       +
               bool

     

       11
       11
       +
               int

     

       12
       12
       +
               float

     

       13
       13
       +
               str

     

       14
       14
       +
               (lazyAttrsOf valueType)

     

       15
       15
       +
               (listOf valueType)

     

       16
       16
       +
             ]) // {

     

       17
       17
       +
               description = "JSON value";

     

       18
       18
       +
               emptyValue.value = { };

     

       19
       19
       +
             };

     

       20
       20
       +
           in valueType;

     

       21
       21
       +
         dynamicConfigFile = if cfg.dynamicConfigFile == null then

     

       22
       22
       +
           pkgs.runCommand "config.toml" {

     

       23
       23
       +
             buildInputs = [ pkgs.remarshal ];

     

       24
       24
       +
             preferLocalBuild = true;

     

       25
       25
       +
           } ''

     

       26
       26
       +
             remarshal -if json -of toml \

     

       27
       27
       +
               < ${

     

       28
       28
       +
                 pkgs.writeText "dynamic_config.json"

     

       29
       29
       +
                 (builtins.toJSON cfg.dynamicConfigOptions)

     

       30
       30
       +
               } \

     

       31
       31
       +
               > $out

     

       32
       32
       +
           ''

     

       33
       33
       +
         else

     

       34
       34
       +
           cfg.dynamicConfigFile;

     

       35
       35
       +
         staticConfigFile = if cfg.staticConfigFile == null then

     

       36
       36
       +
           pkgs.runCommand "config.toml" {

     

       37
       37
       +
             buildInputs = [ pkgs.yj ];

     

       38
       38
       +
             preferLocalBuild = true;

     

       39
       39
       +
           } ''

     

       40
       40
       +
             yj -jt -i \

     

       41
       41
       +
               < ${

     

       42
       42
       +
                 pkgs.writeText "static_config.json" (builtins.toJSON

     

       43
       43
       +
                   (recursiveUpdate cfg.staticConfigOptions {

     

       44
       44
       +
                     providers.file.filename = "${dynamicConfigFile}";

     

       45
       45
       +
                   }))

     

       46
       46
       +
               } \

     

       47
       47
       +
               > $out

     

       48
       48
       +
           ''

     

       49
       49
       +
         else

     

       50
       50
       +
           cfg.staticConfigFile;

     

       19
       51
        
       in {

     

       20
       52
        
         options.services.traefik = {

     

       21
       53
        
           enable = mkEnableOption "Traefik web server";

     

       22
       54
        
       

     

       23
       23
       -
           configFile = mkOption {

     

       55
       55
       +
           staticConfigFile = mkOption {

     

       24
       56
        
             default = null;

     

       25
       25
       -
             example = literalExample "/path/to/config.toml";

     

       57
       57
       +
             example = literalExample "/path/to/static_config.toml";

     

       26
       58
        
             type = types.nullOr types.path;

     

       27
       59
        
             description = ''

     

       28
       28
       -
               Path to verbatim traefik.toml to use.

     

       29
       29
       -
               (Using that option has precedence over <literal>configOptions</literal>)

     

       60
       60
       +
               Path to traefik's static configuration to use.

     

       61
       61
       +
               (Using that option has precedence over <literal>staticConfigOptions</literal> and <literal>dynamicConfigOptions</literal>)

     

       30
       62
        
             '';

     

       31
       63
        
           };

     

       32
       64
        
       

     

       33
       33
       -
           configOptions = mkOption {

     

       65
       65
       +
           staticConfigOptions = mkOption {

     

       34
       66
        
             description = ''

     

       35
       35
       -
               Config for Traefik.

     

       67
       67
       +
               Static configuration for Traefik.

     

       36
       68
        
             '';

     

       37
       37
       -
             type = types.attrs;

     

       38
       38
       -
             default = {

     

       39
       39
       -
               defaultEntryPoints = ["http"];

     

       69
       69
       +
             type = jsonValue;

     

       70
       70
       +
             default = { entryPoints.http.address = ":80"; };

     

       71
       71
       +
             example = {

     

       72
       72
       +
               entryPoints.web.address = ":8080";

     

       40
       73
        
               entryPoints.http.address = ":80";

     

       74
       74
       +
       

     

       75
       75
       +
               api = { };

     

       41
       76
        
             };

     

       42
       42
       -
             example = {

     

       43
       43
       -
               defaultEntrypoints = [ "http" ];

     

       44
       44
       -
               web.address = ":8080";

     

       45
       45
       -
               entryPoints.http.address = ":80";

     

       77
       77
       +
           };

     

       46
       78
        
       

     

       47
       47
       -
               file = {};

     

       48
       48
       -
               frontends = {

     

       49
       49
       -
                 frontend1 = {

     

       50
       50
       -
                   backend = "backend1";

     

       51
       51
       -
                   routes.test_1.rule = "Host:localhost";

     

       52
       52
       -
                 };

     

       53
       53
       -
               };

     

       54
       54
       -
               backends.backend1 = {

     

       55
       55
       -
                 servers.server1.url = "http://localhost:8000";

     

       79
       79
       +
           dynamicConfigFile = mkOption {

     

       80
       80
       +
             default = null;

     

       81
       81
       +
             example = literalExample "/path/to/dynamic_config.toml";

     

       82
       82
       +
             type = types.nullOr types.path;

     

       83
       83
       +
             description = ''

     

       84
       84
       +
               Path to traefik's dynamic configuration to use.

     

       85
       85
       +
               (Using that option has precedence over <literal>dynamicConfigOptions</literal>)

     

       86
       86
       +
             '';

     

       87
       87
       +
           };

     

       88
       88
       +
       

     

       89
       89
       +
           dynamicConfigOptions = mkOption {

     

       90
       90
       +
             description = ''

     

       91
       91
       +
               Dynamic configuration for Traefik.

     

       92
       92
       +
             '';

     

       93
       93
       +
             type = jsonValue;

     

       94
       94
       +
             default = { };

     

       95
       95
       +
             example = {

     

       96
       96
       +
               http.routers.router1 = {

     

       97
       97
       +
                 rule = "Host(`localhost`)";

     

       98
       98
       +
                 service = "service1";

     

       56
       99
        
               };

     

       100
       100
       +
       

     

       101
       101
       +
               http.services.service1.loadBalancer.servers =

     

       102
       102
       +
                 [{ url = "http://localhost:8080"; }];

     

       57
       103
        
             };

     

       58
       104
        
           };

     

       59
       105
        
       

     
···

       61
       107
        
             default = "/var/lib/traefik";

     

       62
       108
        
             type = types.path;

     

       63
       109
        
             description = ''

     

       64
       64
       -
             Location for any persistent data traefik creates, ie. acme

     

       110
       110
       +
               Location for any persistent data traefik creates, ie. acme

     

       65
       111
        
             '';

     

       66
       112
        
           };

     

       67
       113
        
       

     
···

       84
       130
        
         };

     

       85
       131
        
       

     

       86
       132
        
         config = mkIf cfg.enable {

     

       87
       87
       -
           systemd.tmpfiles.rules = [

     

       88
       88
       -
             "d '${cfg.dataDir}' 0700 traefik traefik - -"

     

       89
       89
       -
           ];

     

       133
       133
       +
           systemd.tmpfiles.rules = [ "d '${cfg.dataDir}' 0700 traefik traefik - -" ];

     

       90
       134
        
       

     

       91
       135
        
           systemd.services.traefik = {

     

       92
       136
        
             description = "Traefik web server";

     

       93
       137
        
             after = [ "network-online.target" ];

     

       94
       138
        
             wantedBy = [ "multi-user.target" ];

     

       95
       139
        
             serviceConfig = {

     

       96
       96
       -
               ExecStart = ''${cfg.package.bin}/bin/traefik --configfile=${configFile}'';

     

       140
       140
       +
               ExecStart =

     

       141
       141
       +
                 "${cfg.package}/bin/traefik --configfile=${staticConfigFile}";

     

       97
       142
        
               Type = "simple";

     

       98
       143
        
               User = "traefik";

     

       99
       144
        
               Group = cfg.group;

     
···

       120
       165
        
             isSystemUser = true;

     

       121
       166
        
           };

     

       122
       167
        
       

     

       123
       123
       -
           users.groups.traefik = {};

     

       168
       168
       +
           users.groups.traefik = { };

     

       124
       169
        
         };

     

       125
       170
        
       }

nixos/tests/all-tests.nix

···

       303
       303
        
         timezone = handleTest ./timezone.nix {};

     

       304
       304
        
         tinydns = handleTest ./tinydns.nix {};

     

       305
       305
        
         tor = handleTest ./tor.nix {};

     

       306
       306
       +
         # traefik test relies on docker-containers

     

       307
       307
       +
         traefik = handleTestOn ["x86_64-linux"] ./traefik.nix {};

     

       306
       308
        
         transmission = handleTest ./transmission.nix {};

     

       307
       309
        
         trac = handleTest ./trac.nix {};

     

       308
       310
        
         trilium-server = handleTestOn ["x86_64-linux"] ./trilium-server.nix {};

+87

nixos/tests/traefik.nix

···

       1
       1
       +
       # Test Traefik as a reverse proxy of a local web service

     

       2
       2
       +
       # and a Docker container.

     

       3
       3
       +
       import ./make-test-python.nix ({ pkgs, ... }: {

     

       4
       4
       +
         name = "traefik";

     

       5
       5
       +
         meta = with pkgs.stdenv.lib.maintainers; {

     

       6
       6
       +
           maintainers = [ joko ];

     

       7
       7
       +
         };

     

       8
       8
       +
       

     

       9
       9
       +
         nodes = {

     

       10
       10
       +
           client = { config, pkgs, ... }: {

     

       11
       11
       +
             environment.systemPackages = [ pkgs.curl ];

     

       12
       12
       +
           };

     

       13
       13
       +
           traefik = { config, pkgs, ... }: {

     

       14
       14
       +
             docker-containers.nginx = {

     

       15
       15
       +
               extraDockerOptions = [

     

       16
       16
       +
                 "-l" "traefik.enable=true"

     

       17
       17
       +
                 "-l" "traefik.http.routers.nginx.entrypoints=web"

     

       18
       18
       +
                 "-l" "traefik.http.routers.nginx.rule=Host(`nginx.traefik.test`)"

     

       19
       19
       +
               ];

     

       20
       20
       +
               image = "nginx-container";

     

       21
       21
       +
               imageFile = pkgs.dockerTools.examples.nginx;

     

       22
       22
       +
             };

     

       23
       23
       +
       

     

       24
       24
       +
             networking.firewall.allowedTCPPorts = [ 80 ];

     

       25
       25
       +
       

     

       26
       26
       +
             services.traefik = {

     

       27
       27
       +
               enable = true;

     

       28
       28
       +
       

     

       29
       29
       +
               dynamicConfigOptions = {

     

       30
       30
       +
                 http.routers.simplehttp = {

     

       31
       31
       +
                   rule = "Host(`simplehttp.traefik.test`)";

     

       32
       32
       +
                   entryPoints = [ "web" ];

     

       33
       33
       +
                   service = "simplehttp";

     

       34
       34
       +
                 };

     

       35
       35
       +
       

     

       36
       36
       +
                 http.services.simplehttp = {

     

       37
       37
       +
                   loadBalancer.servers = [{

     

       38
       38
       +
                     url = "http://127.0.0.1:8000";

     

       39
       39
       +
                   }];

     

       40
       40
       +
                 };

     

       41
       41
       +
               };

     

       42
       42
       +
       

     

       43
       43
       +
               staticConfigOptions = {

     

       44
       44
       +
                 global = {

     

       45
       45
       +
                   checkNewVersion = false;

     

       46
       46
       +
                   sendAnonymousUsage = false;

     

       47
       47
       +
                 };

     

       48
       48
       +
       

     

       49
       49
       +
                 entryPoints.web.address = ":80";

     

       50
       50
       +
       

     

       51
       51
       +
                 providers.docker.exposedByDefault = false;

     

       52
       52
       +
               };

     

       53
       53
       +
             };

     

       54
       54
       +
       

     

       55
       55
       +
             systemd.services.simplehttp = {

     

       56
       56
       +
               script = "${pkgs.python3}/bin/python -m http.server 8000";

     

       57
       57
       +
               serviceConfig.Type = "simple";

     

       58
       58
       +
               wantedBy = [ "multi-user.target" ];

     

       59
       59
       +
             };

     

       60
       60
       +
       

     

       61
       61
       +
             users.users.traefik.extraGroups = [ "docker" ];

     

       62
       62
       +
           };

     

       63
       63
       +
         };

     

       64
       64
       +
       

     

       65
       65
       +
         testScript = ''

     

       66
       66
       +
           start_all()

     

       67
       67
       +
       

     

       68
       68
       +
           traefik.wait_for_unit("docker-nginx.service")

     

       69
       69
       +
           traefik.wait_until_succeeds("docker ps | grep nginx-container")

     

       70
       70
       +
           traefik.wait_for_unit("simplehttp.service")

     

       71
       71
       +
           traefik.wait_for_unit("traefik.service")

     

       72
       72
       +
           traefik.wait_for_open_port(80)

     

       73
       73
       +
           traefik.wait_for_unit("multi-user.target")

     

       74
       74
       +
       

     

       75
       75
       +
           client.wait_for_unit("multi-user.target")

     

       76
       76
       +
       

     

       77
       77
       +
           with subtest("Check that a container can be reached via Traefik"):

     

       78
       78
       +
               assert "Hello from NGINX" in client.succeed(

     

       79
       79
       +
                   "curl -sSf -H Host:nginx.traefik.test http://traefik/"

     

       80
       80
       +
               )

     

       81
       81
       +
       

     

       82
       82
       +
           with subtest("Check that dynamic configuration works"):

     

       83
       83
       +
               assert "Directory listing for " in client.succeed(

     

       84
       84
       +
                   "curl -sSf -H Host:simplehttp.traefik.test http://traefik/"

     

       85
       85
       +
               )

     

       86
       86
       +
         '';

     

       87
       87
       +
       })

+18 -20

pkgs/servers/traefik/default.nix

···

       1
       1
       -
       { stdenv, buildGoPackage, fetchFromGitHub, bash, go-bindata}:

     

       1
       1
       +
       { stdenv, buildGoModule, fetchFromGitHub, go-bindata, nixosTests }:

     

       2
       2
        
       

     

       3
       3
       -
       buildGoPackage rec {

     

       3
       3
       +
       buildGoModule rec {

     

       4
       4
        
         pname = "traefik";

     

       5
       5
       -
         version = "1.7.14";

     

       6
       6
       -
       

     

       7
       7
       -
         goPackagePath = "github.com/containous/traefik";

     

       5
       5
       +
         version = "2.2.0";

     

       8
       6
        
       

     

       9
       7
        
         src = fetchFromGitHub {

     

       10
       8
        
           owner = "containous";

     

       11
       9
        
           repo = "traefik";

     

       12
       10
        
           rev = "v${version}";

     

       13
       13
       -
           sha256 = "1j3p09j8rpdkp8v4d4mz224ddakkvhzchvccm9qryrqc2fq4022v";

     

       11
       11
       +
           sha256 = "1dcazssabqxr9wv3dds3z7ks3y628qa07vgnn3hpdwxzm2b2ma92";

     

       14
       12
        
         };

     

       15
       13
        
       

     

       16
       16
       -
         nativeBuildInputs = [ go-bindata bash ];

     

       14
       14
       +
         modSha256 = "0w3ssxvsmq8i6hbfmn4ig2x13i2nlqy5q1khcblf9pq5vhk202qx";

     

       15
       15
       +
         subPackages = [ "cmd/traefik" ];

     

       17
       16
        
       

     

       18
       18
       -
         buildPhase = ''

     

       19
       19
       -
           runHook preBuild

     

       20
       20
       -
           (

     

       21
       21
       -
             cd go/src/github.com/containous/traefik

     

       22
       22
       -
             bash ./script/make.sh generate

     

       17
       17
       +
         nativeBuildInputs = [ go-bindata ];

     

       23
       18
        
       

     

       24
       24
       -
             CODENAME=$(awk -F "=" '/CODENAME=/ { print $2}' script/binary)

     

       25
       25
       -
             go build -ldflags "\

     

       26
       26
       -
               -X github.com/containous/traefik/version.Version=${version} \

     

       27
       27
       -
               -X github.com/containous/traefik/version.Codename=$CODENAME \

     

       28
       28
       -
             " -a -o $bin/bin/traefik ./cmd/traefik

     

       29
       29
       -
           )

     

       30
       30
       -
           runHook postBuild

     

       19
       19
       +
         passthru.tests = { inherit (nixosTests) traefik; };

     

       20
       20
       +
       

     

       21
       21
       +
         preBuild = ''

     

       22
       22
       +
           go generate

     

       23
       23
       +
       

     

       24
       24
       +
           CODENAME=$(awk -F "=" '/CODENAME=/ { print $2}' script/binary)

     

       25
       25
       +
       

     

       26
       26
       +
           makeFlagsArray+=("-ldflags=\

     

       27
       27
       +
             -X github.com/containous/traefik/version.Version=${version} \

     

       28
       28
       +
             -X github.com/containous/traefik/version.Codename=$CODENAME")

     

       31
       29
        
         '';

     

       32
       30
        
       

     

       33
       31
        
         meta = with stdenv.lib; {

     

       34
       32
        
           homepage = "https://traefik.io";

     

       35
       33
        
           description = "A modern reverse proxy";

     

       36
       34
        
           license = licenses.mit;

     

       37
       37
       -
           maintainers = with maintainers; [ hamhut1066 vdemeester ];

     

       35
       35
       +
           maintainers = with maintainers; [ vdemeester ];

     

       38
       36
        
         };

     

       39
       37
        
       }