Removing debugging.

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

.woodpecker/helm.yaml

@@ -0,0 +1,38 @@
+steps:
+  helm:
+    when:
+      - event: pull_request
+        branch: main-v2
+      - event: push
+        branch: main-v2
+    image: alpine/helm:4.1.1
+    environment:
+      chart_dir: script/helm/garage
+      chart_name: garage
+      registry_host: codeberg.org
+      registry_user: ${CI_REPO_OWNER}
+      registry_path: ${CI_REPO}
+
+      # To create registry_password:
+      # 1. Go to https://codeberg.org/user/settings/applications.
+      # 2. Create a token with these settings:
+      #   - Token name: https://git.deuxfleurs.fr/3uzbcqje/garage/src/branch/main-v2/.woodpecker/helm.yaml
+      #   - Set package permission to "Read and write".
+      # 3. Click "Generate token".
+      # 4. Copy the token.
+      # 5. Log into https://ci.codeberg.org.
+      # 6. Find your repo, and add a secret with these settings:
+      #   - Name: registry_password
+      #   - Value: <the token you copied earlier>
+      # 7. Click "Add secret".
+
+      registry_password:
+        from_secret: registry_password
+
+    commands:
+      - |
+        if [[ "${CI_PIPELINE_EVENT}" == "push" && "${CI_COMMIT_BRANCH}" == "${CI_REPO_DEFAULT_BRANCH}" ]]; then
+          ./pipeline.sh push
+        else
+          ./pipeline.sh
+        fi

doc/book/quick-start/_index.md

@@ -133,12 +133,17 @@ Use the following command to launch the Garage server:
 garage server --single-node --default-bucket
 ```
 
-The `--single-node` flag instructs Garage to automatically configure a single-node cluster without data replication.
+- the `--single-node` flag instructs Garage to automatically configure a
-The `--default-bucket` flag instructs Garage to create a default access key and a default bucket using the environment variables we defined above.
+  single-node cluster without data replication;
-Both flags are optional and can be omitted, in which case you will have to follow manual configuration steps described below.
+- the `--default-bucket` flag instructs Garage to create a default access key
+  and a default bucket using the environment variables we defined above (it
+  implies `--default-access-key`).
 
-**For older versions of Garage (before v2.3.0):** automatic configuration using `--single-node` and `--default-bucket` is not available,
+> You can refer to the [manual configuration
-you must follow the manual configuration steps.
+> steps](#manual-configuration) if:
+>
+> - you decide to no use these optional flags;
+> - you are running an **older version of Garage (before v2.3.0)**.
 
 Alternatively, if you cannot or do not wish to run the Garage binary directly,
 you may use Docker to run Garage in a container using the following command:
@@ -292,7 +297,7 @@ An exhaustive list is maintained in the ["Integrations" > "Browsing tools" secti
 
 
 
-## Manual configuration
+## Manual configuration {#manual-configuration}
 
 This section provides instructions that are equivalent to using the
 `--single-node` and `--default-bucket` flags for automatic configuration.  If

doc/book/reference-manual/configuration.md

@@ -175,6 +175,9 @@ they do not exist in the configuration file:
   Garage daemon send its logs to `journald` (using the native protocol of `systemd-journald`)
   instead of printing to stderr.
 
+- `NO_COLOR` (since `v2.4.0`): set this to `0` or `false` to disable
+  ANSI color codes in Garage's logs.
+
 The following environment variables can be used to override the corresponding
 values in the configuration file:
 

doc/book/reference-manual/k2v.md

@@ -8,12 +8,11 @@ which is an alternative storage API designed to help efficiently store
 many small values in buckets (in opposition to S3 which is more designed
 to store large blobs).
 
-K2V is currently disabled at compile time in all builds, as the
+K2V is included in release builds since version 0.8.0. Precompiled builds
-specification is still subject to changes. To build a Garage version with
+of earlier versions including `k2v` can be found in our download page under
-K2V, the Cargo feature flag `k2v` must be activated.  Special builds with
+"Extra builds": they can be easily identified as their tag name ends with
-the `k2v` feature flag enabled can be obtained from our download page under
+`-k2v` (example: `v0.7.2-k2v`). Otherwise, when compiling Garage, the Cargo
-"Extra builds": such builds can be identified easily as their tag name ends
+feature flag `k2v` must be activated.
-with `-k2v` (example: `v0.7.2-k2v`).
 
 The specification of the K2V API can be found
 [here](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/commit/f8be15c37db857e177d543de7be863692628d567/doc/drafts/k2v-spec.md).

pipeline.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/
+# Not using "-x" because we aren't debugging.
+set -Eeuo pipefail
+
+# We get unbound var err if we don't set arg
+arg="${1:-}"
+
+echo "${registry_password}" | helm registry login -u "${registry_user}" --password-stdin "${registry_host}"
+helm lint "${chart_dir}"
+chart_version=$(grep '^version: ' "${chart_dir}/Chart.yaml" | cut -d' ' -f 2)
+helm package "${chart_dir}"
+
+# If chart already exists in the chart repository, don't push.
+if helm pull "oci://${registry_host}/${registry_path}/${chart_name}" --version "${chart_version}" &> /dev/null; then
+  echo -e "\e[31mWARNING: Chart ${chart_name} version ${chart_version} already exists in the repository.\nThis means that the chart's code has not changed, or you forgot to update the version in Chart.yaml.\e[0m"
+else
+  if [[ $arg == 'push' ]]; then
+    helm push "${chart_name}-${chart_version}.tgz" "oci://${registry_host}/${registry_path}"
+  fi
+fi

script/dev-bucket.sh

@@ -18,7 +18,7 @@ fi
 
 $GARAGE_BIN -c /tmp/config.1.toml bucket create eprouvette
 if [ "$GARAGE_OLDVER" = "v08" ]; then
-	KEY_INFO=$($GARAGE_BIN -c /tmp/config.1.toml key create opérateur)
+	KEY_INFO=$($GARAGE_BIN -c /tmp/config.1.toml key new --name opérateur)
 	ACCESS_KEY=`echo $KEY_INFO|grep -Po 'GK[a-f0-9]+'`
 	SECRET_KEY=`echo $KEY_INFO|grep -Po 'Secret key: [a-f0-9]+'|grep -Po '[a-f0-9]+$'`
 elif [ "$GARAGE_OLDVER" = "v1" ]; then

src/garage/main.rs

@@ -276,6 +276,11 @@ fn init_logging(opt: &Opt) {
 	tracing_subscriber::fmt()
 		.with_writer(std::io::stderr)
 		.with_env_filter(env_filter)
+		.with_ansi(
+			std::env::var("NO_COLOR")
+				.map(|x| x != "0" && !x.eq_ignore_ascii_case("false"))
+				.unwrap_or(true),
+		)
 		.init();
 }
 

src/garage/server.rs

@@ -152,6 +152,14 @@ pub async fn run_server(
 		}
 	}
 
+	// Deregister from Consul (if enabled) in the background, in parallel with the
+	// rest of the shutdown sequence, so that it doesn't add to shutdown latency.
+	#[cfg(feature = "consul-discovery")]
+	let deregister_consul_task = tokio::spawn({
+		let system = garage.system.clone();
+		async move { system.deregister_from_discovery().await }
+	});
+
 	// Remove RPC handlers for system to break reference cycles
 	info!("Deregistering RPC handlers for shutdown...");
 	garage.system.netapp.drop_all_handlers();
@@ -168,6 +176,12 @@ pub async fn run_server(
 	// Await for all background tasks to end
 	await_background_done.await?;
 
+	// Await for Consul deregistration to end, if it hasn't already
+	#[cfg(feature = "consul-discovery")]
+	if let Err(e) = deregister_consul_task.await {
+		error!("Error while joining Consul deregistration task: {}", e);
+	}
+
 	info!("Cleaning up...");
 
 	Ok(())

src/rpc/consul.rs

@@ -183,6 +183,36 @@ impl ConsulDiscovery {
 	}
 	// ---- PUBLISHING TO CONSUL CATALOG ----
 
+	#[cfg(feature = "consul-discovery")]
+	pub async fn deregister_consul_service(&self, node_id: NodeID) -> Result<(), ConsulError> {
+		let node = format!("garage:{}", hex::encode(&node_id[..8]));
+		let url = format!(
+			"{}/v1/{}",
+			self.config.consul_http_addr,
+			(match &self.config.api {
+				ConsulDiscoveryAPI::Catalog => format!("catalog/deregister"),
+				ConsulDiscoveryAPI::Agent => format!("agent/service/deregister/{}", node),
+			})
+		);
+
+		let req = self.client.put(&url);
+
+		let http = if matches!(&self.config.api, ConsulDiscoveryAPI::Catalog) {
+			let deregister_request = serde_json::json!({
+				"Node": node,
+				"ServiceID": node,
+			});
+			let req = req.json(&deregister_request);
+			req.send().await?
+		} else {
+			req.send().await?
+		};
+		http.error_for_status()?;
+
+		debug!("Deregistered service {} from Consul", node);
+		Ok(())
+	}
+
 	pub async fn publish_consul_service(
 		&self,
 		node_id: NodeID,

src/rpc/system.rs

@@ -358,7 +358,7 @@ impl System {
 		);
 	}
 
-	pub fn cleanup(&self) {
+	pub fn cleanup(self: &Arc<Self>) {
 		// Break reference cycle
 		self.metrics.store(None);
 	}
@@ -650,6 +650,15 @@ impl System {
 		}
 	}
 
+	#[cfg(feature = "consul-discovery")]
+	pub async fn deregister_from_discovery(self: &Arc<Self>) {
+		if let Some(c) = &self.consul_discovery {
+			if let Err(e) = c.deregister_consul_service(self.netapp.id).await {
+				error!("Error while deregistering from Consul: {}", e);
+			}
+		}
+	}
+
 	async fn discovery_loop(self: &Arc<Self>, mut stop_signal: watch::Receiver<bool>) {
 		while !*stop_signal.borrow() {
 			let peers_up = self