post-v2.4.0 release dependency upgrades

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

Cargo.toml

@@ -117,11 +117,7 @@ kube = { version = "3.0", default-features = false, features = [
     "rustls-tls",
 ] }
 schemars = "1.2"
-reqwest = { version = "0.13", default-features = false, features = [
-    "rustls-no-provider",
-    "json",
-] }
-
+reqwest = { version = "0.13", default-features = false }
 form_urlencoded = "1.2"
 http = "1.4"
 httpdate = "1.0"

doc/book/cookbook/kubernetes.md

@@ -33,12 +33,27 @@ kubectl apply -k ../k8s/crd
 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:
+For multi-node deployments, cluster layout must be configured manually after deploying, 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
 ```
 
+## Single-node deployments
+
+For a fresh single-node deployment, enable Garage's automatic single-node setup:
+
+```yaml
+garage:
+  singleNode: true
+```
+
+With the chart-generated `garage.toml`, this starts Garage with `--single-node`, runs one StatefulSet replica, and sets `replication_factor = 1`.
+
+If you use `garage.garageTomlString` or `garage.existingConfigMap`, the chart cannot update your configuration file. In that case, make sure your Garage configuration sets `replication_factor = 1`; otherwise Garage will refuse to start in single-node mode.
+
+Garage refuses to run with `--single-node` if the cluster already has a multi-node layout, so this option is intended for new single-node deployments.
+
 ## Overriding default values
 
 All possible configuration values can be found with:

script/helm/garage/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: garage
 description: S3-compatible object store for small self-hosted geo-distributed deployments
 type: application
-version: 0.10.0
+version: 0.10.1
 appVersion: "v2.4.0"
 home: https://garagehq.deuxfleurs.fr/
 icon: https://garagehq.deuxfleurs.fr/images/garage-logo.svg

script/helm/garage/README.md

@@ -1,11 +1,17 @@
 # garage
 
-![Version: 0.9.4](https://img.shields.io/badge/Version-0.9.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.4.0](https://img.shields.io/badge/AppVersion-v2.4.0-informational?style=flat-square)
+![Version: 0.10.1](https://img.shields.io/badge/Version-0.10.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v2.4.0](https://img.shields.io/badge/AppVersion-v2.4.0-informational?style=flat-square)
 
 S3-compatible object store for small self-hosted geo-distributed deployments
 
 **Homepage:** <https://garagehq.deuxfleurs.fr/>
 
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Garage maintainer team | <garagehq@deuxfleurs.fr> |  |
+
 ## Source Code
 
 * <https://git.deuxfleurs.fr/Deuxfleurs/garage.git>
@@ -15,36 +21,42 @@ S3-compatible object store for small self-hosted geo-distributed deployments
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
-| commonLabels  | object | `{}` | Extra labels for all resources |
+| args | list | `[]` | Override the container arguments. |
+| command | list | `[]` | Override the container entrypoint. |
+| commonLabels | object | `{}` | Additional labels to add to all resources created by this chart |
 | deployment.kind | string | `"StatefulSet"` | Switchable to DaemonSet |
 | deployment.podManagementPolicy | string | `"OrderedReady"` | If using statefulset, allow Parallel or OrderedReady (default) |
 | deployment.replicaCount | int | `3` | Number of StatefulSet replicas/garage nodes to start |
-| environment | object | `{}` |  |
-| extraVolumeMounts | object | `{}` |  |
-| extraVolumes | object | `{}` |  |
+| environment | object | `{}` | Extra container env vars, as a list of {name, value} objects (same shape as a Pod container's env) |
+| extraVolumeMounts | object | `{}` | Extra volume mounts, as a list of mount objects (same shape as a container's volumeMounts) |
+| extraVolumes | object | `{}` | Extra volumes, as a list of volume objects (same shape as a PodSpec's volumes) |
 | fullnameOverride | string | `""` |  |
-| garage.blockSize | string | `"1048576"` | Defaults is 1MB An increase can result in better performance in certain scenarios https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#block_size |
+| garage.additionalTopLevelConfig | string | `""` | Additional configuration to append to garage.toml. Use a multi-line string for custom config. Example:  additionalTopLevelConfig: |-    data_fsync = true |
+| garage.admin.apiBindAddr | string | `"[::]:3903"` |  |
+| garage.blockSize | string | `"1048576"` | Defaults is 1MB, an increase can result in better performance in certain scenarios https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#block_size |
 | garage.bootstrapPeers | list | `[]` | This is not required if you use the integrated kubernetes discovery |
 | garage.compressionLevel | string | `"1"` | zstd compression level of stored blocks https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#compression_level |
-| garage.dbEngine | string | `"lmdb"` | Can be changed for better performance on certain systems https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#db_engine |
+| garage.consistencyMode | string | `"consistent"` | By default, enable read-after-write consistency guarantees, see the consistency_mode section at https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#consistency_mode |
+| garage.dbEngine | string | `"lmdb"` | Can be changed for better performance on certain systems, use "sqlite" to prioritize durability https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#db_engine |
 | garage.existingConfigMap | string | `""` | if not empty string, allow using an existing ConfigMap for the garage.toml, if set, ignores garage.toml |
+| garage.existingRpcSecret | string | `""` | If you want to provide an rpcSecret within an existing k8s secret, specify the secret name here, and store the value under the secret key `rpcSecret` the default secret will not be created |
 | garage.garageTomlString | string | `""` | String Template for the garage configuration if set, ignores above values. Values can be templated, see https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/ |
 | garage.kubernetesSkipCrd | bool | `false` | Set to true if you want to use k8s discovery but install the CRDs manually outside of the helm chart, for example if you operate at namespace level without cluster resources |
-| garage.replicationFactor | string | `"3"` | Default to 3 replicas, see the replication_factor section at https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#replication_factor |
-| garage.consistencyMode | string | `"consistent"` | Default to read-after-write consistency, see the consistency_mode section at https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#consistency_mode |
 | garage.metadataAutoSnapshotInterval | string | `""` | If this value is set, Garage will automatically take a snapshot of the metadata DB file at a regular interval and save it in the metadata directory. https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#metadata_auto_snapshot_interval |
-| garage.admin.apiBindAddr | string | `"[::]:3903"` |  |
-| garage.rpcBindAddr | string | `"[::]:3901"` |  |
+| garage.noClusterRole | bool | `false` | Set to true if you want to use roles instead of cluster roles |
+| garage.replicationFactor | string | `"3"` | Default to 3 replicas, see the replication_factor section at https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#replication_factor |
+| garage.rpcBindAddr | string | `"[::]:3901"` | Port used for node-to-node RPC |
 | garage.rpcSecret | string | `""` | If not given, a random secret will be generated and stored in a Secret object |
 | garage.s3.api.bindAddr | string | `"[::]:3900"` |  |
 | garage.s3.api.region | string | `"garage"` |  |
 | garage.s3.api.rootDomain | string | `".s3.garage.tld"` |  |
-| garage.s3.web.index | string | `"index.html"` |  |
 | garage.s3.web.bindAddr | string | `"[::]:3902"` |  |
+| garage.s3.web.index | string | `"index.html"` |  |
 | garage.s3.web.rootDomain | string | `".web.garage.tld"` |  |
+| garage.singleNode | bool | `false` | Start Garage with `--single-node`, run one StatefulSet replica, and render replication_factor = 1 in the generated garage.toml, if using garageTomlString or existingConfigMap, set replication_factor = 1 yourself. |
 | image.pullPolicy | string | `"IfNotPresent"` |  |
 | image.repository | string | `"dxflrs/amd64_garage"` | default to amd64 docker image |
-| image.tag | string | `""` | set the image tag, please prefer using the chart version and not this to avoid compatibility issues |
+| image.tag | string | `""` | set the image tag, please prefer using the chart version and not this, to avoid compatibility issues |
 | imagePullSecrets | list | `[]` | set if you need credentials to pull your custom image |
 | ingress.s3.api.annotations | object | `{}` | Rely _either_ on the className or the annotation below but not both! If you want to use the className, set className: "nginx" and replace "nginx" by an Ingress controller name, examples [here](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers). |
 | ingress.s3.api.enabled | bool | `false` |  |
@@ -81,13 +93,16 @@ S3-compatible object store for small self-hosted geo-distributed deployments
 | persistence.meta.size | string | `"100Mi"` |  |
 | podAnnotations | object | `{}` | additional pod annotations |
 | podSecurityContext.fsGroup | int | `1000` |  |
+| podSecurityContext.fsGroupChangePolicy | string | `"OnRootMismatch"` |  |
 | podSecurityContext.runAsGroup | int | `1000` |  |
 | podSecurityContext.runAsNonRoot | bool | `true` |  |
 | podSecurityContext.runAsUser | int | `1000` |  |
+| priorityClassName | string | `""` | Optional priority class name to assign to the pods. See https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ |
 | readinessProbe | object | `{}` | Specifies a readinessProbe |
 | resources | object | `{}` |  |
 | securityContext.capabilities | object | `{"drop":["ALL"]}` | The default security context is heavily restricted, feel free to tune it to your requirements |
 | securityContext.readOnlyRootFilesystem | bool | `true` |  |
+| service.annotations | object | `{}` | Annotations to add to the service |
 | service.s3.api.port | int | `3900` |  |
 | service.s3.web.port | int | `3902` |  |
 | service.type | string | `"ClusterIP"` | You can rely on any service to expose your cluster - ClusterIP (+ Ingress) - NodePort (+ Ingress) - LoadBalancer |

script/helm/garage/templates/configmap.yaml

@@ -15,7 +15,7 @@ data:
 
     block_size = "{{ .Values.garage.blockSize }}"
 
-    replication_factor = {{ .Values.garage.replicationFactor }}
+    replication_factor = {{ ternary 1 .Values.garage.replicationFactor .Values.garage.singleNode }}
     consistency_mode = "{{ .Values.garage.consistencyMode }}"
 
     compression_level = {{ .Values.garage.compressionLevel }}

script/helm/garage/templates/workload.yaml

@@ -9,7 +9,7 @@ spec:
     matchLabels:
       {{- include "garage.selectorLabels" . | nindent 6 }}
   {{- if eq .Values.deployment.kind "StatefulSet" }}
-  replicas: {{ .Values.deployment.replicaCount }}
+  replicas: {{ ternary 1 .Values.deployment.replicaCount .Values.garage.singleNode }}
   serviceName: {{ include "garage.fullname" . }}-headless
   podManagementPolicy: {{ .Values.deployment.podManagementPolicy }}
   {{- end }}
@@ -59,6 +59,13 @@ spec:
             {{- toYaml .Values.securityContext | nindent 12 }}
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
+          {{- if .Values.garage.singleNode }}
+          command:
+            - /garage
+          args:
+            - server
+            - --single-node
+          {{- end }}
           ports:
             - containerPort: {{ include "garage.portFromBindAddr" .Values.garage.s3.api.bindAddr | int }}
               name: s3-api

script/helm/garage/tests/configmap_test.yaml

@@ -128,6 +128,15 @@ tests:
             # namespace: NAMESPACE
             replication_factor = 7
 
+  - it: forces replication_factor to 1 when garage.singleNode is enabled
+    set:
+      garage.singleNode: true
+      garage.replicationFactor: "5"
+    asserts:
+      - matchRegex:
+          path: data["garage.toml"]
+          pattern: 'replication_factor = 1'
+
   - it: does not render a ConfigMap when an existing one is referenced
     set:
       garage.existingConfigMap: my-external-cm

script/helm/garage/tests/workload_test.yaml

@@ -167,6 +167,33 @@ tests:
           path: spec.template.spec.volumes[0].configMap.name
           value: my-external-cm
 
+  - it: runs a single replica with --single-node when garage.singleNode is enabled
+    template: templates/workload.yaml
+    set:
+      garage.singleNode: true
+      deployment.replicaCount: 3
+    asserts:
+      - equal:
+          path: spec.replicas
+          value: 1
+      - equal:
+          path: spec.template.spec.containers[0].command
+          value:
+            - /garage
+      - equal:
+          path: spec.template.spec.containers[0].args
+          value:
+            - server
+            - --single-node
+
+  - it: does not set a custom command/args when garage.singleNode is disabled
+    template: templates/workload.yaml
+    asserts:
+      - isNull:
+          path: spec.template.spec.containers[0].command
+      - isNull:
+          path: spec.template.spec.containers[0].args
+
   - it: uses a custom service account name without creating one when disabled
     template: templates/workload.yaml
     set:

script/helm/garage/values.yaml

@@ -7,14 +7,13 @@ commonLabels: {}
 #   app.kubernetes.io/part-of: storage
 #   team: platform
 
-# Garage configuration. These values go to garage.toml
+# Garage configuration. These values configure Garage and render to garage.toml unless noted otherwise.
 garage:
-  # -- Can be changed for better performance on certain systems
+  # -- Can be changed for better performance on certain systems, use "sqlite" to prioritize durability
   # https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#db_engine
   dbEngine: "lmdb"
 
-  # -- Defaults is 1MB
-  # An increase can result in better performance in certain scenarios
+  # -- Defaults is 1MB, an increase can result in better performance in certain scenarios
   # https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#block_size
   blockSize: "1048576"
 
@@ -22,6 +21,10 @@ garage:
   # https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#replication_factor
   replicationFactor: "3"
 
+  # -- Start Garage with `--single-node`, run one StatefulSet replica, and render replication_factor = 1 in the generated garage.toml,
+  # if using garageTomlString or existingConfigMap, set replication_factor = 1 yourself.
+  singleNode: false
+
   # -- By default, enable read-after-write consistency guarantees, see the consistency_mode section at
   # https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#consistency_mode
   consistencyMode: "consistent"
@@ -34,6 +37,7 @@ garage:
   # https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#metadata_auto_snapshot_interval
   metadataAutoSnapshotInterval: ""
 
+  # -- Port used for node-to-node RPC
   rpcBindAddr: "[::]:3901"
   # -- If not given, a random secret will be generated and stored in a Secret object
   rpcSecret: ""
@@ -102,7 +106,7 @@ deployment:
 image:
   # -- default to amd64 docker image
   repository: dxflrs/amd64_garage
-  # -- set the image tag, please prefer using the chart version and not this
+  # -- set the image tag, please prefer using the chart version and not this,
   # to avoid compatibility issues
   tag: ""
   pullPolicy: IfNotPresent
@@ -252,6 +256,12 @@ priorityClassName: ""
 # as a Pod container's env)
 environment: {}
 
+# -- Override the container entrypoint.
+command: []
+
+# -- Override the container arguments.
+args: []
+
 # -- Extra volumes, as a list of volume objects (same shape as a PodSpec's volumes)
 extraVolumes: {}
 

src/k2v-client/Cargo.toml

@@ -24,6 +24,7 @@ percent-encoding.workspace = true
 hyper = { workspace = true, default-features = false, features = ["http1", "http2"] }
 hyper-util.workspace = true
 hyper-rustls.workspace = true
+reqwest = { workspace = true, default-features = false, features = ["json", "rustls-no-provider"] }
 serde = { workspace = true, default-features = false, features = ["derive", "std"] }
 serde_json.workspace = true
 thiserror.workspace = true

src/rpc/Cargo.toml

@@ -40,7 +40,7 @@ thiserror = { workspace = true, optional = true }
 kube = { workspace = true, optional = true }
 k8s-openapi = { workspace = true, optional = true }
 schemars = { workspace = true, optional = true }
-reqwest = { workspace = true, optional = true }
+reqwest = { workspace = true, optional = true, features = ["json", "rustls"] }
 
 pnet_datalink.workspace = true