commit 8f0c7e38cbd47df68fa560a0c9ea5f42fb5f82e9 · pyrox.dev/nixpkgs

nixos/doc/manual/from_md/release-notes/rl-2211.section.xml

···

       314
       314
        
             </listitem>

     

       315
       315
        
             <listitem>

     

       316
       316
        
               <para>

     

       317
       317
       +
                 <link xlink:href="https://garagehq.deuxfleurs.fr/">Garage</link>,

     

       318
       318
       +
                 a simple object storage server for geodistributed deployments,

     

       319
       319
       +
                 alternative to MinIO. Available as

     

       320
       320
       +
                 <link linkend="opt-services.garage.enable">services.garage</link>.

     

       321
       321
       +
               </para>

     

       322
       322
       +
             </listitem>

     

       323
       323
       +
             <listitem>

     

       324
       324
       +
               <para>

     

       317
       325
        
                 <link xlink:href="https://netbird.io">netbird</link>, a zero

     

       318
       326
        
                 configuration VPN. Available as

     

       319
       327
        
                 <link xlink:href="options.html#opt-services.netbird.enable">services.netbird</link>.

nixos/doc/manual/release-notes/rl-2211.section.md

···

       108
       108
        
       

     

       109
       109
        
       - [endlessh-go](https://github.com/shizunge/endlessh-go), an SSH tarpit that exposes Prometheus metrics. Available as [services.endlessh-go](#opt-services.endlessh-go.enable).

     

       110
       110
        
       

     

       111
       111
       +
       - [Garage](https://garagehq.deuxfleurs.fr/), a simple object storage server for geodistributed deployments, alternative to MinIO. Available as [services.garage](#opt-services.garage.enable).

     

       112
       112
       +
       

     

       111
       113
        
       - [netbird](https://netbird.io), a zero configuration VPN.

     

       112
       114
        
         Available as [services.netbird](options.html#opt-services.netbird.enable).

     

       113
       115

nixos/modules/module-list.nix

···

       1147
       1147
        
         ./services/web-servers/caddy/default.nix

     

       1148
       1148
        
         ./services/web-servers/darkhttpd.nix

     

       1149
       1149
        
         ./services/web-servers/fcgiwrap.nix

     

       1150
       1150
       +
         ./services/web-servers/garage.nix

     

       1150
       1151
        
         ./services/web-servers/hitch/default.nix

     

       1151
       1152
        
         ./services/web-servers/hydron.nix

     

       1152
       1153
        
         ./services/web-servers/jboss/default.nix

+91

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

···

       1
       1
       +
       { config, lib, pkgs, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       with lib;

     

       4
       4
       +
       

     

       5
       5
       +
       let

     

       6
       6
       +
         cfg = config.services.garage;

     

       7
       7
       +
         toml = pkgs.formats.toml {};

     

       8
       8
       +
         configFile = toml.generate "garage.toml" cfg.settings;

     

       9
       9
       +
       in

     

       10
       10
       +
       {

     

       11
       11
       +
         meta.maintainers = [ maintainers.raitobezarius ];

     

       12
       12
       +
       

     

       13
       13
       +
         options.services.garage = {

     

       14
       14
       +
           enable = mkEnableOption (lib.mdDoc "Garage Object Storage (S3 compatible)");

     

       15
       15
       +
       

     

       16
       16
       +
           extraEnvironment = mkOption {

     

       17
       17
       +
             type = types.attrsOf types.str;

     

       18
       18
       +
             description = lib.mdDoc "Extra environment variables to pass to the Garage server.";

     

       19
       19
       +
             default = {};

     

       20
       20
       +
             example = { RUST_BACKTRACE="yes"; };

     

       21
       21
       +
           };

     

       22
       22
       +
       

     

       23
       23
       +
           logLevel = mkOption {

     

       24
       24
       +
             type = types.enum (["info" "debug" "trace"]);

     

       25
       25
       +
             default = "info";

     

       26
       26
       +
             example = "debug";

     

       27
       27
       +
             description = lib.mdDoc "Garage log level, see <https://garagehq.deuxfleurs.fr/documentation/quick-start/#launching-the-garage-server> for examples.";

     

       28
       28
       +
           };

     

       29
       29
       +
       

     

       30
       30
       +
           settings = mkOption {

     

       31
       31
       +
             type = types.submodule {

     

       32
       32
       +
               freeformType = toml.type;

     

       33
       33
       +
       

     

       34
       34
       +
               options = {

     

       35
       35
       +
                 metadata_dir = mkOption {

     

       36
       36
       +
                   default = "/var/lib/garage/meta";

     

       37
       37
       +
                   type = types.path;

     

       38
       38
       +
                   description = lib.mdDoc "The metadata directory, put this on a fast disk (e.g. SSD) if possible.";

     

       39
       39
       +
                 };

     

       40
       40
       +
       

     

       41
       41
       +
                 data_dir = mkOption {

     

       42
       42
       +
                   default = "/var/lib/garage/data";

     

       43
       43
       +
                   type = types.path;

     

       44
       44
       +
                   description = lib.mdDoc "The main data storage, put this on your large storage (e.g. high capacity HDD)";

     

       45
       45
       +
                 };

     

       46
       46
       +
       

     

       47
       47
       +
                 replication_mode = mkOption {

     

       48
       48
       +
                   default = "none";

     

       49
       49
       +
                   type = types.enum ([ "none" "1" "2" "3" 1 2 3 ]);

     

       50
       50
       +
                   apply = v: toString v;

     

       51
       51
       +
                   description = lib.mdDoc "Garage replication mode, defaults to none, see: <https://garagehq.deuxfleurs.fr/reference_manual/configuration.html#replication_mode> for reference.";

     

       52
       52
       +
                 };

     

       53
       53
       +
               };

     

       54
       54
       +
             };

     

       55
       55
       +
             description = lib.mdDoc "Garage configuration, see <https://garagehq.deuxfleurs.fr/reference_manual/configuration.html> for reference.";

     

       56
       56
       +
           };

     

       57
       57
       +
       

     

       58
       58
       +
           package = mkOption {

     

       59
       59
       +
             default = pkgs.garage;

     

       60
       60
       +
             defaultText = literalExpression "pkgs.garage";

     

       61
       61
       +
             type = types.package;

     

       62
       62
       +
             description = lib.mdDoc "Garage package to use.";

     

       63
       63
       +
           };

     

       64
       64
       +
         };

     

       65
       65
       +
       

     

       66
       66
       +
         config = mkIf cfg.enable {

     

       67
       67
       +
           environment.etc."garage.toml" = {

     

       68
       68
       +
             source = configFile;

     

       69
       69
       +
           };

     

       70
       70
       +
       

     

       71
       71
       +
           environment.systemPackages = [ cfg.package ]; # For administration

     

       72
       72
       +
       

     

       73
       73
       +
           systemd.services.garage = {

     

       74
       74
       +
             description = "Garage Object Storage (S3 compatible)";

     

       75
       75
       +
             after = [ "network.target" "network-online.target" ];

     

       76
       76
       +
             wants = [ "network.target" "network-online.target" ];

     

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

     

       78
       78
       +
             serviceConfig = {

     

       79
       79
       +
               ExecStart = "${cfg.package}/bin/garage server";

     

       80
       80
       +
       

     

       81
       81
       +
               StateDirectory = mkIf (hasPrefix "/var/lib/garage" cfg.settings.data_dir && hasPrefix "/var/lib/garage" cfg.settings.metadata_dir) "garage";

     

       82
       82
       +
               DynamicUser = lib.mkDefault true;

     

       83
       83
       +
               ProtectHome = true;

     

       84
       84
       +
               NoNewPrivileges = true;

     

       85
       85
       +
             };

     

       86
       86
       +
             environment = {

     

       87
       87
       +
               RUST_LOG = lib.mkDefault "garage=${cfg.logLevel}";

     

       88
       88
       +
             } // cfg.extraEnvironment;

     

       89
       89
       +
           };

     

       90
       90
       +
         };

     

       91
       91
       +
       }

nixos/tests/all-tests.nix

···

       214
       214
        
         fsck = handleTest ./fsck.nix {};

     

       215
       215
        
         ft2-clone = handleTest ./ft2-clone.nix {};

     

       216
       216
        
         mimir = handleTest ./mimir.nix {};

     

       217
       217
       +
         garage = handleTest ./garage.nix {};

     

       217
       218
        
         gerrit = handleTest ./gerrit.nix {};

     

       218
       219
        
         geth = handleTest ./geth.nix {};

     

       219
       220
        
         ghostunnel = handleTest ./ghostunnel.nix {};

+169

nixos/tests/garage.nix

···

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

     

       2
       2
       +
       let

     

       3
       3
       +
           mkNode = { replicationMode, publicV6Address ? "::1" }: { pkgs, ... }: {

     

       4
       4
       +
             networking.interfaces.eth1.ipv6.addresses = [{

     

       5
       5
       +
               address = publicV6Address;

     

       6
       6
       +
               prefixLength = 64;

     

       7
       7
       +
             }];

     

       8
       8
       +
       

     

       9
       9
       +
             networking.firewall.allowedTCPPorts = [ 3901 3902 ];

     

       10
       10
       +
       

     

       11
       11
       +
             services.garage = {

     

       12
       12
       +
               enable = true;

     

       13
       13
       +
               settings = {

     

       14
       14
       +
                 replication_mode = replicationMode;

     

       15
       15
       +
       

     

       16
       16
       +
                 rpc_bind_addr = "[::]:3901";

     

       17
       17
       +
                 rpc_public_addr = "[${publicV6Address}]:3901";

     

       18
       18
       +
                 rpc_secret = "5c1915fa04d0b6739675c61bf5907eb0fe3d9c69850c83820f51b4d25d13868c";

     

       19
       19
       +
       

     

       20
       20
       +
                 s3_api = {

     

       21
       21
       +
                   s3_region = "garage";

     

       22
       22
       +
                   api_bind_addr = "[::]:3900";

     

       23
       23
       +
                   root_domain = ".s3.garage";

     

       24
       24
       +
                 };

     

       25
       25
       +
       

     

       26
       26
       +
                 s3_web = {

     

       27
       27
       +
                   bind_addr = "[::]:3902";

     

       28
       28
       +
                   root_domain = ".web.garage";

     

       29
       29
       +
                   index = "index.html";

     

       30
       30
       +
                 };

     

       31
       31
       +
               };

     

       32
       32
       +
             };

     

       33
       33
       +
             environment.systemPackages = [ pkgs.minio-client ];

     

       34
       34
       +
       

     

       35
       35
       +
             # Garage requires at least 1GiB of free disk space to run.

     

       36
       36
       +
             virtualisation.diskSize = 2 * 1024;

     

       37
       37
       +
           };

     

       38
       38
       +
       

     

       39
       39
       +
       

     

       40
       40
       +
       in {

     

       41
       41
       +
         name = "garage";

     

       42
       42
       +
         meta = {

     

       43
       43
       +
           maintainers = with pkgs.lib.maintainers; [ raitobezarius ];

     

       44
       44
       +
         };

     

       45
       45
       +
       

     

       46
       46
       +
         nodes = {

     

       47
       47
       +
           single_node = mkNode { replicationMode = "none"; };

     

       48
       48
       +
           node1 = mkNode { replicationMode = 3; publicV6Address = "fc00:1::1"; };

     

       49
       49
       +
           node2 = mkNode { replicationMode = 3; publicV6Address = "fc00:1::2"; };

     

       50
       50
       +
           node3 = mkNode { replicationMode = 3; publicV6Address = "fc00:1::3"; };

     

       51
       51
       +
           node4 = mkNode { replicationMode = 3; publicV6Address = "fc00:1::4"; };

     

       52
       52
       +
         };

     

       53
       53
       +
       

     

       54
       54
       +
         testScript = ''

     

       55
       55
       +
           from typing import List

     

       56
       56
       +
           from dataclasses import dataclass

     

       57
       57
       +
           import re

     

       58
       58
       +
           start_all()

     

       59
       59
       +
       

     

       60
       60
       +
           cur_version_regex = re.compile('Current cluster layout version: (?P<ver>\d*)')

     

       61
       61
       +
           key_creation_regex = re.compile('Key name: (?P<key_name>.*)\nKey ID: (?P<key_id>.*)\nSecret key: (?P<secret_key>.*)')

     

       62
       62
       +
       

     

       63
       63
       +
           @dataclass

     

       64
       64
       +
           class S3Key:

     

       65
       65
       +
              key_name: str

     

       66
       66
       +
              key_id: str

     

       67
       67
       +
              secret_key: str

     

       68
       68
       +
       

     

       69
       69
       +
           @dataclass

     

       70
       70
       +
           class GarageNode:

     

       71
       71
       +
              node_id: str

     

       72
       72
       +
              host: str

     

       73
       73
       +
       

     

       74
       74
       +
           def get_node_fqn(machine: Machine) -> GarageNode:

     

       75
       75
       +
             node_id, host = machine.succeed("garage node id").split('@')

     

       76
       76
       +
             return GarageNode(node_id=node_id, host=host)

     

       77
       77
       +
       

     

       78
       78
       +
           def get_node_id(machine: Machine) -> str:

     

       79
       79
       +
             return get_node_fqn(machine).node_id

     

       80
       80
       +
       

     

       81
       81
       +
           def get_layout_version(machine: Machine) -> int:

     

       82
       82
       +
             version_data = machine.succeed("garage layout show")

     

       83
       83
       +
             m = cur_version_regex.search(version_data)

     

       84
       84
       +
             if m and m.group('ver') is not None:

     

       85
       85
       +
               return int(m.group('ver')) + 1

     

       86
       86
       +
             else:

     

       87
       87
       +
               raise ValueError('Cannot find current layout version')

     

       88
       88
       +
       

     

       89
       89
       +
           def apply_garage_layout(machine: Machine, layouts: List[str]):

     

       90
       90
       +
              for layout in layouts:

     

       91
       91
       +
                 machine.succeed(f"garage layout assign {layout}")

     

       92
       92
       +
              version = get_layout_version(machine)

     

       93
       93
       +
              machine.succeed(f"garage layout apply --version {version}")

     

       94
       94
       +
       

     

       95
       95
       +
           def create_api_key(machine: Machine, key_name: str) -> S3Key:

     

       96
       96
       +
              output = machine.succeed(f"garage key new --name {key_name}")

     

       97
       97
       +
              m = key_creation_regex.match(output)

     

       98
       98
       +
              if not m or not m.group('key_id') or not m.group('secret_key'):

     

       99
       99
       +
                 raise ValueError('Cannot parse API key data')

     

       100
       100
       +
              return S3Key(key_name=key_name, key_id=m.group('key_id'), secret_key=m.group('secret_key'))

     

       101
       101
       +
       

     

       102
       102
       +
           def get_api_key(machine: Machine, key_pattern: str) -> S3Key:

     

       103
       103
       +
              output = machine.succeed(f"garage key info {key_pattern}")

     

       104
       104
       +
              m = key_creation_regex.match(output)

     

       105
       105
       +
              if not m or not m.group('key_name') or not m.group('key_id') or not m.group('secret_key'):

     

       106
       106
       +
                  raise ValueError('Cannot parse API key data')

     

       107
       107
       +
              return S3Key(key_name=m.group('key_name'), key_id=m.group('key_id'), secret_key=m.group('secret_key'))

     

       108
       108
       +
       

     

       109
       109
       +
           def test_bucket_writes(node):

     

       110
       110
       +
             node.succeed("garage bucket create test-bucket")

     

       111
       111
       +
             s3_key = create_api_key(node, "test-api-key")

     

       112
       112
       +
             node.succeed("garage bucket allow --read --write test-bucket --key test-api-key")

     

       113
       113
       +
             other_s3_key = get_api_key(node, 'test-api-key')

     

       114
       114
       +
             assert other_s3_key.secret_key == other_s3_key.secret_key

     

       115
       115
       +
             node.succeed(

     

       116
       116
       +
               f"mc alias set test-garage http://[::1]:3900 {s3_key.key_id} {s3_key.secret_key} --api S3v4"

     

       117
       117
       +
             )

     

       118
       118
       +
             node.succeed("echo test | mc pipe test-garage/test-bucket/test.txt")

     

       119
       119
       +
             assert node.succeed("mc cat test-garage/test-bucket/test.txt").strip() == "test"

     

       120
       120
       +
       

     

       121
       121
       +
           def test_bucket_over_http(node, bucket='test-bucket', url=None):

     

       122
       122
       +
             if url is None:

     

       123
       123
       +
                url = f"{bucket}.web.garage"

     

       124
       124
       +
       

     

       125
       125
       +
             node.succeed(f'garage bucket website --allow {bucket}')

     

       126
       126
       +
             node.succeed(f'echo hello world | mc pipe test-garage/{bucket}/index.html')

     

       127
       127
       +
             assert (node.succeed(f"curl -H 'Host: {url}' http://localhost:3902")).strip() == 'hello world'

     

       128
       128
       +
       

     

       129
       129
       +
           with subtest("Garage works as a single-node S3 storage"):

     

       130
       130
       +
             single_node.wait_for_unit("garage.service")

     

       131
       131
       +
             single_node.wait_for_open_port(3900)

     

       132
       132
       +
             # Now Garage is initialized.

     

       133
       133
       +
             single_node_id = get_node_id(single_node)

     

       134
       134
       +
             apply_garage_layout(single_node, [f'-z qemutest -c 1 "{single_node_id}"'])

     

       135
       135
       +
             # Now Garage is operational.

     

       136
       136
       +
             test_bucket_writes(single_node)

     

       137
       137
       +
             test_bucket_over_http(single_node)

     

       138
       138
       +
       

     

       139
       139
       +
           with subtest("Garage works as a multi-node S3 storage"):

     

       140
       140
       +
             nodes = ('node1', 'node2', 'node3', 'node4')

     

       141
       141
       +
             rev_machines = {m.name: m for m in machines}

     

       142
       142
       +
             def get_machine(key): return rev_machines[key]

     

       143
       143
       +
             for key in nodes:

     

       144
       144
       +
               node = get_machine(key)

     

       145
       145
       +
               node.wait_for_unit("garage.service")

     

       146
       146
       +
               node.wait_for_open_port(3900)

     

       147
       147
       +
       

     

       148
       148
       +
             # Garage is initialized on all nodes.

     

       149
       149
       +
             node_ids = {key: get_node_fqn(get_machine(key)) for key in nodes}

     

       150
       150
       +
       

     

       151
       151
       +
             for key in nodes:

     

       152
       152
       +
               for other_key in nodes:

     

       153
       153
       +
                 if other_key != key:

     

       154
       154
       +
                   other_id = node_ids[other_key]

     

       155
       155
       +
                   get_machine(key).succeed(f"garage node connect {other_id.node_id}@{other_id.host}")

     

       156
       156
       +
       

     

       157
       157
       +
             # Provide multiple zones for the nodes.

     

       158
       158
       +
             zones = ["nixcon", "nixcon", "paris_meetup", "fosdem"]

     

       159
       159
       +
             apply_garage_layout(node1,

     

       160
       160
       +
             [

     

       161
       161
       +
               f'{ndata.node_id} -z {zones[index]} -c 1'

     

       162
       162
       +
               for index, ndata in enumerate(node_ids.values())

     

       163
       163
       +
             ])

     

       164
       164
       +
             # Now Garage is operational.

     

       165
       165
       +
             test_bucket_writes(node1)

     

       166
       166
       +
             for node in nodes:

     

       167
       167
       +
                test_bucket_over_http(get_machine(node))

     

       168
       168
       +
         '';

     

       169
       169
       +
       })