From da1637621a1973a4a5c893cb9d3a3deeac5c7f11 Mon Sep 17 00:00:00 2001
From: "Andrew J. Stone" <andrew@oxidecomputer.com>
Date: Mon, 18 Nov 2024 23:45:19 +0000
Subject: [PATCH] Clarify sled-agent method related to datasets

Fixes #7095
---
 sled-agent/src/services.rs | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/sled-agent/src/services.rs b/sled-agent/src/services.rs
index e4de88fab7..a69dd4f29e 100644
--- a/sled-agent/src/services.rs
+++ b/sled-agent/src/services.rs
@@ -3482,7 +3482,11 @@ impl ServiceManager {
     //
     // If the requested zones contain any datasets not configured on this sled,
     // an error is returned.
-    async fn check_requested_zone_datasets_exist(
+    //
+    // In this check the configured datasets are those intended to exist as
+    // written in a ledger. The datasets themselves may not actually physically
+    // exist yet, or they may have failed.
+    async fn check_requested_zone_datasets_configured(
         &self,
         request: &OmicronZonesConfig,
     ) -> Result<(), Error> {
@@ -3544,7 +3548,7 @@ impl ServiceManager {
         new_request: OmicronZonesConfig,
         fake_install_dir: Option<&String>,
     ) -> Result<(), Error> {
-        self.check_requested_zone_datasets_exist(&new_request).await?;
+        self.check_requested_zone_datasets_configured(&new_request).await?;
 
         // Do some data-normalization to ensure we can compare the "requested
         // set" vs the "existing set" as HashSets.