Merge pull request 'Add TLS support for Consul discovery + refactoring' (#405) from consul-tls into main

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/405

.drone.yml

@@ -19,9 +19,11 @@ steps:
   - name: unit + func tests
     image: nixpkgs/nix:nixos-22.05
     environment:
-      GARAGE_TEST_INTEGRATION_EXE: result/bin/garage
+      GARAGE_TEST_INTEGRATION_EXE: result-bin/bin/garage
     commands:
+      - nix-build --no-build-output --attr clippy.amd64 --argstr git_version ${DRONE_TAG:-$DRONE_COMMIT}
       - nix-build --no-build-output --attr test.amd64
+      - ./result/bin/garage_db-*
       - ./result/bin/garage_api-*
       - ./result/bin/garage_model-*
       - ./result/bin/garage_rpc-*
@@ -30,6 +32,7 @@ steps:
       - ./result/bin/garage_web-*
       - ./result/bin/garage-*
       - ./result/bin/integration-*
+      - rm result
 
   - name: integration tests
     image: nixpkgs/nix:nixos-22.05
@@ -58,7 +61,7 @@ steps:
     image: nixpkgs/nix:nixos-22.05
     commands:
       - nix-build --no-build-output --attr pkgs.amd64.release --argstr git_version ${DRONE_TAG:-$DRONE_COMMIT}
-      - nix-shell --attr rust --run "./script/not-dynamic.sh result/bin/garage"
+      - nix-shell --attr rust --run "./script/not-dynamic.sh result-bin/bin/garage"
 
   - name: integration
     image: nixpkgs/nix:nixos-22.05
@@ -109,7 +112,7 @@ steps:
     image: nixpkgs/nix:nixos-22.05
     commands:
       - nix-build --no-build-output --attr pkgs.i386.release --argstr git_version ${DRONE_TAG:-$DRONE_COMMIT}
-      - nix-shell --attr rust --run "./script/not-dynamic.sh result/bin/garage"
+      - nix-shell --attr rust --run "./script/not-dynamic.sh result-bin/bin/garage"
 
   - name: integration
     image: nixpkgs/nix:nixos-22.05
@@ -159,7 +162,7 @@ steps:
     image: nixpkgs/nix:nixos-22.05
     commands:
       - nix-build --no-build-output --attr pkgs.arm64.release --argstr git_version ${DRONE_TAG:-$DRONE_COMMIT}
-      - nix-shell --attr rust --run "./script/not-dynamic.sh result/bin/garage"
+      - nix-shell --attr rust --run "./script/not-dynamic.sh result-bin/bin/garage"
 
   - name: push static binary
     image: nixpkgs/nix:nixos-22.05
@@ -204,7 +207,7 @@ steps:
     image: nixpkgs/nix:nixos-22.05
     commands:
       - nix-build --no-build-output --attr pkgs.arm.release --argstr git_version ${DRONE_TAG:-$DRONE_COMMIT}
-      - nix-shell --attr rust --run "./script/not-dynamic.sh result/bin/garage"
+      - nix-shell --attr rust --run "./script/not-dynamic.sh result-bin/bin/garage"
 
   - name: push static binary
     image: nixpkgs/nix:nixos-22.05
@@ -245,6 +248,17 @@ node:
   nix-daemon: 1
 
 steps:
+  - name: multiarch-docker
+    image: nixpkgs/nix:nixos-22.05
+    environment:
+      DOCKER_AUTH:
+        from_secret: docker_auth
+      HOME: "/root"
+    commands:
+      - mkdir -p /root/.docker
+      - echo $DOCKER_AUTH > /root/.docker/config.json
+      - export CONTAINER_TAG=${DRONE_TAG:-$DRONE_COMMIT}
+      - nix-shell --attr release --run "multiarch_docker"
   - name: refresh-index
     image: nixpkgs/nix:nixos-22.05
     environment:
@@ -269,6 +283,6 @@ trigger:
 
 ---
 kind: signature
-hmac: 362639b4c9541ad9bd06ff7f72b5235b2b0216bcb16eececd25285b6fe94ba6f
+hmac: ac09a5a8c82502f67271f93afa1e1e21ce66383b8e24a6deb26b285cc1c378ba
 
 ...

Dockerfile

@@ -3,5 +3,5 @@ FROM scratch
 ENV RUST_BACKTRACE=1
 ENV RUST_LOG=garage=info
 
-COPY result/bin/garage /
+COPY result-bin/bin/garage /
 CMD [ "/garage", "server"]

default.nix

@@ -5,13 +5,26 @@
 
 with import ./nix/common.nix;
 
-let 
+let
   pkgs = import pkgsSrc { };
   compile = import ./nix/compile.nix;
+
   build_debug_and_release = (target: {
-    debug = (compile { inherit target git_version; release = false; }).workspace.garage { compileMode = "build"; }; 
-    release = (compile { inherit target git_version; release = true; }).workspace.garage { compileMode = "build"; }; 
+    debug = (compile {
+      inherit target git_version;
+      release = false;
+    }).workspace.garage {
+      compileMode = "build";
+    };
+
+    release = (compile {
+      inherit target git_version;
+      release = true;
+    }).workspace.garage {
+      compileMode = "build";
+    };
   });
+
   test = (rustPkgs: pkgs.symlinkJoin {
     name ="garage-tests";
     paths = builtins.map (key: rustPkgs.workspace.${key} { compileMode = "test"; }) (builtins.attrNames rustPkgs.workspace);
@@ -25,9 +38,25 @@ in {
     arm = build_debug_and_release "armv6l-unknown-linux-musleabihf";
   };
   test = {
-    amd64 = test (compile { inherit git_version; target = "x86_64-unknown-linux-musl"; });
+    amd64 = test (compile {
+      inherit git_version;
+      target = "x86_64-unknown-linux-musl";
+      features = [
+        "garage/bundled-libs"
+        "garage/k2v"
+        "garage/sled"
+        "garage/lmdb"
+        "garage/sqlite"
+      ];
+    });
   };
   clippy = {
-    amd64 = (compile { inherit git_version; compiler = "clippy"; }).workspace.garage { compileMode = "build"; } ;
+    amd64 = (compile {
+      inherit git_version;
+      target = "x86_64-unknown-linux-musl";
+      compiler = "clippy";
+    }).workspace.garage {
+      compileMode = "build";
+    };
   };
 }

doc/book/cookbook/kubernetes.md

@@ -0,0 +1,87 @@
++++
+title = "Deploying on Kubernetes"
+weight = 32
++++
+
+Garage can also be deployed on a kubernetes cluster via helm chart.
+
+## Deploying
+
+Firstly clone the repository:
+
+```bash
+git clone https://git.deuxfleurs.fr/Deuxfleurs/garage
+cd garage/scripts/helm
+```
+
+Deploy with default options:
+
+```bash
+helm install --create-namespace --namespace garage garage ./garage
+```
+
+Or deploy with custom values:
+
+```bash
+helm install --create-namespace --namespace garage garage ./garage -f values.override.yaml
+```
+
+After deploying, cluster layout must be configured manually as described in [Creating a cluster layout](@/documentation/quick-start/_index.md#creating-a-cluster-layout). Use the following command to access garage CLI:
+
+```bash
+kubectl exec --stdin --tty -n garage garage-0 -- ./garage status
+```
+
+## Overriding default values
+
+All possible configuration values can be found with:
+
+```bash
+helm show values ./garage
+```
+
+This is an example `values.overrride.yaml` for deploying in a microk8s cluster with a https s3 api ingress route:
+
+```yaml
+garage:
+  # Use only 2 replicas per object
+  replicationMode: "2"
+
+# Start 4 instances (StatefulSets) of garage
+replicaCount: 4
+
+# Override default storage class and size
+persistence:
+  meta:
+    storageClass: "openebs-hostpath"
+    size: 100Mi
+  data:
+    storageClass: "openebs-hostpath"
+    size: 1Gi
+
+ingress:
+  s3:
+    api:
+      enabled: true
+      className: "public"
+      annotations:
+        cert-manager.io/cluster-issuer: "letsencrypt-prod"
+        nginx.ingress.kubernetes.io/proxy-body-size: 500m
+      hosts:
+        - host: s3-api.my-domain.com
+          paths:
+            - path: /
+              pathType: Prefix
+      tls:
+        - secretName: garage-ingress-cert
+          hosts:
+            - s3-api.my-domain.com
+```
+
+## Removing
+
+```bash
+helm delete --namespace garage garage
+```
+
+Note that this will leave behind custom CRD `garagenodes.deuxfleurs.fr`, which must be removed manually if desired.

doc/book/cookbook/real-world.md

@@ -51,15 +51,15 @@ to store 2 TB of data in total.
 
 ## Get a Docker image
 
-Our docker image is currently named `dxflrs/amd64_garage` and is stored on the [Docker Hub](https://hub.docker.com/r/dxflrs/amd64_garage/tags?page=1&ordering=last_updated).
-We encourage you to use a fixed tag (eg. `v0.4.0`) and not the `latest` tag.
-For this example, we will use the latest published version at the time of the writing which is `v0.4.0` but it's up to you
-to check [the most recent versions on the Docker Hub](https://hub.docker.com/r/dxflrs/amd64_garage/tags?page=1&ordering=last_updated).
+Our docker image is currently named `dxflrs/garage` and is stored on the [Docker Hub](https://hub.docker.com/r/dxflrs/garage/tags?page=1&ordering=last_updated).
+We encourage you to use a fixed tag (eg. `v0.8.0`) and not the `latest` tag.
+For this example, we will use the latest published version at the time of the writing which is `v0.8.0` but it's up to you
+to check [the most recent versions on the Docker Hub](https://hub.docker.com/r/dxflrs/garage/tags?page=1&ordering=last_updated).
 
 For example:
 
 ```
-sudo docker pull dxflrs/amd64_garage:v0.4.0
+sudo docker pull dxflrs/garage:v0.8.0
 ```
 
 ## Deploying and configuring Garage
@@ -125,7 +125,7 @@ docker run \
   -v /etc/garage.toml:/etc/garage.toml \
   -v /var/lib/garage/meta:/var/lib/garage/meta \
   -v /var/lib/garage/data:/var/lib/garage/data \
-  lxpz/garage_amd64:v0.4.0
+  dxflrs/garage:v0.8.0
 ```
 
 It should be restarted automatically at each reboot.

doc/book/reference-manual/configuration.md

@@ -9,8 +9,13 @@ Here is an example `garage.toml` configuration file that illustrates all of the
 metadata_dir = "/var/lib/garage/meta"
 data_dir = "/var/lib/garage/data"
 
+db_engine = "lmdb"
+
 block_size = 1048576
 
+sled_cache_capacity = 134217728
+sled_flush_every_ms = 2000
+
 replication_mode = "3"
 
 compression_level = 1
@@ -26,15 +31,20 @@ bootstrap_peers = [
     "212fd62eeaca72c122b45a7f4fa0f55e012aa5e24ac384a72a3016413fa724ff@[fc00:F::1]:3901",
 ]
 
-consul_host = "consul.service"
-consul_service_name = "garage-daemon"
 
-kubernetes_namespace = "garage"
-kubernetes_service_name = "garage-daemon"
-kubernetes_skip_crd = false
+[consul_discovery]
+consul_http_addr = "http://127.0.0.1:8500"
+service_name = "garage-daemon"
+ca_cert = "/etc/consul/consul-ca.crt"
+client_cert = "/etc/consul/consul-client.crt"
+client_key = "/etc/consul/consul-key.crt"
+tls_skip_verify = false
+
+[kubernetes_discovery]
+namespace = "garage"
+service_name = "garage-daemon"
+skip_crd = false
 
-sled_cache_capacity = 134217728
-sled_flush_every_ms = 2000
 
 [s3_api]
 api_bind_addr = "[::]:3900"
@@ -71,6 +81,47 @@ This folder can be placed on an HDD. The space available for `data_dir`
 should be counted to determine a node's capacity
 when [adding it to the cluster layout](@/documentation/cookbook/real-world.md).
 
+### `db_engine` (since `v0.8.0`)
+
+By default, Garage uses the Sled embedded database library
+to store its metadata on-disk. Since `v0.8.0`, Garage can use alternative storage backends as follows:
+
+| DB engine | `db_engine` value | Database path |
+| --------- | ----------------- | ------------- |
+| [Sled](https://sled.rs) | `"sled"` | `<metadata_dir>/db/` |
+| [LMDB](https://www.lmdb.tech) | `"lmdb"` | `<metadata_dir>/db.lmdb/` |
+| [Sqlite](https://sqlite.org) | `"sqlite"` | `<metadata_dir>/db.sqlite` |
+
+Performance characteristics of the different DB engines are as follows:
+
+- Sled: the default database engine, which tends to produce
+  large data files and also has performance issues, especially when the metadata folder
+  is on a traditionnal HDD and not on SSD.
+- LMDB: the recommended alternative on 64-bit systems,
+  much more space-efficiant and slightly faster. Note that the data format of LMDB is not portable
+  between architectures, so for instance the Garage database of an x86-64
+  node cannot be moved to an ARM64 node. Also note that, while LMDB can technically be used on 32-bit systems,
+  this will limit your node to very small database sizes due to how LMDB works; it is therefore not recommended.
+- Sqlite: Garage supports Sqlite as a storage backend for metadata,
+  however it may have issues and is also very slow in its current implementation,
+  so it is not recommended to be used for now.
+
+It is possible to convert Garage's metadata directory from one format to another with a small utility named `convert_db`,
+which can be downloaded at the following locations:
+[for amd64](https://garagehq.deuxfleurs.fr/_releases/convert_db/amd64/convert_db),
+[for i386](https://garagehq.deuxfleurs.fr/_releases/convert_db/i386/convert_db),
+[for arm64](https://garagehq.deuxfleurs.fr/_releases/convert_db/arm64/convert_db),
+[for arm](https://garagehq.deuxfleurs.fr/_releases/convert_db/arm/convert_db).
+The `convert_db` utility is used as folows:
+
+```
+convert-db -a <input db engine> -i <input db path> \
+  		   -b <output db engine> -o <output db path>
+```
+
+Make sure to specify the full database path as presented in the table above,
+and not just the path to the metadata directory.
+
 ### `block_size`
 
 Garage splits stored objects in consecutive chunks of size `block_size`
@@ -86,6 +137,21 @@ files will remain available. This however means that chunks from existing files
 will not be deduplicated with chunks from newly uploaded files, meaning you
 might use more storage space that is optimally possible.
 
+### `sled_cache_capacity`
+
+This parameter can be used to tune the capacity of the cache used by
+[sled](https://sled.rs), the database Garage uses internally to store metadata.
+Tune this to fit the RAM you wish to make available to your Garage instance.
+This value has a conservative default (128MB) so that Garage doesn't use too much
+RAM by default, but feel free to increase this for higher performance.
+
+### `sled_flush_every_ms`
+
+This parameters can be used to tune the flushing interval of sled.
+Increase this if sled is thrashing your SSD, at the risk of losing more data in case
+of a power outage (though this should not matter much as data is replicated on other
+nodes). The default value, 2000ms, should be appropriate for most use cases.
+
 ### `replication_mode`
 
 Garage supports the following replication modes:
@@ -233,48 +299,58 @@ be obtained by running `garage node id` and then included directly in the
 key will be returned by `garage node id` and you will have to add the IP
 yourself.
 
-### `consul_host` and `consul_service_name`
+
+## The `[consul_discovery]` section
 
 Garage supports discovering other nodes of the cluster using Consul.  For this
 to work correctly, nodes need to know their IP address by which they can be
 reached by other nodes of the cluster, which should be set in `rpc_public_addr`.
 
-The `consul_host` parameter should be set to the hostname of the Consul server,
-and `consul_service_name` should be set to the service name under which Garage's
+### `consul_http_addr` and `service_name`
+
+The `consul_http_addr` parameter should be set to the full HTTP(S) address of the Consul server.
+
+### `service_name`
+
+`service_name` should be set to the service name under which Garage's
 RPC ports are announced.
 
-Garage does not yet support talking to Consul over TLS.
+### `client_cert`, `client_key`
 
-### `kubernetes_namespace`, `kubernetes_service_name` and `kubernetes_skip_crd`
+TLS client certificate and client key to use when communicating with Consul over TLS. Both are mandatory when doing so.
+
+### `ca_cert`
+
+TLS CA certificate to use when communicating with Consul over TLS.
+
+### `tls_skip_verify`
+
+Skip server hostname verification in TLS handshake.
+`ca_cert` is ignored when this is set.
+
+
+## The `[kubernetes_discovery]` section
 
 Garage supports discovering other nodes of the cluster using kubernetes custom
-resources. For this to work `kubernetes_namespace` and `kubernetes_service_name`
-need to be configured.
+resources. For this to work, a `[kubernetes_discovery]` section must be present
+with at least the `namespace` and `service_name` parameters.
 
-`kubernetes_namespace` sets the namespace in which the custom resources are
-configured. `kubernetes_service_name` is added as a label to these resources to
+### `namespace`
+
+`namespace` sets the namespace in which the custom resources are
+configured.
+
+### `service_name`
+
+`service_name` is added as a label to the advertised resources to
 filter them, to allow for multiple deployments in a single namespace.
 
-`kubernetes_skip_crd` can be set to true to disable the automatic creation and
+### `skip_crd`
+
+`skip_crd` can be set to true to disable the automatic creation and
 patching of the `garagenodes.deuxfleurs.fr` CRD. You will need to create the CRD
 manually.
 
-### `sled_cache_capacity`
-
-This parameter can be used to tune the capacity of the cache used by
-[sled](https://sled.rs), the database Garage uses internally to store metadata.
-Tune this to fit the RAM you wish to make available to your Garage instance.
-This value has a conservative default (128MB) so that Garage doesn't use too much
-RAM by default, but feel free to increase this for higher performance.
-
-### `sled_flush_every_ms`
-
-This parameters can be used to tune the flushing interval of sled.
-Increase this if sled is thrashing your SSD, at the risk of losing more data in case
-of a power outage (though this should not matter much as data is replicated on other
-nodes). The default value, 2000ms, should be appropriate for most use cases.
-
-
 
 ## The `[s3_api]` section
 

doc/book/reference-manual/features.md

@@ -106,7 +106,7 @@ to be manually connected to one another.
 
 ### Support for changing IP addresses
 
-As long as all of your nodes don't thange their IP address at the same time,
+As long as all of your nodes don't change their IP address at the same time,
 Garage should be able to tolerate nodes with changing/dynamic IP addresses,
 as nodes will regularly exchange the IP addresses of their peers and try to
 reconnect using newer addresses when existing connections are broken.

doc/book/working-documents/migration-07.md

@@ -16,7 +16,7 @@ The migration steps are as follows:
 1. Do `garage repair --all-nodes --yes tables` and `garage repair --all-nodes --yes blocks`,
    check the logs and check that all data seems to be synced correctly between
    nodes. If you have time, do additional checks (`scrub`, `block_refs`, etc.)
-2. Disable api and web access. Garage does not support disabling
+2. Disable API and web access. Garage does not support disabling
    these endpoints but you can change the port number or stop your reverse
    proxy for instance.
 3. Check once again that your cluster is healty. Run again `garage repair --all-nodes --yes tables` which is quick.

doc/book/working-documents/migration-08.md

@@ -0,0 +1,34 @@
++++
+title = "Migrating from 0.7 to 0.8"
+weight = 13
++++
+
+**This guide explains how to migrate to 0.8 if you have an existing 0.7 cluster.
+We don't recommend trying to migrate to 0.8 directly from 0.6 or older.**
+
+**We make no guarantee that this migration will work perfectly:
+back up all your data before attempting it!**
+
+Garage v0.8 introduces new data tables that allow the counting of objects in buckets in order to implement bucket quotas.
+A manual migration step is required to first count objects in Garage buckets and populate these tables with accurate data.
+
+The migration steps are as follows:
+
+1. Disable API and web access. Garage v0.7 does not support disabling
+   these endpoints but you can change the port number or stop your reverse proxy for instance.
+2. Do `garage repair --all-nodes --yes tables` and `garage repair --all-nodes --yes blocks`,
+   check the logs and check that all data seems to be synced correctly between
+   nodes. If you have time, do additional checks (`scrub`, `block_refs`, etc.)
+3. Check that queues are empty: run `garage stats` to query them or inspect metrics in the Grafana dashboard.
+4. Turn off Garage v0.7
+5. **Backup the metadata folder of all your nodes!** For instance, use the following command
+	if your metadata directory is `/var/lib/garage/meta`: `cd /var/lib/garage ; tar -acf meta-v0.7.tar.zst meta/`
+6. Install Garage v0.8
+7. **Before starting Garage v0.8**, run the offline migration step: `garage offline-repair --yes object_counters`.
+   This can take a while to run, depending on the number of objects stored in your cluster.
+8. Turn on Garage v0.8
+9. Do `garage repair --all-nodes --yes tables` and `garage repair --all-nodes --yes blocks`.
+   Wait for a full table sync to run.
+10. Your upgraded cluster should be in a working state. Re-enable API and Web
+    access and check that everything went well.
+11. Monitor your cluster in the next hours to see if it works well under your production load, report any issue.

doc/drafts/k2v-spec.md

@@ -206,8 +206,8 @@ and responses need to be translated.
 
 Query parameters:
 
-| name | default value | meaning |
-| - | - | - |
+| name       | default value | meaning                          |
+|------------|---------------|----------------------------------|
 | `sort_key` | **mandatory** | The sort key of the item to read |
 
 Returns the item with specified partition key and sort key. Values can be
@@ -317,11 +317,11 @@ an HTTP 304 NOT MODIFIED is returned.
 
 Query parameters:
 
-| name | default value | meaning |
-| - | - | - |
-| `sort_key` | **mandatory** | The sort key of the item to read |
-| `causality_token` | **mandatory** | The causality token of the last known value or set of values |
-| `timeout` | 300 | The timeout before 304 NOT MODIFIED is returned if the value isn't updated |
+| name              | default value | meaning                                                                    |
+|-------------------|---------------|----------------------------------------------------------------------------|
+| `sort_key`        | **mandatory** | The sort key of the item to read                                           |
+| `causality_token` | **mandatory** | The causality token of the last known value or set of values               |
+| `timeout`         | 300           | The timeout before 304 NOT MODIFIED is returned if the value isn't updated |
 
 The timeout can be set to any number of seconds, with a maximum of 600 seconds (10 minutes).
 
@@ -346,7 +346,7 @@ myblobblahblahblah
 Example response:
 
 ```
-HTTP/1.1 200 OK
+HTTP/1.1 204 No Content
 ```
 
 **DeleteItem: `DELETE /<bucket>/<partition key>?sort_key=<sort_key>`**
@@ -382,13 +382,13 @@ as these values are asynchronously updated, and thus eventually consistent.
 
 Query parameters:
 
-| name | default value | meaning |
-| - | - | - |
-| `prefix` | `null` | Restrict listing to partition keys that start with this prefix |
-| `start` | `null` | First partition key to list, in lexicographical order |
-| `end` | `null` | Last partition key to list (excluded) |
-| `limit` | `null` | Maximum number of partition keys to list |
-| `reverse` | `false` | Iterate in reverse lexicographical order |
+| name      | default value | meaning                                                        |
+|-----------|---------------|----------------------------------------------------------------|
+| `prefix`  | `null`        | Restrict listing to partition keys that start with this prefix |
+| `start`   | `null`        | First partition key to list, in lexicographical order          |
+| `end`     | `null`        | Last partition key to list (excluded)                          |
+| `limit`   | `null`        | Maximum number of partition keys to list                       |
+| `reverse` | `false`       | Iterate in reverse lexicographical order                       |
 
 The response consists in a JSON object that repeats the parameters of the query and gives the result (see below).
 
@@ -512,7 +512,7 @@ POST /my_bucket HTTP/1.1
 Example response:
 
 ```
-HTTP/1.1 200 OK
+HTTP/1.1 204 NO CONTENT
 ```
 
 
@@ -525,17 +525,17 @@ The request body is a JSON list of searches, that each specify a range of
 items to get (to get single items, set `singleItem` to `true`). A search is a
 JSON struct with the following fields:
 
-| name | default value | meaning |
-| - | - | - |
-| `partitionKey` | **mandatory** | The partition key in which to search |
-| `prefix` | `null` | Restrict items to list to those whose sort keys start with this prefix |
-| `start` | `null` | The sort key of the first item to read |
-| `end` | `null` | The sort key of the last item to read (excluded) |
-| `limit` | `null` | The maximum number of items to return |
-| `reverse` | `false` | Iterate in reverse lexicographical order on sort keys |
-| `singleItem` | `false` | Whether to return only the item with sort key `start` |
-| `conflictsOnly` | `false` | Whether to return only items that have several concurrent values |
-| `tombstones` | `false` | Whether or not to return tombstone lines to indicate the presence of old deleted items |
+| name            | default value | meaning                                                                                |
+|-----------------|---------------|----------------------------------------------------------------------------------------|
+| `partitionKey`  | **mandatory** | The partition key in which to search                                                   |
+| `prefix`        | `null`        | Restrict items to list to those whose sort keys start with this prefix                 |
+| `start`         | `null`        | The sort key of the first item to read                                                 |
+| `end`           | `null`        | The sort key of the last item to read (excluded)                                       |
+| `limit`         | `null`        | The maximum number of items to return                                                  |
+| `reverse`       | `false`       | Iterate in reverse lexicographical order on sort keys                                  |
+| `singleItem`    | `false`       | Whether to return only the item with sort key `start`                                  |
+| `conflictsOnly` | `false`       | Whether to return only items that have several concurrent values                       |
+| `tombstones`    | `false`       | Whether or not to return tombstone lines to indicate the presence of old deleted items |
 
 
 For each of the searches, triplets are listed and returned separately. The
@@ -683,7 +683,7 @@ POST /my_bucket?delete HTTP/1.1
 
 Example response:
 
-```
+```json
 HTTP/1.1 200 OK
 
 [

nix/common.nix

@@ -3,20 +3,20 @@ rec {
    * Fixed dependencies
    */
   pkgsSrc = fetchTarball {
-    # As of 2021-10-04
-    url = "https://github.com/NixOS/nixpkgs/archive/b27d18a412b071f5d7991d1648cfe78ee7afe68a.tar.gz";
-    sha256 = "1xy9zpypqfxs5gcq5dcla4bfkhxmh5nzn9dyqkr03lqycm9wg5cr";
+    # As of 2022-10-13
+    url = "https://github.com/NixOS/nixpkgs/archive/a3073c49bc0163fea6a121c276f526837672b555.zip";
+    sha256 = "1bz632psfbpmicyzjb8b4265y50shylccvfm6ry6mgnv5hvz324s";
   };
   cargo2nixSrc = fetchGit {
-    # As of 2022-08-29, stacking two patches: superboum@dedup_propagate and Alexis211@fix_fetchcrategit
+    # As of 2022-10-18: two small patches over unstable branch, one for clippy and one to fix feature detection
     url = "https://github.com/Alexis211/cargo2nix";
-    ref = "fix_fetchcrategit";
-    rev = "4b31c0cc05b6394916d46e9289f51263d81973b9";
+    ref = "custom_unstable";
+    rev = "a7a61179b66054904ef6a195d8da736eaaa06c36";
   };
 
   /*
    * Shared objects
    */
   cargo2nix = import cargo2nixSrc;
-  cargo2nixOverlay = import "${cargo2nixSrc}/overlay";
+  cargo2nixOverlay = cargo2nix.overlays.default;
 }

nix/compile.nix

@@ -1,9 +1,10 @@
 {
   system ? builtins.currentSystem,
-  target ? null,
+  target,
   compiler ? "rustc",
   release ? false,
   git_version ? null,
+  features ? null,
 }:
 
 with import ./common.nix;
@@ -12,71 +13,41 @@ let
   log = v: builtins.trace v v;
 
   pkgs = import pkgsSrc {
-    inherit system; 
-    ${ if target == null then null else "crossSystem" } = { config = target; };
+    inherit system;
+    crossSystem = {
+      config = target;
+      isStatic = true;
+    };
     overlays = [ cargo2nixOverlay ];
   };
 
-  /*
-   Rust and Nix triples are not the same. Cargo2nix has a dedicated library
-   to convert Nix triples to Rust ones. We need this conversion as we want to
-   set later options linked to our (rust) target in a generic way. Not only
-   the triple terminology is different, but also the "roles" are named differently.
-   Nix uses a build/host/target terminology where Nix's "host" maps to Cargo's "target".
-  */
-  rustTarget = log (pkgs.rustBuilder.rustLib.rustTriple pkgs.stdenv.hostPlatform);
-
   /*
    Cargo2nix is built for rustOverlay which installs Rust from Mozilla releases.
-   We want our own Rust to avoid incompatibilities, like we had with musl 1.2.0.
-   rustc was built with musl < 1.2.0 and nix shipped musl >= 1.2.0 which lead to compilation breakage.
+   This is fine for 64-bit platforms, but for 32-bit platforms, we need our own Rust
+   to avoid incompatibilities with time_t between different versions of musl
+   (>= 1.2.0 shipped by NixOS, < 1.2.0 with which rustc was built), which lead to compilation breakage.
    So we want a Rust release that is bound to our Nix repository to avoid these problems.
    See here for more info: https://musl.libc.org/time64.html
    Because Cargo2nix does not support the Rust environment shipped by NixOS,
    we emulate the structure of the Rust object created by rustOverlay.
    In practise, rustOverlay ships rustc+cargo in a single derivation while
    NixOS ships them in separate ones. We reunite them with symlinkJoin.
-   */
-  rustChannel = {
-    rustc = pkgs.symlinkJoin {
-      name = "rust-channel";
-      paths = [ 
-        pkgs.rustPlatform.rust.cargo
-        pkgs.rustPlatform.rust.rustc
-      ];
+  */
+  toolchainOptions =
+    if target == "x86_64-unknown-linux-musl" || target == "aarch64-unknown-linux-musl" then {
+      rustVersion = "1.63.0";
+      extraRustComponents = [ "clippy" ];
+    } else {
+      rustToolchain = pkgs.symlinkJoin {
+        name = "rust-static-toolchain-${target}";
+        paths = [
+          pkgs.rustPlatform.rust.cargo
+          pkgs.rustPlatform.rust.rustc
+          # clippy not needed, it only runs on amd64
+        ];
+      };
     };
-    clippy = pkgs.symlinkJoin {
-      name = "clippy-channel";
-      paths = [ 
-        pkgs.rustPlatform.rust.cargo
-        pkgs.rustPlatform.rust.rustc
-        pkgs.clippy
-      ];
-    };
-  }.${compiler};
 
-  clippyBuilder = pkgs.writeScriptBin "clippy" ''
-    #!${pkgs.stdenv.shell}
-    . ${cargo2nixSrc + "/overlay/utils.sh"}
-    isBuildScript=
-    args=("$@")
-    for i in "''${!args[@]}"; do
-      if [ "xmetadata=" = "x''${args[$i]::9}" ]; then
-        args[$i]=metadata=$NIX_RUST_METADATA
-      elif [ "x--crate-name" = "x''${args[$i]}" ] && [ "xbuild_script_" = "x''${args[$i+1]::13}" ]; then
-        isBuildScript=1
-      fi
-    done
-    if [ "$isBuildScript" ]; then
-      args+=($NIX_RUST_BUILD_LINK_FLAGS)
-    else
-      args+=($NIX_RUST_LINK_FLAGS)
-    fi
-    touch invoke.log
-    echo "''${args[@]}" >>invoke.log
-
-    exec ${rustChannel}/bin/clippy-driver --deny warnings "''${args[@]}"
-  '';
 
   buildEnv = (drv: {
     rustc = drv.setBuildEnv;
@@ -84,9 +55,10 @@ let
       ${drv.setBuildEnv or "" }
       echo
       echo --- BUILDING WITH CLIPPY ---
-      echo 
+      echo
 
-      export RUSTC=${clippyBuilder}/bin/clippy
+      export NIX_RUST_BUILD_FLAGS="''${NIX_RUST_BUILD_FLAGS} --deny warnings"
+      export RUSTC="''${CLIPPY_DRIVER}"
     '';
   }.${compiler});
 
@@ -97,7 +69,7 @@ let
    You can have a complete list of the available options by looking at the overriden object, mkcrate:
    https://github.com/cargo2nix/cargo2nix/blob/master/overlay/mkcrate.nix
   */
-  overrides = pkgs.rustBuilder.overrides.all ++ [
+  packageOverrides = pkgs: pkgs.rustBuilder.overrides.all ++ [
     /*
      [1] We add some logic to compile our crates with clippy, it provides us many additional lints
 
@@ -113,12 +85,7 @@ let
      As we do not want to consider the .git folder as part of the input source,
      we ask the user (the CI often) to pass the value to Nix.
 
-     [4] We ship some parts of the code disabled by default by putting them behind a flag.
-     It speeds up the compilation (when the feature is not required) and released crates have less dependency by default (less attack surface, disk space, etc.).
-     But we want to ship these additional features when we release Garage.
-     In the end, we chose to exclude all features from debug builds while putting (all of) them in the release builds.
-
-     [5] We don't want libsodium-sys and zstd-sys to try to use pkgconfig to build against a system library.
+     [4] We don't want libsodium-sys and zstd-sys to try to use pkgconfig to build against a system library.
      However the features to do so get activated for some reason (due to a bug in cargo2nix?),
      so disable them manually here.
     */
@@ -136,10 +103,6 @@ let
         /* [1] */ setBuildEnv = (buildEnv drv);
         /* [2] */ hardeningDisable = [ "pie" ];
       };
-      overrideArgs = old: {
-        /* [4] */ features = [ "bundled-libs" "sled" "metrics" ]
-          ++ (if release then [ "kubernetes-discovery" "telemetry-otlp" "lmdb" "sqlite" ] else []);
-      };
     })
 
     (pkgs.rustBuilder.rustLib.makeOverride {
@@ -190,18 +153,39 @@ let
     (pkgs.rustBuilder.rustLib.makeOverride {
       name = "libsodium-sys";
       overrideArgs = old: {
-        features = [ ]; /* [5] */
+        features = [ ]; /* [4] */
       };
     })
 
     (pkgs.rustBuilder.rustLib.makeOverride {
       name = "zstd-sys";
       overrideArgs = old: {
-        features = [ ]; /* [5] */
+        features = [ ]; /* [4] */
       };
     })
   ];
 
+  /*
+    We ship some parts of the code disabled by default by putting them behind a flag.
+    It speeds up the compilation (when the feature is not required) and released crates have less dependency by default (less attack surface, disk space, etc.).
+    But we want to ship these additional features when we release Garage.
+    In the end, we chose to exclude all features from debug builds while putting (all of) them in the release builds.
+  */
+  rootFeatures = if features != null then features else
+     ([
+       "garage/bundled-libs"
+       "garage/sled"
+       "garage/k2v"
+     ] ++ (if release then [
+       "garage/consul-discovery"
+       "garage/kubernetes-discovery"
+       "garage/metrics"
+       "garage/telemetry-otlp"
+       "garage/lmdb"
+       "garage/sqlite"
+     ] else []));
+
+
   packageFun = import ../Cargo.nix;
 
   /*
@@ -222,23 +206,15 @@ let
    "x86_64-unknown-linux-musl" = [ "target-feature=+crt-static" "link-arg=-static-pie" ];
   };
 
-in
   /*
-   The following definition is not elegant as we use a low level function of Cargo2nix
-   that enables us to pass our custom rustChannel object. We need this low level definition
-   to pass Nix's Rust toolchains instead of Mozilla's one.
+    NixOS and Rust/Cargo triples do not match for ARM, fix it here.
+  */
+  rustTarget = if target == "armv6l-unknown-linux-musleabihf"
+    then "arm-unknown-linux-musleabihf"
+    else target;
 
-   target is mandatory but must be kept to null to allow cargo2nix to set it to the appropriate value
-   for each crate.
-  */ 
-  pkgs.rustBuilder.makePackageSet {
-    inherit packageFun rustChannel release codegenOpts;
-    packageOverrides = overrides;
-    target = null;
-
-    buildRustPackages = pkgs.buildPackages.rustBuilder.makePackageSet {
-      inherit rustChannel packageFun codegenOpts;
-      packageOverrides = overrides;
-      target = null;
-    };
-  }
+in
+  pkgs.rustBuilder.makePackageSet ({
+    inherit release packageFun packageOverrides codegenOpts rootFeatures;
+    target = rustTarget;
+  } // toolchainOptions)

nix/manifest-tool.nix

@@ -0,0 +1,23 @@
+pkgs:
+pkgs.buildGoModule rec {
+  pname = "manifest-tool";
+  version = "2.0.5";
+
+  src = pkgs.fetchFromGitHub {
+    owner = "estesp";
+    repo = "manifest-tool";
+    rev = "v${version}";
+    sha256 = "hjCGKnE0yrlnF/VIzOwcDzmQX3Wft+21KCny/opqdLg=";
+  } + "/v2";
+
+  vendorSha256 = null;
+
+  checkPhase = "true";
+
+  meta = with pkgs.lib; {
+    description = "Command line tool to create and query container image manifest list/indexes";
+    homepage = "https://github.com/estesp/manifest-tool";
+    license = licenses.asl20;
+    platforms = platforms.linux;
+  };
+}

nix/toolchain.nix

@@ -6,19 +6,24 @@ with import ./common.nix;
 
 let
   platforms = [
-    "x86_64-unknown-linux-musl"
+    #"x86_64-unknown-linux-musl"
     "i686-unknown-linux-musl"
-    "aarch64-unknown-linux-musl"
+    #"aarch64-unknown-linux-musl"
     "armv6l-unknown-linux-musleabihf"
   ];
   pkgsList = builtins.map (target: import pkgsSrc { 
     inherit system; 
-    crossSystem = { config = target; };
+    crossSystem = {
+      config = target;
+      isStatic = true;
+    };
+    overlays = [ cargo2nixOverlay ];
   }) platforms;
   pkgsHost = import pkgsSrc {};
   lib = pkgsHost.lib;
   kaniko = (import ./kaniko.nix) pkgsHost;
   winscp = (import ./winscp.nix) pkgsHost;
+  manifestTool = (import ./manifest-tool.nix) pkgsHost;
 in 
   lib.flatten (builtins.map (pkgs: [
      pkgs.rustPlatform.rust.rustc
@@ -27,5 +32,6 @@ in
   ]) pkgsList) ++ [
     kaniko
     winscp
+    manifestTool
   ]
 

script/helm/README.md

@@ -0,0 +1,3 @@
+# Garage helm3 chart
+
+Documentation is located [here](/doc/book/cookbook/kubernetes.md).

script/helm/garage/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

script/helm/garage/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: garage
+description: S3-compatible object store for small self-hosted geo-distributed deployments
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "v0.7.2.1"

script/helm/garage/templates/_helpers.tpl

@@ -0,0 +1,88 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "garage.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "garage.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create the name of the rpc secret
+*/}}
+{{- define "garage.rpcSecretName" -}}
+{{- printf "%s-rpc-secret" (include "garage.fullname" .) -}}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "garage.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "garage.labels" -}}
+helm.sh/chart: {{ include "garage.chart" . }}
+{{ include "garage.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "garage.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "garage.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "garage.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "garage.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+    Returns given number of random Hex characters.
+    In practice, it generates up to 100 randAlphaNum strings
+    that are filtered from non-hex characters and augmented
+    to the resulting string that is finally trimmed down.
+*/}}
+{{- define "jupyterhub.randHex" -}}
+    {{- $result := "" }}
+    {{- range $i := until 100 }}
+        {{- if lt (len $result) . }}
+            {{- $rand_list := randAlphaNum . | splitList "" -}}
+            {{- $reduced_list := without $rand_list "g" "h" "i" "j" "k" "l" "m" "n" "o" "p" "q" "r" "s" "t" "u" "v" "w" "x" "y" "z" "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z" }}
+            {{- $rand_string := join "" $reduced_list }}
+            {{- $result = print $result $rand_string -}}
+        {{- end }}
+    {{- end }}
+    {{- $result | trunc . }}
+{{- end }}

script/helm/garage/templates/clusterrole.yaml

@@ -0,0 +1,28 @@
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: manage-crds-{{ .Release.Namespace }}-{{ .Release.Name }}
+  labels:
+    {{- include "garage.labels" . | nindent 4 }}
+rules:
+- apiGroups: ["apiextensions.k8s.io"]
+  resources: ["customresourcedefinitions"]
+  verbs: ["get", "list", "watch", "create", "patch"]
+- apiGroups: ["deuxfleurs.fr"]
+  resources: ["garagenodes"]
+  verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: allow-crds-for-{{ .Release.Namespace }}-{{ .Release.Name }}
+  labels:
+    {{- include "garage.labels" . | nindent 4 }}
+subjects:
+- kind: ServiceAccount
+  name: {{ include "garage.serviceAccountName" . }}
+  namespace: {{ .Release.Namespace }}
+roleRef:
+  kind: ClusterRole
+  name: manage-crds-{{ .Release.Namespace }}-{{ .Release.Name }}
+  apiGroup: rbac.authorization.k8s.io

script/helm/garage/templates/configmap.yaml

@@ -0,0 +1,30 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "garage.fullname" . }}-config
+data:
+  garage.toml: |-
+    metadata_dir = "{{ .Values.garage.metadataDir }}"
+    data_dir = "{{ .Values.garage.dataDir }}"
+
+    replication_mode = "{{ .Values.garage.replicationMode }}"
+
+    rpc_bind_addr = "{{ .Values.garage.rpcBindAddr }}"
+    # rpc_secret will be populated by the init container from a k8s secret object
+    rpc_secret = "__RPC_SECRET_REPLACE__"
+
+    bootstrap_peers = {{ .Values.garage.bootstrapPeers }}
+
+    kubernetes_namespace = "{{ .Release.Namespace }}"
+    kubernetes_service_name = "{{ include "garage.fullname" . }}"
+    kubernetes_skip_crd = {{ .Values.garage.kubernetesSkipCrd }}
+
+    [s3_api]
+    s3_region = "{{ .Values.garage.s3.api.region }}"
+    api_bind_addr = "[::]:3900"
+    root_domain = "{{ .Values.garage.s3.api.rootDomain }}"
+
+    [s3_web]
+    bind_addr = "[::]:3902"
+    root_domain = "{{ .Values.garage.s3.web.rootDomain }}"
+    index = "{{ .Values.garage.s3.web.index }}"

script/helm/garage/templates/ingress.yaml

@@ -0,0 +1,123 @@
+{{- if .Values.ingress.s3.api.enabled -}}
+{{- $fullName := include "garage.fullname" . -}}
+{{- $svcPort := .Values.service.s3.api.port -}}
+{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
+  {{- if not (hasKey .Values.ingress.s3.api.annotations "kubernetes.io/ingress.class") }}
+  {{- $_ := set .Values.ingress.s3.api.annotations "kubernetes.io/ingress.class" .Values.ingress.s3.api.className}}
+  {{- end }}
+{{- end }}
+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}-s3-api
+  labels:
+    {{- include "garage.labels" . | nindent 4 }}
+  {{- with .Values.ingress.s3.api.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if and .Values.ingress.s3.api.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: {{ .Values.ingress.s3.api.className }}
+  {{- end }}
+  {{- if .Values.ingress.s3.api.tls }}
+  tls:
+    {{- range .Values.ingress.s3.api.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.s3.api.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ .path }}
+            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
+            pathType: {{ .pathType }}
+            {{- end }}
+            backend:
+              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+              {{- else }}
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+              {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}
+---
+{{- if .Values.ingress.s3.web.enabled -}}
+{{- $fullName := include "garage.fullname" . -}}
+{{- $svcPort := .Values.service.s3.web.port -}}
+{{- if and .Values.ingress.s3.web.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
+  {{- if not (hasKey .Values.ingress.s3.web.annotations "kubernetes.io/ingress.class") }}
+  {{- $_ := set .Values.ingress.s3.web.annotations "kubernetes.io/ingress.class" .Values.ingress.s3.web.className}}
+  {{- end }}
+{{- end }}
+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}-s3-web
+  labels:
+    {{- include "garage.labels" . | nindent 4 }}
+  {{- with .Values.ingress.s3.web.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if and .Values.ingress.s3.web.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: {{ .Values.ingress.s3.web.className }}
+  {{- end }}
+  {{- if .Values.ingress.s3.web.tls }}
+  tls:
+    {{- range .Values.ingress.s3.web.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.s3.web.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ .path }}
+            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
+            pathType: {{ .pathType }}
+            {{- end }}
+            backend:
+              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+              {{- else }}
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+              {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}

script/helm/garage/templates/secret.yaml

@@ -0,0 +1,14 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ include "garage.rpcSecretName" . }}
+  labels:
+    {{- include "garage.labels" . | nindent 4 }}
+type: Opaque
+data:
+  {{/* retrieve the secret data using lookup function and when not exists, return an empty dictionary / map as result */}}
+  {{- $prevSecret := (lookup "v1" "Secret" .Release.Namespace (include "garage.rpcSecretName" .)) | default dict }}
+  {{- $prevSecretData := $prevSecret.data | default dict }}
+  {{- $prevRpcSecret := $prevSecretData.rpcSecret | default "" | b64dec }}
+  {{/* Priority is: 1. from values, 2. previous value, 3. generate random */}}
+  rpcSecret: {{ .Values.garage.rpcSecret | default $prevRpcSecret | default (include "jupyterhub.randHex" 64) | b64enc | quote }}

script/helm/garage/templates/service.yaml

@@ -0,0 +1,19 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "garage.fullname" . }}
+  labels:
+    {{- include "garage.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.s3.api.port }}
+      targetPort: 3900
+      protocol: TCP
+      name: s3-api
+    - port: {{ .Values.service.s3.web.port }}
+      targetPort: 3902
+      protocol: TCP
+      name: s3-web
+  selector:
+    {{- include "garage.selectorLabels" . | nindent 4 }}

script/helm/garage/templates/serviceaccount.yaml

@@ -0,0 +1,12 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "garage.serviceAccountName" . }}
+  labels:
+    {{- include "garage.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end }}

script/helm/garage/templates/statefulset.yaml

@@ -0,0 +1,116 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: {{ include "garage.fullname" . }}
+  labels:
+    {{- include "garage.labels" . | nindent 4 }}
+spec:
+  replicas: {{ .Values.replicaCount }}
+  selector:
+    matchLabels:
+      {{- include "garage.selectorLabels" . | nindent 6 }}
+  serviceName: {{ include "garage.fullname" . }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "garage.selectorLabels" . | nindent 8 }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "garage.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      initContainers:
+        # Copies garage.toml from configmap to temporary etc volume and replaces RPC secret placeholder
+        - name: {{ .Chart.Name }}-init
+          image: busybox:1.28
+          command: ["sh", "-c", "sed \"s/__RPC_SECRET_REPLACE__/$RPC_SECRET/\" /mnt/garage.toml > /mnt/etc/garage.toml"]
+          env:
+            - name: RPC_SECRET
+              valueFrom:
+                secretKeyRef:
+                  name: {{ include "garage.rpcSecretName" . }}
+                  key: rpcSecret
+          volumeMounts:
+            - name: configmap
+              mountPath: /mnt/garage.toml
+              subPath: garage.toml
+            - name: etc
+              mountPath: /mnt/etc
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - containerPort: 3900
+              name: s3-api
+            - containerPort: 3902
+              name: web-api
+          volumeMounts:
+            - name: meta
+              mountPath: /mnt/meta
+            - name: data
+              mountPath: /mnt/data
+            - name: etc
+              mountPath: /etc/garage.toml
+              subPath: garage.toml
+          # TODO
+          # livenessProbe:
+          #   httpGet:
+          #     path: /
+          #     port: 3900
+          # readinessProbe:
+          #   httpGet:
+          #     path: /
+          #     port: 3900
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+      volumes:
+        - name: configmap
+          configMap:
+            name: {{ include "garage.fullname" . }}-config
+        - name: etc
+          emptyDir: {}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+  {{- if .Values.persistence.enabled }}
+  volumeClaimTemplates:
+  - metadata:
+      name: meta
+    spec:
+      accessModes: [ "ReadWriteOnce" ]
+    {{- if hasKey .Values.persistence.meta "storageClass" }}
+      storageClassName: {{ .Values.persistence.meta.storageClass | quote }}
+    {{- end }}
+      resources:
+        requests:
+          storage: {{ .Values.persistence.meta.size | quote }}
+  - metadata:
+      name: data
+    spec:
+      accessModes: [ "ReadWriteOnce" ]
+    {{- if hasKey .Values.persistence.data "storageClass" }}
+      storageClassName: {{ .Values.persistence.data.storageClass | quote }}
+    {{- end }}
+      resources:
+        requests:
+          storage: {{ .Values.persistence.data.size | quote }}
+  {{- end }}

script/helm/garage/values.yaml

@@ -0,0 +1,142 @@
+# Default values for garage.
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+# Garage configuration. These values go to garage.toml
+garage:
+  metadataDir: "/mnt/meta"
+  dataDir: "/mnt/data"
+  # Default to 3 replicas, see the replication_mode section at
+  # https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/
+  replicationMode: "3"
+  rpcBindAddr: "[::]:3901"
+  # If not given, a random secret will be generated and stored in a Secret object
+  rpcSecret: ""
+  # This is not required if you use the integrated kubernetes discovery
+  bootstrapPeers: []
+  kubernetesSkipCrd: false
+  s3:
+    api:
+      region: "garage"
+      rootDomain: ".s3.garage.tld"
+    web:
+      rootDomain: ".web.garage.tld"
+      index: "index.html"
+
+# Data persistence
+persistence:
+  enabled: true
+  meta:
+    # storageClass: "fast-storage-class"
+    size: 100Mi
+  data:
+    # storageClass: "slow-storage-class"
+    size: 100Mi
+
+# Number of StatefulSet replicas/garage nodes to start
+replicaCount: 3
+
+image:
+  repository: dxflrs/amd64_garage
+  # please prefer using the chart version and not this tag
+  tag: ""
+  pullPolicy: IfNotPresent
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: ""
+
+podAnnotations: {}
+
+podSecurityContext: {}
+  # fsGroup: 2000
+
+securityContext:
+  # The default security context is heavily restricted
+  # feel free to tune it to your requirements
+  capabilities:
+    drop:
+    - ALL
+  readOnlyRootFilesystem: true
+  runAsNonRoot: true
+  runAsUser: 1000
+
+service:
+  # You can rely on any service to expose your cluster
+  # - ClusterIP (+ Ingress)
+  # - NodePort (+ Ingress)
+  # - LoadBalancer
+  type: ClusterIP
+  s3:
+    api:
+      port: 3900
+    web:
+      port: 3902
+    # NOTE: the admin API is excluded for now as it is not consistent across nodes
+ingress:
+  s3:
+    api:
+      enabled: true
+      # Rely either on the className or the annotation below but not both
+      # replace "nginx" by an Ingress controller
+      # you can find examples here https://kubernetes.io/docs/concepts/services-networking/ingress-controllers
+      className: "nginx"
+      annotations:
+        # kubernetes.io/ingress.class: "nginx"
+        # kubernetes.io/tls-acme: "true"
+      hosts:
+        - host: "s3.garage.tld" # garage S3 API endpoint
+          paths:
+            - path: /
+              pathType: Prefix
+        - host: "*.s3.garage.tld" # garage S3 API endpoint, DNS style bucket access
+          paths:
+            - path: /
+              pathType: Prefix
+      tls: []
+      #  - secretName: my-garage-cluster-tls
+      #    hosts:
+      #      - kubernetes.docker.internal
+    web:
+      enabled: true
+      className: "nginx"
+      annotations: {}
+        # kubernetes.io/ingress.class: nginx
+        # kubernetes.io/tls-acme: "true"
+      hosts:
+       - host: "*.web.garage.tld" # wildcard website access with bucket name prefix
+         paths:
+           - path: /
+             pathType: Prefix
+       - host: "mywebpage.example.com" # specific bucket access with FQDN bucket
+         paths:
+           - path: /
+             pathType: Prefix
+      tls: []
+      #  - secretName: my-garage-cluster-tls
+      #    hosts:
+      #      - kubernetes.docker.internal
+
+resources: {}
+  # The following are indicative for a small-size deployement, for anything serious double them.
+  # limits:
+  #   cpu: 100m
+  #   memory: 1024Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 512Mi
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}

script/test-smoke.sh

@@ -8,7 +8,7 @@ SCRIPT_FOLDER="`dirname \"$0\"`"
 REPO_FOLDER="${SCRIPT_FOLDER}/../"
 GARAGE_DEBUG="${REPO_FOLDER}/target/debug/"
 GARAGE_RELEASE="${REPO_FOLDER}/target/release/"
-NIX_RELEASE="${REPO_FOLDER}/result/bin/"
+NIX_RELEASE="${REPO_FOLDER}/result/bin/:${REPO_FOLDER}/result-bin/bin/"
 PATH="${GARAGE_DEBUG}:${GARAGE_RELEASE}:${NIX_RELEASE}:$PATH"
 CMDOUT=/tmp/garage.cmd.tmp
 

shell.nix

@@ -10,24 +10,15 @@ let
     overlays = [ cargo2nixOverlay ];
   };
   kaniko = (import ./nix/kaniko.nix) pkgs;
+  manifest-tool = (import ./nix/manifest-tool.nix) pkgs;
   winscp = (import ./nix/winscp.nix) pkgs;
 
 in
   {
-
     /* --- Rust Shell ---
      * Use it to compile Garage
      */
     rust = pkgs.mkShell {
-      shellHook = ''
-function refresh_toolchain {
-  nix copy \
-    --to 's3://nix?endpoint=garage.deuxfleurs.fr&region=garage&secret-key=/etc/nix/signing-key.sec' \
-    $(nix-store -qR \
-      $(nix-build --quiet --no-build-output --no-out-link nix/toolchain.nix))
-}
-      '';
-
       nativeBuildInputs = [
         #pkgs.rustPlatform.rust.rustc
         pkgs.rustPlatform.rust.cargo
@@ -66,12 +57,33 @@ function refresh_toolchain {
      */
     release = pkgs.mkShell {
       shellHook = ''
+function refresh_toolchain {
+  pass show deuxfleurs/nix_priv_key > /tmp/nix-signing-key.sec
+  nix copy \
+    --to 's3://nix?endpoint=garage.deuxfleurs.fr&region=garage&secret-key=/tmp/nix-signing-key.sec' \
+    $(nix-store -qR \
+      $(nix-build --no-build-output --no-out-link nix/toolchain.nix))
+  rm /tmp/nix-signing-key.sec
+}
+
+function refresh_cache {
+  pass show deuxfleurs/nix_priv_key > /tmp/nix-signing-key.sec
+  for attr in clippy.amd64 test.amd64 pkgs.{amd64,i386,arm,arm64}.{debug,release}; do
+    echo "Updating cache for ''${attr}"
+    derivation=$(nix-instantiate --attr ''${attr})
+    nix copy \
+      --to 's3://nix?endpoint=garage.deuxfleurs.fr&region=garage&secret-key=/tmp/nix-signing-key.sec' \
+      $(nix-store -qR ''${derivation%\!bin})
+  done
+  rm /tmp/nix-signing-key.sec
+}
+
 function to_s3 {
   aws \
       --endpoint-url https://garage.deuxfleurs.fr \
       --region garage \
     s3 cp \
-      ./result/bin/garage \
+      ./result-bin/bin/garage \
       s3://garagehq.deuxfleurs.fr/_releases/''${DRONE_TAG:-$DRONE_COMMIT}/''${TARGET}/garage
 }
 
@@ -84,6 +96,34 @@ function to_docker {
     --verbosity=debug
 }
 
+function multiarch_docker {
+        manifest-tool push from-spec <(cat <<EOF
+image: dxflrs/garage:''${CONTAINER_TAG}
+manifests:
+  -
+    image: dxflrs/arm64_garage:''${CONTAINER_TAG}
+    platform:
+      architecture: arm64
+      os: linux
+  -
+    image: dxflrs/amd64_garage:''${CONTAINER_TAG}
+    platform:
+      architecture: amd64
+      os: linux
+  -
+    image: dxflrs/386_garage:''${CONTAINER_TAG}
+    platform:
+      architecture: 386
+      os: linux
+  -
+    image: dxflrs/arm_garage:''${CONTAINER_TAG}
+    platform:
+      architecture: arm
+      os: linux
+EOF
+        )
+}
+
 function refresh_index {
   aws \
       --endpoint-url https://garage.deuxfleurs.fr \
@@ -113,6 +153,7 @@ function refresh_index {
       nativeBuildInputs = [
         pkgs.awscli2
         kaniko 
+        manifest-tool
       ];
     };
   }

src/api/Cargo.toml

@@ -36,7 +36,7 @@ sha2 = "0.10"
 
 futures = "0.3"
 futures-util = "0.3"
-pin-project = "1.0"
+pin-project = "1.0.11"
 tokio = { version = "1.0", default-features = false, features = ["rt", "rt-multi-thread", "io-util", "net", "time", "macros", "sync", "signal", "fs"] }
 tokio-stream = "0.1"
 

src/api/admin/api_server.rs

@@ -5,7 +5,7 @@ use async_trait::async_trait;
 
 use futures::future::Future;
 use http::header::{ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ALLOW};
-use hyper::{Body, Request, Response};
+use hyper::{Body, Request, Response, StatusCode};
 
 use opentelemetry::trace::SpanRef;
 
@@ -69,7 +69,7 @@ impl AdminApiServer {
 
 	fn handle_options(&self, _req: &Request<Body>) -> Result<Response<Body>, Error> {
 		Ok(Response::builder()
-			.status(204)
+			.status(StatusCode::NO_CONTENT)
 			.header(ALLOW, "OPTIONS, GET, POST")
 			.header(ACCESS_CONTROL_ALLOW_METHODS, "OPTIONS, GET, POST")
 			.header(ACCESS_CONTROL_ALLOW_ORIGIN, "*")
@@ -94,7 +94,7 @@ impl AdminApiServer {
 				.ok_or_internal_error("Could not serialize metrics")?;
 
 			Ok(Response::builder()
-				.status(200)
+				.status(StatusCode::OK)
 				.header(http::header::CONTENT_TYPE, encoder.format_type())
 				.body(Body::from(buffer))?)
 		}

src/api/admin/cluster.rs

@@ -151,7 +151,7 @@ pub async fn handle_update_cluster_layout(
 	garage.system.update_cluster_layout(&layout).await?;
 
 	Ok(Response::builder()
-		.status(StatusCode::OK)
+		.status(StatusCode::NO_CONTENT)
 		.body(Body::empty())?)
 }
 
@@ -166,7 +166,7 @@ pub async fn handle_apply_cluster_layout(
 	garage.system.update_cluster_layout(&layout).await?;
 
 	Ok(Response::builder()
-		.status(StatusCode::OK)
+		.status(StatusCode::NO_CONTENT)
 		.body(Body::empty())?)
 }
 
@@ -181,7 +181,7 @@ pub async fn handle_revert_cluster_layout(
 	garage.system.update_cluster_layout(&layout).await?;
 
 	Ok(Response::builder()
-		.status(StatusCode::OK)
+		.status(StatusCode::NO_CONTENT)
 		.body(Body::empty())?)
 }
 

src/api/generic_server.rs

@@ -174,7 +174,11 @@ impl<A: ApiHandler> ApiServer<A> {
 
 		let current_context = Context::current();
 		let current_span = current_context.span();
-		current_span.update_name::<String>(format!("S3 API {}", endpoint.name()));
+		current_span.update_name::<String>(format!(
+			"{} API {}",
+			A::API_NAME_DISPLAY,
+			endpoint.name()
+		));
 		current_span.set_attribute(KeyValue::new("endpoint", endpoint.name()));
 		endpoint.add_span_attributes(current_span);
 

src/api/k2v/batch.rs

@@ -42,7 +42,7 @@ pub async fn handle_insert_batch(
 	garage.k2v.rpc.insert_batch(bucket_id, items2).await?;
 
 	Ok(Response::builder()
-		.status(StatusCode::OK)
+		.status(StatusCode::NO_CONTENT)
 		.body(Body::empty())?)
 }
 

src/api/k2v/item.rs

@@ -153,7 +153,7 @@ pub async fn handle_insert_item(
 		.await?;
 
 	Ok(Response::builder()
-		.status(StatusCode::OK)
+		.status(StatusCode::NO_CONTENT)
 		.body(Body::empty())?)
 }
 

src/db/test.rs

@@ -1,9 +1,5 @@
 use crate::*;
 
-use crate::lmdb_adapter::LmdbDb;
-use crate::sled_adapter::SledDb;
-use crate::sqlite_adapter::SqliteDb;
-
 fn test_suite(db: Db) {
 	let tree = db.open_tree("tree").unwrap();
 
@@ -80,7 +76,10 @@ fn test_suite(db: Db) {
 }
 
 #[test]
+#[cfg(feature = "lmdb")]
 fn test_lmdb_db() {
+	use crate::lmdb_adapter::LmdbDb;
+
 	let path = mktemp::Temp::new_dir().unwrap();
 	let db = heed::EnvOpenOptions::new()
 		.max_dbs(100)
@@ -92,7 +91,10 @@ fn test_lmdb_db() {
 }
 
 #[test]
+#[cfg(feature = "sled")]
 fn test_sled_db() {
+	use crate::sled_adapter::SledDb;
+
 	let path = mktemp::Temp::new_dir().unwrap();
 	let db = SledDb::init(sled::open(path.to_path_buf()).unwrap());
 	test_suite(db);
@@ -100,7 +102,10 @@ fn test_sled_db() {
 }
 
 #[test]
+#[cfg(feature = "sqlite")]
 fn test_sqlite_db() {
+	use crate::sqlite_adapter::SqliteDb;
+
 	let db = SqliteDb::init(rusqlite::Connection::open_in_memory().unwrap());
 	test_suite(db);
 }

src/garage/Cargo.toml

@@ -58,7 +58,7 @@ opentelemetry-otlp = { version = "0.10", optional = true }
 prometheus = { version = "0.13", optional = true }
 
 [dev-dependencies]
-aws-sdk-s3 = "0.8"
+aws-sdk-s3 = "0.19"
 chrono = "0.4"
 http = "0.2"
 hmac = "0.12"
@@ -81,6 +81,8 @@ sled = [ "garage_model/sled" ]
 lmdb = [ "garage_model/lmdb" ]
 sqlite = [ "garage_model/sqlite" ]
 
+# Automatic registration and discovery via Consul API
+consul-discovery = [ "garage_rpc/consul-discovery" ]
 # Automatic registration and discovery via Kubernetes API
 kubernetes-discovery = [ "garage_rpc/kubernetes-discovery" ]
 # Prometheus exporter (/metrics endpoint).

src/garage/main.rs

@@ -90,6 +90,8 @@ async fn main() {
 		"lmdb",
 		#[cfg(feature = "sqlite")]
 		"sqlite",
+		#[cfg(feature = "consul-discovery")]
+		"consul-discovery",
 		#[cfg(feature = "kubernetes-discovery")]
 		"kubernetes-discovery",
 		#[cfg(feature = "metrics")]

src/garage/server.rs

@@ -36,7 +36,7 @@ pub async fn run_server(config_file: PathBuf) -> Result<(), Error> {
 	let metrics_exporter = opentelemetry_prometheus::exporter().init();
 
 	info!("Initializing background runner...");
-	let watch_cancel = netapp::util::watch_ctrl_c();
+	let watch_cancel = watch_shutdown_signal();
 	let (background, await_background_done) = BackgroundRunner::new(16, watch_cancel.clone());
 
 	info!("Initializing Garage main data store...");
@@ -157,3 +157,44 @@ pub async fn run_server(config_file: PathBuf) -> Result<(), Error> {
 
 	Ok(())
 }
+
+#[cfg(unix)]
+fn watch_shutdown_signal() -> watch::Receiver<bool> {
+	use tokio::signal::unix::*;
+
+	let (send_cancel, watch_cancel) = watch::channel(false);
+	tokio::spawn(async move {
+		let mut sigint = signal(SignalKind::interrupt()).expect("Failed to install SIGINT handler");
+		let mut sigterm =
+			signal(SignalKind::terminate()).expect("Failed to install SIGTERM handler");
+		let mut sighup = signal(SignalKind::hangup()).expect("Failed to install SIGHUP handler");
+		tokio::select! {
+			_ = sigint.recv() => info!("Received SIGINT, shutting down."),
+			_ = sigterm.recv() => info!("Received SIGTERM, shutting down."),
+			_ = sighup.recv() => info!("Received SIGHUP, shutting down."),
+		}
+		send_cancel.send(true).unwrap();
+	});
+	watch_cancel
+}
+
+#[cfg(windows)]
+fn watch_shutdown_signal() -> watch::Receiver<bool> {
+	use tokio::signal::windows::*;
+
+	let (send_cancel, watch_cancel) = watch::channel(false);
+	tokio::spawn(async move {
+		let mut sigint = ctrl_c().expect("Failed to install Ctrl-C handler");
+		let mut sigclose = ctrl_close().expect("Failed to install Ctrl-Close handler");
+		let mut siglogoff = ctrl_logoff().expect("Failed to install Ctrl-Logoff handler");
+		let mut sigsdown = ctrl_shutdown().expect("Failed to install Ctrl-Shutdown handler");
+		tokio::select! {
+			_ = sigint.recv() => info!("Received Ctrl-C, shutting down."),
+			_ = sigclose.recv() => info!("Received Ctrl-Close, shutting down."),
+			_ = siglogoff.recv() => info!("Received Ctrl-Logoff, shutting down."),
+			_ = sigsdown.recv() => info!("Received Ctrl-Shutdown, shutting down."),
+		}
+		send_cancel.send(true).unwrap();
+	});
+	watch_cancel
+}

src/garage/tests/k2v/batch.rs

@@ -6,7 +6,7 @@ use assert_json_diff::assert_json_eq;
 use serde_json::json;
 
 use super::json_body;
-use hyper::Method;
+use hyper::{Method, StatusCode};
 
 #[tokio::test]
 async fn test_batch() {
@@ -49,7 +49,7 @@ async fn test_batch() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	for sk in ["a", "b", "c", "d.1", "d.2", "e"] {
 		let res = ctx
@@ -62,7 +62,7 @@ async fn test_batch() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 200);
+		assert_eq!(res.status(), StatusCode::OK);
 		assert_eq!(
 			res.headers().get("content-type").unwrap().to_str().unwrap(),
 			"application/octet-stream"
@@ -104,7 +104,7 @@ async fn test_batch() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	let json_res = json_body(res).await;
 	assert_json_eq!(
 		json_res,
@@ -266,7 +266,7 @@ async fn test_batch() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	for sk in ["b", "c", "d.1", "d.2"] {
 		let res = ctx
@@ -280,9 +280,9 @@ async fn test_batch() {
 			.await
 			.unwrap();
 		if sk == "b" {
-			assert_eq!(res.status(), 204);
+			assert_eq!(res.status(), StatusCode::NO_CONTENT);
 		} else {
-			assert_eq!(res.status(), 200);
+			assert_eq!(res.status(), StatusCode::OK);
 		}
 		ct.insert(
 			sk,
@@ -317,7 +317,7 @@ async fn test_batch() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	let json_res = json_body(res).await;
 	assert_json_eq!(
 		json_res,
@@ -478,7 +478,7 @@ async fn test_batch() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	let json_res = json_body(res).await;
 	assert_json_eq!(
 		json_res,
@@ -514,7 +514,7 @@ async fn test_batch() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 204);
+		assert_eq!(res.status(), StatusCode::NO_CONTENT);
 		assert_eq!(
 			res.headers().get("content-type").unwrap().to_str().unwrap(),
 			"application/octet-stream"
@@ -547,7 +547,7 @@ async fn test_batch() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	let json_res = json_body(res).await;
 	assert_json_eq!(
 		json_res,

src/garage/tests/k2v/errorcodes.rs

@@ -1,13 +1,13 @@
 use crate::common;
 
-use hyper::Method;
+use hyper::{Method, StatusCode};
 
 #[tokio::test]
 async fn test_error_codes() {
 	let ctx = common::context();
 	let bucket = ctx.create_bucket("test-k2v-error-codes");
 
-	// Regular insert should work (code 200)
+	// Regular insert should work (code 204)
 	let res = ctx
 		.k2v
 		.request
@@ -19,7 +19,7 @@ async fn test_error_codes() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	// Insert with trash causality token: invalid request
 	let res = ctx
@@ -34,7 +34,7 @@ async fn test_error_codes() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 400);
+	assert_eq!(res.status(), StatusCode::BAD_REQUEST);
 
 	// Search without partition key: invalid request
 	let res = ctx
@@ -52,7 +52,7 @@ async fn test_error_codes() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 400);
+	assert_eq!(res.status(), StatusCode::BAD_REQUEST);
 
 	// Search with start that is not in prefix: invalid request
 	let res = ctx
@@ -70,7 +70,7 @@ async fn test_error_codes() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 400);
+	assert_eq!(res.status(), StatusCode::BAD_REQUEST);
 
 	// Search with invalid json: 400
 	let res = ctx
@@ -88,7 +88,7 @@ async fn test_error_codes() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 400);
+	assert_eq!(res.status(), StatusCode::BAD_REQUEST);
 
 	// Batch insert with invalid causality token: 400
 	let res = ctx
@@ -105,7 +105,7 @@ async fn test_error_codes() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 400);
+	assert_eq!(res.status(), StatusCode::BAD_REQUEST);
 
 	// Batch insert with invalid data: 400
 	let res = ctx
@@ -122,7 +122,7 @@ async fn test_error_codes() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 400);
+	assert_eq!(res.status(), StatusCode::BAD_REQUEST);
 
 	// Poll with invalid causality token: 400
 	let res = ctx
@@ -137,5 +137,5 @@ async fn test_error_codes() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 400);
+	assert_eq!(res.status(), StatusCode::BAD_REQUEST);
 }

src/garage/tests/k2v/item.rs

@@ -6,7 +6,7 @@ use assert_json_diff::assert_json_eq;
 use serde_json::json;
 
 use super::json_body;
-use hyper::Method;
+use hyper::{Method, StatusCode};
 
 #[tokio::test]
 async fn test_items_and_indices() {
@@ -56,7 +56,7 @@ async fn test_items_and_indices() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 200);
+		assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 		// Get value back
 		let res = ctx
@@ -69,7 +69,7 @@ async fn test_items_and_indices() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 200);
+		assert_eq!(res.status(), StatusCode::OK);
 		assert_eq!(
 			res.headers().get("content-type").unwrap().to_str().unwrap(),
 			"application/octet-stream"
@@ -132,7 +132,7 @@ async fn test_items_and_indices() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 200);
+		assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 		// Get value back
 		let res = ctx
@@ -145,7 +145,7 @@ async fn test_items_and_indices() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 200);
+		assert_eq!(res.status(), StatusCode::OK);
 		assert_eq!(
 			res.headers().get("content-type").unwrap().to_str().unwrap(),
 			"application/octet-stream"
@@ -201,7 +201,7 @@ async fn test_items_and_indices() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 200);
+		assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 		// Get value back
 		let res = ctx
@@ -214,7 +214,7 @@ async fn test_items_and_indices() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 200);
+		assert_eq!(res.status(), StatusCode::OK);
 		assert_eq!(
 			res.headers().get("content-type").unwrap().to_str().unwrap(),
 			"application/json"
@@ -271,7 +271,7 @@ async fn test_items_and_indices() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 200);
+		assert_eq!(res.status(), StatusCode::OK);
 		let ct = res
 			.headers()
 			.get("x-garage-causality-token")
@@ -292,7 +292,7 @@ async fn test_items_and_indices() {
 			.send()
 			.await
 			.unwrap();
-		assert_eq!(res.status(), 204);
+		assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 		// ReadIndex -- now there should be some stuff
 		tokio::time::sleep(Duration::from_secs(1)).await;
@@ -364,7 +364,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	// f0: either
 	let res = ctx
@@ -377,7 +377,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/octet-stream"
@@ -405,7 +405,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -424,7 +424,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/octet-stream"
@@ -446,7 +446,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -466,7 +466,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	// f0: either
 	let res = ctx
@@ -479,7 +479,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -503,7 +503,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -528,7 +528,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 409); // CONFLICT
+	assert_eq!(res.status(), StatusCode::CONFLICT); // CONFLICT
 
 	// f3: json
 	let res = ctx
@@ -541,7 +541,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -568,7 +568,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 204);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	// f0: either
 	let res = ctx
@@ -581,7 +581,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -599,7 +599,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -625,7 +625,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 409); // CONFLICT
+	assert_eq!(res.status(), StatusCode::CONFLICT); // CONFLICT
 
 	// f3: json
 	let res = ctx
@@ -638,7 +638,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -658,7 +658,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 204);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	// f0: either
 	let res = ctx
@@ -671,7 +671,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 204); // NO CONTENT
+	assert_eq!(res.status(), StatusCode::NO_CONTENT); // NO CONTENT
 
 	// f1: not specified
 	let res = ctx
@@ -683,7 +683,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"
@@ -702,7 +702,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 204); // NO CONTENT
+	assert_eq!(res.status(), StatusCode::NO_CONTENT); // NO CONTENT
 
 	// f3: json
 	let res = ctx
@@ -715,7 +715,7 @@ async fn test_item_return_format() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::OK);
 	assert_eq!(
 		res.headers().get("content-type").unwrap().to_str().unwrap(),
 		"application/json"

src/garage/tests/k2v/poll.rs

@@ -1,4 +1,4 @@
-use hyper::Method;
+use hyper::{Method, StatusCode};
 use std::time::Duration;
 
 use crate::common;
@@ -20,7 +20,7 @@ async fn test_poll() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	// Retrieve initial value to get its causality token
 	let res2 = ctx
@@ -33,7 +33,7 @@ async fn test_poll() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res2.status(), 200);
+	assert_eq!(res2.status(), StatusCode::OK);
 	let ct = res2
 		.headers()
 		.get("x-garage-causality-token")
@@ -80,7 +80,7 @@ async fn test_poll() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	// Check poll finishes with correct value
 	let poll_res = tokio::select! {
@@ -88,7 +88,7 @@ async fn test_poll() {
 		res = poll => res.unwrap().unwrap(),
 	};
 
-	assert_eq!(poll_res.status(), 200);
+	assert_eq!(poll_res.status(), StatusCode::OK);
 
 	let poll_res_body = hyper::body::to_bytes(poll_res.into_body())
 		.await

src/garage/tests/k2v/simple.rs

@@ -1,6 +1,6 @@
 use crate::common;
 
-use hyper::Method;
+use hyper::{Method, StatusCode};
 
 #[tokio::test]
 async fn test_simple() {
@@ -18,7 +18,7 @@ async fn test_simple() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res.status(), 200);
+	assert_eq!(res.status(), StatusCode::NO_CONTENT);
 
 	let res2 = ctx
 		.k2v
@@ -30,7 +30,7 @@ async fn test_simple() {
 		.send()
 		.await
 		.unwrap();
-	assert_eq!(res2.status(), 200);
+	assert_eq!(res2.status(), StatusCode::OK);
 
 	let res2_body = hyper::body::to_bytes(res2.into_body())
 		.await

src/garage/tests/s3/website.rs

@@ -4,7 +4,7 @@ use aws_sdk_s3::{
 	model::{CorsConfiguration, CorsRule, ErrorDocument, IndexDocument, WebsiteConfiguration},
 	types::ByteStream,
 };
-use http::Request;
+use http::{Request, StatusCode};
 use hyper::{
 	body::{to_bytes, Body},
 	Client,
@@ -43,7 +43,7 @@ async fn test_website() {
 
 	let mut resp = client.request(req()).await.unwrap();
 
-	assert_eq!(resp.status(), 404);
+	assert_eq!(resp.status(), StatusCode::NOT_FOUND);
 	assert_ne!(
 		to_bytes(resp.body_mut()).await.unwrap().as_ref(),
 		BODY.as_ref()
@@ -56,7 +56,7 @@ async fn test_website() {
 		.expect_success_status("Could not allow website on bucket");
 
 	resp = client.request(req()).await.unwrap();
-	assert_eq!(resp.status(), 200);
+	assert_eq!(resp.status(), StatusCode::OK);
 	assert_eq!(
 		to_bytes(resp.body_mut()).await.unwrap().as_ref(),
 		BODY.as_ref()
@@ -69,7 +69,7 @@ async fn test_website() {
 		.expect_success_status("Could not deny website on bucket");
 
 	resp = client.request(req()).await.unwrap();
-	assert_eq!(resp.status(), 404);
+	assert_eq!(resp.status(), StatusCode::NOT_FOUND);
 	assert_ne!(
 		to_bytes(resp.body_mut()).await.unwrap().as_ref(),
 		BODY.as_ref()
@@ -175,7 +175,7 @@ async fn test_website_s3_api() {
 
 		let mut resp = client.request(req).await.unwrap();
 
-		assert_eq!(resp.status(), 200);
+		assert_eq!(resp.status(), StatusCode::OK);
 		assert_eq!(
 			resp.headers().get("access-control-allow-origin").unwrap(),
 			"*"
@@ -200,7 +200,7 @@ async fn test_website_s3_api() {
 
 		let mut resp = client.request(req).await.unwrap();
 
-		assert_eq!(resp.status(), 404);
+		assert_eq!(resp.status(), StatusCode::NOT_FOUND);
 		assert_eq!(
 			to_bytes(resp.body_mut()).await.unwrap().as_ref(),
 			BODY_ERR.as_ref()
@@ -220,7 +220,7 @@ async fn test_website_s3_api() {
 
 		let mut resp = client.request(req).await.unwrap();
 
-		assert_eq!(resp.status(), 200);
+		assert_eq!(resp.status(), StatusCode::OK);
 		assert_eq!(
 			resp.headers().get("access-control-allow-origin").unwrap(),
 			"*"
@@ -244,7 +244,7 @@ async fn test_website_s3_api() {
 
 		let mut resp = client.request(req).await.unwrap();
 
-		assert_eq!(resp.status(), 403);
+		assert_eq!(resp.status(), StatusCode::FORBIDDEN);
 		assert_ne!(
 			to_bytes(resp.body_mut()).await.unwrap().as_ref(),
 			BODY.as_ref()
@@ -285,7 +285,7 @@ async fn test_website_s3_api() {
 
 		let mut resp = client.request(req).await.unwrap();
 
-		assert_eq!(resp.status(), 403);
+		assert_eq!(resp.status(), StatusCode::FORBIDDEN);
 		assert_ne!(
 			to_bytes(resp.body_mut()).await.unwrap().as_ref(),
 			BODY.as_ref()
@@ -311,7 +311,7 @@ async fn test_website_s3_api() {
 
 		let mut resp = client.request(req).await.unwrap();
 
-		assert_eq!(resp.status(), 404);
+		assert_eq!(resp.status(), StatusCode::NOT_FOUND);
 		assert_ne!(
 			to_bytes(resp.body_mut()).await.unwrap().as_ref(),
 			BODY_ERR.as_ref()

src/k2v-client/Cargo.toml

@@ -12,7 +12,7 @@ readme = "../../README.md"
 base64 = "0.13.0"
 http = "0.2.6"
 log = "0.4"
-rusoto_core = "0.48.0"
+rusoto_core = { version = "0.48.0", default-features = false, features = ["rustls"] }
 rusoto_credential = "0.48.0"
 rusoto_signature = "0.48.0"
 serde = "1.0.137"

src/rpc/Cargo.toml

@@ -29,12 +29,13 @@ rmp-serde = "0.15"
 serde = { version = "1.0", default-features = false, features = ["derive", "rc"] }
 serde_bytes = "0.11"
 serde_json = "1.0"
+err-derive = { version = "0.3", optional = true }
 
 # newer version requires rust edition 2021
-kube = { version = "0.62", features = ["runtime", "derive"], optional = true }
-k8s-openapi = { version = "0.13", features = ["v1_22"], optional = true }
-openssl = { version = "0.10", features = ["vendored"], optional = true }
+kube = { version = "0.75", default-features = false, features = ["runtime", "derive", "client", "rustls-tls"], optional = true }
+k8s-openapi = { version = "0.16", features = ["v1_22"], optional = true }
 schemars = { version = "0.8", optional = true }
+reqwest = { version = "0.11", optional = true, default-features = false, features = ["rustls-tls-manual-roots", "json"] }
 
 # newer version requires rust edition 2021
 pnet_datalink = "0.28"
@@ -47,9 +48,7 @@ opentelemetry = "0.17"
 
 netapp = { version = "0.5.2", features = ["telemetry"] }
 
-hyper = { version = "0.14", features = ["client", "http1", "runtime", "tcp"] }
-
-
 [features]
-kubernetes-discovery = [ "kube", "k8s-openapi", "openssl", "schemars" ]
+kubernetes-discovery = [ "kube", "k8s-openapi", "schemars" ]
+consul-discovery = [ "reqwest", "err-derive" ]
 system-libs = [ "sodiumoxide/use-pkg-config" ]

src/rpc/consul.rs

@@ -1,16 +1,14 @@
 use std::collections::HashMap;
+use std::fs::File;
+use std::io::Read;
 use std::net::{IpAddr, SocketAddr};
 
-use hyper::client::Client;
-use hyper::StatusCode;
-use hyper::{Body, Method, Request};
+use err_derive::Error;
 use serde::{Deserialize, Serialize};
 
 use netapp::NodeID;
 
-use garage_util::error::Error;
-
-// ---- READING FROM CONSUL CATALOG ----
+use garage_util::config::ConsulDiscoveryConfig;
 
 #[derive(Deserialize, Clone, Debug)]
 struct ConsulQueryEntry {
@@ -22,53 +20,6 @@ struct ConsulQueryEntry {
 	node_meta: HashMap<String, String>,
 }
 
-pub async fn get_consul_nodes(
-	consul_host: &str,
-	consul_service_name: &str,
-) -> Result<Vec<(NodeID, SocketAddr)>, Error> {
-	let url = format!(
-		"http://{}/v1/catalog/service/{}",
-		consul_host, consul_service_name
-	);
-	let req = Request::builder()
-		.uri(url)
-		.method(Method::GET)
-		.body(Body::default())?;
-
-	let client = Client::new();
-
-	let resp = client.request(req).await?;
-	if resp.status() != StatusCode::OK {
-		return Err(Error::Message(format!("HTTP error {}", resp.status())));
-	}
-
-	let body = hyper::body::to_bytes(resp.into_body()).await?;
-	let entries = serde_json::from_slice::<Vec<ConsulQueryEntry>>(body.as_ref())?;
-
-	let mut ret = vec![];
-	for ent in entries {
-		let ip = ent.address.parse::<IpAddr>().ok();
-		let pubkey = ent
-			.node_meta
-			.get("pubkey")
-			.and_then(|k| hex::decode(&k).ok())
-			.and_then(|k| NodeID::from_slice(&k[..]));
-		if let (Some(ip), Some(pubkey)) = (ip, pubkey) {
-			ret.push((pubkey, SocketAddr::new(ip, ent.service_port)));
-		} else {
-			warn!(
-				"Could not process node spec from Consul: {:?} (invalid IP or public key)",
-				ent
-			);
-		}
-	}
-	debug!("Got nodes from Consul: {:?}", ret);
-
-	Ok(ret)
-}
-
-// ---- PUBLISHING TO CONSUL CATALOG ----
-
 #[derive(Serialize, Clone, Debug)]
 struct ConsulPublishEntry {
 	#[serde(rename = "Node")]
@@ -95,57 +46,134 @@ struct ConsulPublishService {
 	port: u16,
 }
 
-pub async fn publish_consul_service(
-	consul_host: &str,
-	consul_service_name: &str,
-	node_id: NodeID,
-	hostname: &str,
-	rpc_public_addr: SocketAddr,
-) -> Result<(), Error> {
-	let node = format!("garage:{}", hex::encode(&node_id[..8]));
+// ----
 
-	let advertisment = ConsulPublishEntry {
-		node: node.clone(),
-		address: rpc_public_addr.ip(),
-		node_meta: [
-			("pubkey".to_string(), hex::encode(node_id)),
-			("hostname".to_string(), hostname.to_string()),
-		]
-		.iter()
-		.cloned()
-		.collect(),
-		service: ConsulPublishService {
-			service_id: node.clone(),
-			service_name: consul_service_name.to_string(),
-			tags: vec!["advertised-by-garage".into(), hostname.into()],
-			address: rpc_public_addr.ip(),
-			port: rpc_public_addr.port(),
-		},
-	};
+pub struct ConsulDiscovery {
+	config: ConsulDiscoveryConfig,
+	client: reqwest::Client,
+}
 
-	let url = format!("http://{}/v1/catalog/register", consul_host);
-	let req_body = serde_json::to_string(&advertisment)?;
-	debug!("Request body for consul adv: {}", req_body);
+impl ConsulDiscovery {
+	pub fn new(config: ConsulDiscoveryConfig) -> Result<Self, ConsulError> {
+		let client = match (&config.client_cert, &config.client_key) {
+			(Some(client_cert), Some(client_key)) => {
+				let mut client_cert_buf = vec![];
+				File::open(client_cert)?.read_to_end(&mut client_cert_buf)?;
 
-	let req = Request::builder()
-		.uri(url)
-		.method(Method::PUT)
-		.body(Body::from(req_body))?;
+				let mut client_key_buf = vec![];
+				File::open(client_key)?.read_to_end(&mut client_key_buf)?;
 
-	let client = Client::new();
+				let identity = reqwest::Identity::from_pem(
+					&[&client_cert_buf[..], &client_key_buf[..]].concat()[..],
+				)?;
 
-	let resp = client.request(req).await?;
-	debug!("Response of advertising to Consul: {:?}", resp);
-	let resp_code = resp.status();
-	let resp_bytes = &hyper::body::to_bytes(resp.into_body()).await?;
-	debug!(
-		"{}",
-		std::str::from_utf8(resp_bytes).unwrap_or("<invalid utf8>")
-	);
+				if config.tls_skip_verify {
+					reqwest::Client::builder()
+						.use_rustls_tls()
+						.danger_accept_invalid_certs(true)
+						.identity(identity)
+						.build()?
+				} else if let Some(ca_cert) = &config.ca_cert {
+					let mut ca_cert_buf = vec![];
+					File::open(ca_cert)?.read_to_end(&mut ca_cert_buf)?;
 
-	if resp_code != StatusCode::OK {
-		return Err(Error::Message(format!("HTTP error {}", resp_code)));
+					reqwest::Client::builder()
+						.use_rustls_tls()
+						.add_root_certificate(reqwest::Certificate::from_pem(&ca_cert_buf[..])?)
+						.identity(identity)
+						.build()?
+				} else {
+					reqwest::Client::builder()
+						.use_rustls_tls()
+						.identity(identity)
+						.build()?
+				}
+			}
+			(None, None) => reqwest::Client::new(),
+			_ => return Err(ConsulError::InvalidTLSConfig),
+		};
+
+		Ok(Self { client, config })
 	}
 
-	Ok(())
+	// ---- READING FROM CONSUL CATALOG ----
+
+	pub async fn get_consul_nodes(&self) -> Result<Vec<(NodeID, SocketAddr)>, ConsulError> {
+		let url = format!(
+			"{}/v1/catalog/service/{}",
+			self.config.consul_http_addr, self.config.service_name
+		);
+
+		let http = self.client.get(&url).send().await?;
+		let entries: Vec<ConsulQueryEntry> = http.json().await?;
+
+		let mut ret = vec![];
+		for ent in entries {
+			let ip = ent.address.parse::<IpAddr>().ok();
+			let pubkey = ent
+				.node_meta
+				.get("pubkey")
+				.and_then(|k| hex::decode(&k).ok())
+				.and_then(|k| NodeID::from_slice(&k[..]));
+			if let (Some(ip), Some(pubkey)) = (ip, pubkey) {
+				ret.push((pubkey, SocketAddr::new(ip, ent.service_port)));
+			} else {
+				warn!(
+					"Could not process node spec from Consul: {:?} (invalid IP or public key)",
+					ent
+				);
+			}
+		}
+		debug!("Got nodes from Consul: {:?}", ret);
+
+		Ok(ret)
+	}
+
+	// ---- PUBLISHING TO CONSUL CATALOG ----
+
+	pub async fn publish_consul_service(
+		&self,
+		node_id: NodeID,
+		hostname: &str,
+		rpc_public_addr: SocketAddr,
+	) -> Result<(), ConsulError> {
+		let node = format!("garage:{}", hex::encode(&node_id[..8]));
+
+		let advertisement = ConsulPublishEntry {
+			node: node.clone(),
+			address: rpc_public_addr.ip(),
+			node_meta: [
+				("pubkey".to_string(), hex::encode(node_id)),
+				("hostname".to_string(), hostname.to_string()),
+			]
+			.iter()
+			.cloned()
+			.collect(),
+			service: ConsulPublishService {
+				service_id: node.clone(),
+				service_name: self.config.service_name.clone(),
+				tags: vec!["advertised-by-garage".into(), hostname.into()],
+				address: rpc_public_addr.ip(),
+				port: rpc_public_addr.port(),
+			},
+		};
+
+		let url = format!("{}/v1/catalog/register", self.config.consul_http_addr);
+
+		let http = self.client.put(&url).json(&advertisement).send().await?;
+		http.error_for_status()?;
+
+		Ok(())
+	}
+}
+
+/// Regroup all Consul discovery errors
+#[derive(Debug, Error)]
+pub enum ConsulError {
+	#[error(display = "IO error: {}", _0)]
+	Io(#[error(source)] std::io::Error),
+	#[error(display = "HTTP error: {}", _0)]
+	Reqwest(#[error(source)] reqwest::Error),
+	#[error(display = "Invalid Consul TLS configuration")]
+	InvalidTLSConfig,
 }

src/rpc/kubernetes.rs

@@ -12,6 +12,8 @@ use serde::{Deserialize, Serialize};
 
 use netapp::NodeID;
 
+use garage_util::config::KubernetesDiscoveryConfig;
+
 static K8S_GROUP: &str = "deuxfleurs.fr";
 
 #[derive(CustomResource, Debug, Serialize, Deserialize, Clone, JsonSchema)]
@@ -41,15 +43,14 @@ pub async fn create_kubernetes_crd() -> Result<(), kube::Error> {
 }
 
 pub async fn get_kubernetes_nodes(
-	kubernetes_service_name: &str,
-	kubernetes_namespace: &str,
+	kubernetes_config: &KubernetesDiscoveryConfig,
 ) -> Result<Vec<(NodeID, SocketAddr)>, kube::Error> {
 	let client = Client::try_default().await?;
-	let nodes: Api<GarageNode> = Api::namespaced(client.clone(), kubernetes_namespace);
+	let nodes: Api<GarageNode> = Api::namespaced(client.clone(), &kubernetes_config.namespace);
 
 	let lp = ListParams::default().labels(&format!(
 		"garage.{}/service={}",
-		K8S_GROUP, kubernetes_service_name
+		K8S_GROUP, kubernetes_config.service_name
 	));
 
 	let nodes = nodes.list(&lp).await?;
@@ -73,8 +74,7 @@ pub async fn get_kubernetes_nodes(
 }
 
 pub async fn publish_kubernetes_node(
-	kubernetes_service_name: &str,
-	kubernetes_namespace: &str,
+	kubernetes_config: &KubernetesDiscoveryConfig,
 	node_id: NodeID,
 	hostname: &str,
 	rpc_public_addr: SocketAddr,
@@ -93,13 +93,13 @@ pub async fn publish_kubernetes_node(
 	let labels = node.metadata.labels.insert(BTreeMap::new());
 	labels.insert(
 		format!("garage.{}/service", K8S_GROUP),
-		kubernetes_service_name.to_string(),
+		kubernetes_config.service_name.to_string(),
 	);
 
 	debug!("Node object to be applied: {:#?}", node);
 
 	let client = Client::try_default().await?;
-	let nodes: Api<GarageNode> = Api::namespaced(client.clone(), kubernetes_namespace);
+	let nodes: Api<GarageNode> = Api::namespaced(client.clone(), &kubernetes_config.namespace);
 
 	if let Ok(old_node) = nodes.get(&node_pubkey).await {
 		node.metadata.resource_version = old_node.metadata.resource_version;

src/rpc/lib.rs

@@ -3,6 +3,7 @@
 #[macro_use]
 extern crate tracing;
 
+#[cfg(feature = "consul-discovery")]
 mod consul;
 #[cfg(feature = "kubernetes-discovery")]
 mod kubernetes;

src/rpc/system.rs

@@ -23,12 +23,15 @@ use netapp::{NetApp, NetworkKey, NodeID, NodeKey};
 
 use garage_util::background::BackgroundRunner;
 use garage_util::config::Config;
+#[cfg(feature = "kubernetes-discovery")]
+use garage_util::config::KubernetesDiscoveryConfig;
 use garage_util::data::*;
 use garage_util::error::*;
 use garage_util::persister::Persister;
 use garage_util::time::*;
 
-use crate::consul::*;
+#[cfg(feature = "consul-discovery")]
+use crate::consul::ConsulDiscovery;
 #[cfg(feature = "kubernetes-discovery")]
 use crate::kubernetes::*;
 use crate::layout::*;
@@ -90,12 +93,14 @@ pub struct System {
 	system_endpoint: Arc<Endpoint<SystemRpc, System>>,
 
 	rpc_listen_addr: SocketAddr,
+	#[cfg(any(feature = "consul-discovery", feature = "kubernetes-discovery"))]
 	rpc_public_addr: Option<SocketAddr>,
 	bootstrap_peers: Vec<String>,
 
-	consul_discovery: Option<ConsulDiscoveryParam>,
+	#[cfg(feature = "consul-discovery")]
+	consul_discovery: Option<ConsulDiscovery>,
 	#[cfg(feature = "kubernetes-discovery")]
-	kubernetes_discovery: Option<KubernetesDiscoveryParam>,
+	kubernetes_discovery: Option<KubernetesDiscoveryConfig>,
 
 	replication_factor: usize,
 
@@ -285,29 +290,21 @@ impl System {
 
 		let system_endpoint = netapp.endpoint(SYSTEM_RPC_PATH.into());
 
-		let consul_discovery = match (&config.consul_host, &config.consul_service_name) {
-			(Some(ch), Some(csn)) => Some(ConsulDiscoveryParam {
-				consul_host: ch.to_string(),
-				service_name: csn.to_string(),
-			}),
-			_ => None,
-		};
-
-		#[cfg(feature = "kubernetes-discovery")]
-		let kubernetes_discovery = match (
-			&config.kubernetes_service_name,
-			&config.kubernetes_namespace,
-		) {
-			(Some(ksn), Some(kn)) => Some(KubernetesDiscoveryParam {
-				service_name: ksn.to_string(),
-				namespace: kn.to_string(),
-				skip_crd: config.kubernetes_skip_crd,
-			}),
-			_ => None,
+		#[cfg(feature = "consul-discovery")]
+		let consul_discovery = match &config.consul_discovery {
+			Some(cfg) => Some(
+				ConsulDiscovery::new(cfg.clone())
+					.ok_or_message("Invalid Consul discovery configuration")?,
+			),
+			None => None,
 		};
+		#[cfg(not(feature = "consul-discovery"))]
+		if config.consul_discovery.is_some() {
+			warn!("Consul discovery is not enabled in this build.");
+		}
 
 		#[cfg(not(feature = "kubernetes-discovery"))]
-		if config.kubernetes_service_name.is_some() || config.kubernetes_namespace.is_some() {
+		if config.kubernetes_discovery.is_some() {
 			warn!("Kubernetes discovery is not enabled in this build.");
 		}
 
@@ -329,11 +326,13 @@ impl System {
 			system_endpoint,
 			replication_factor,
 			rpc_listen_addr: config.rpc_bind_addr,
+			#[cfg(any(feature = "consul-discovery", feature = "kubernetes-discovery"))]
 			rpc_public_addr,
 			bootstrap_peers: config.bootstrap_peers.clone(),
+			#[cfg(feature = "consul-discovery")]
 			consul_discovery,
 			#[cfg(feature = "kubernetes-discovery")]
-			kubernetes_discovery,
+			kubernetes_discovery: config.kubernetes_discovery.clone(),
 
 			ring,
 			update_ring: Mutex::new(update_ring),
@@ -369,7 +368,9 @@ impl System {
 				id: n.id.into(),
 				addr: n.addr,
 				is_up: n.is_up(),
-				last_seen_secs_ago: n.last_seen.map(|t| (Instant::now() - t).as_secs()),
+				last_seen_secs_ago: n
+					.last_seen
+					.map(|t| (Instant::now().saturating_duration_since(t)).as_secs()),
 				status: node_status
 					.get(&n.id.into())
 					.cloned()
@@ -430,6 +431,7 @@ impl System {
 
 	// ---- INTERNALS ----
 
+	#[cfg(feature = "consul-discovery")]
 	async fn advertise_to_consul(self: Arc<Self>) -> Result<(), Error> {
 		let c = match &self.consul_discovery {
 			Some(c) => c,
@@ -444,9 +446,7 @@ impl System {
 			}
 		};
 
-		publish_consul_service(
-			&c.consul_host,
-			&c.service_name,
+		c.publish_consul_service(
 			self.netapp.id,
 			&self.local_status.load_full().hostname,
 			rpc_public_addr,
@@ -471,8 +471,7 @@ impl System {
 		};
 
 		publish_kubernetes_node(
-			&k.service_name,
-			&k.namespace,
+			k,
 			self.netapp.id,
 			&self.local_status.load_full().hostname,
 			rpc_public_addr,
@@ -642,8 +641,9 @@ impl System {
 				}
 
 				// Fetch peer list from Consul
+				#[cfg(feature = "consul-discovery")]
 				if let Some(c) = &self.consul_discovery {
-					match get_consul_nodes(&c.consul_host, &c.service_name).await {
+					match c.get_consul_nodes().await {
 						Ok(node_list) => {
 							ping_list.extend(node_list);
 						}
@@ -665,7 +665,7 @@ impl System {
 						};
 					}
 
-					match get_kubernetes_nodes(&k.service_name, &k.namespace).await {
+					match get_kubernetes_nodes(k).await {
 						Ok(node_list) => {
 							ping_list.extend(node_list);
 						}
@@ -689,6 +689,7 @@ impl System {
 				warn!("Could not save peer list to file: {}", e);
 			}
 
+			#[cfg(feature = "consul-discovery")]
 			self.background.spawn(self.clone().advertise_to_consul());
 
 			#[cfg(feature = "kubernetes-discovery")]
@@ -783,15 +784,3 @@ async fn resolve_peers(peers: &[String]) -> Vec<(NodeID, SocketAddr)> {
 
 	ret
 }
-
-struct ConsulDiscoveryParam {
-	consul_host: String,
-	service_name: String,
-}
-
-#[cfg(feature = "kubernetes-discovery")]
-struct KubernetesDiscoveryParam {
-	service_name: String,
-	namespace: String,
-	skip_crd: bool,
-}

src/table/sync.rs

@@ -607,7 +607,7 @@ impl<F: TableSchema + 'static, R: TableReplication + 'static> Worker for SyncWor
 					self.add_full_sync();
 				}
 			},
-			_ = tokio::time::sleep(self.next_full_sync - Instant::now()) => {
+			_ = tokio::time::sleep_until(self.next_full_sync.into()) => {
 				self.add_full_sync();
 			}
 		}

src/util/config.rs

@@ -46,20 +46,17 @@ pub struct Config {
 	/// Timeout for Netapp RPC calls
 	pub rpc_timeout_msec: Option<u64>,
 
+	// -- Bootstraping and discovery
 	/// Bootstrap peers RPC address
 	#[serde(default)]
 	pub bootstrap_peers: Vec<String>,
-	/// Consul host to connect to to discover more peers
-	pub consul_host: Option<String>,
-	/// Consul service name to use
-	pub consul_service_name: Option<String>,
-	/// Kubernetes namespace the service discovery resources are be created in
-	pub kubernetes_namespace: Option<String>,
-	/// Service name to filter for in k8s custom resources
-	pub kubernetes_service_name: Option<String>,
-	/// Skip creation of the garagenodes CRD
+
+	/// Configuration for automatic node discovery through Consul
 	#[serde(default)]
-	pub kubernetes_skip_crd: bool,
+	pub consul_discovery: Option<ConsulDiscoveryConfig>,
+	/// Configuration for automatic node discovery through Kubernetes
+	#[serde(default)]
+	pub kubernetes_discovery: Option<KubernetesDiscoveryConfig>,
 
 	// -- DB
 	/// Database engine to use for metadata (options: sled, sqlite, lmdb)
@@ -129,6 +126,34 @@ pub struct AdminConfig {
 	pub trace_sink: Option<String>,
 }
 
+#[derive(Deserialize, Debug, Clone)]
+pub struct ConsulDiscoveryConfig {
+	/// Consul http or https address to connect to to discover more peers
+	pub consul_http_addr: String,
+	/// Consul service name to use
+	pub service_name: String,
+	/// CA TLS certificate to use when connecting to Consul
+	pub ca_cert: Option<String>,
+	/// Client TLS certificate to use when connecting to Consul
+	pub client_cert: Option<String>,
+	/// Client TLS key to use when connecting to Consul
+	pub client_key: Option<String>,
+	/// Skip TLS hostname verification
+	#[serde(default)]
+	pub tls_skip_verify: bool,
+}
+
+#[derive(Deserialize, Debug, Clone)]
+pub struct KubernetesDiscoveryConfig {
+	/// Kubernetes namespace the service discovery resources are be created in
+	pub namespace: String,
+	/// Service name to filter for in k8s custom resources
+	pub service_name: String,
+	/// Skip creation of the garagenodes CRD
+	#[serde(default)]
+	pub skip_crd: bool,
+}
+
 fn default_db_engine() -> String {
 	"sled".into()
 }

src/util/metrics.rs

@@ -1,4 +1,4 @@
-use std::time::SystemTime;
+use std::time::Instant;
 
 use futures::{future::BoxFuture, Future, FutureExt};
 use rand::Rng;
@@ -28,10 +28,12 @@ where
 		attributes: &'a [KeyValue],
 	) -> BoxFuture<'a, Self::Output> {
 		async move {
-			let request_start = SystemTime::now();
+			let request_start = Instant::now();
 			let res = self.await;
 			r.record(
-				request_start.elapsed().map_or(0.0, |d| d.as_secs_f64()),
+				Instant::now()
+					.saturating_duration_since(request_start)
+					.as_secs_f64(),
 				attributes,
 			);
 			res
@@ -41,9 +43,13 @@ where
 
 	fn bound_record_duration(self, r: &'a BoundValueRecorder<f64>) -> BoxFuture<'a, Self::Output> {
 		async move {
-			let request_start = SystemTime::now();
+			let request_start = Instant::now();
 			let res = self.await;
-			r.record(request_start.elapsed().map_or(0.0, |d| d.as_secs_f64()));
+			r.record(
+				Instant::now()
+					.saturating_duration_since(request_start)
+					.as_secs_f64(),
+			);
 			res
 		}
 		.boxed()

src/util/tranquilizer.rs

@@ -36,7 +36,7 @@ impl Tranquilizer {
 	}
 
 	fn tranquilize_internal(&mut self, tranquility: u32) -> Option<Duration> {
-		let observation = Instant::now() - self.last_step_begin;
+		let observation = Instant::now().saturating_duration_since(self.last_step_begin);
 
 		self.observations.push_back(observation);
 		self.sum_observations += observation;

src/web/web_server.rs

@@ -318,7 +318,7 @@ fn path_to_key<'a>(path: &'a str, index: &str) -> Result<Cow<'a, str>, Error> {
 		}
 		Some(_) => match path_utf8 {
 			Cow::Borrowed(pu8) => Ok((&pu8[1..]).into()),
-			Cow::Owned(pu8) => Ok((&pu8[1..]).to_string().into()),
+			Cow::Owned(pu8) => Ok(pu8[1..].to_string().into()),
 		},
 	}
 }