From 8f7b5bdc3f303bece8004c434d687987f9e60938 Mon Sep 17 00:00:00 2001
From: David Pacheco <dap@oxidecomputer.com>
Date: Tue, 17 Sep 2024 12:33:23 -0700
Subject: [PATCH] clarify which filesystem "filesystem_pool" describes (#6587)

---
 nexus-sled-agent-shared/src/inventory.rs | 7 +++----
 nexus/types/src/deployment.rs            | 1 +
 openapi/nexus-internal.json              | 1 +
 openapi/sled-agent.json                  | 2 +-
 schema/all-zones-requests.json           | 2 +-
 schema/rss-service-plan-v4.json          | 1 +
 6 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/nexus-sled-agent-shared/src/inventory.rs b/nexus-sled-agent-shared/src/inventory.rs
index faee944105..d695f3a14b 100644
--- a/nexus-sled-agent-shared/src/inventory.rs
+++ b/nexus-sled-agent-shared/src/inventory.rs
@@ -145,11 +145,10 @@ pub struct OmicronZoneConfig {
     pub id: Uuid,
     pub underlay_address: Ipv6Addr,
 
-    /// The pool on which we'll place this zone's filesystem.
+    /// The pool on which we'll place this zone's root filesystem.
     ///
-    /// Note that this is transient -- the sled agent is permitted to
-    /// destroy the zone's dataset on this pool each time the zone is
-    /// initialized.
+    /// Note that the root filesystem is transient -- the sled agent is
+    /// permitted to destroy this dataset each time the zone is initialized.
     pub filesystem_pool: Option<ZpoolName>,
     pub zone_type: OmicronZoneType,
 }
diff --git a/nexus/types/src/deployment.rs b/nexus/types/src/deployment.rs
index fd3e42d5c9..7da2860420 100644
--- a/nexus/types/src/deployment.rs
+++ b/nexus/types/src/deployment.rs
@@ -642,6 +642,7 @@ pub struct BlueprintZoneConfig {
 
     pub id: OmicronZoneUuid,
     pub underlay_address: Ipv6Addr,
+    /// zpool used for the zone's (transient) root filesystem
     pub filesystem_pool: Option<ZpoolName>,
     pub zone_type: BlueprintZoneType,
 }
diff --git a/openapi/nexus-internal.json b/openapi/nexus-internal.json
index da8bbacf8b..8b91b84f54 100644
--- a/openapi/nexus-internal.json
+++ b/openapi/nexus-internal.json
@@ -2094,6 +2094,7 @@
           },
           "filesystem_pool": {
             "nullable": true,
+            "description": "zpool used for the zone's (transient) root filesystem",
             "allOf": [
               {
                 "$ref": "#/components/schemas/ZpoolName"
diff --git a/openapi/sled-agent.json b/openapi/sled-agent.json
index 5e92b4d203..39fe9dd3e0 100644
--- a/openapi/sled-agent.json
+++ b/openapi/sled-agent.json
@@ -3891,7 +3891,7 @@
         "properties": {
           "filesystem_pool": {
             "nullable": true,
-            "description": "The pool on which we'll place this zone's filesystem.\n\nNote that this is transient -- the sled agent is permitted to destroy the zone's dataset on this pool each time the zone is initialized.",
+            "description": "The pool on which we'll place this zone's root filesystem.\n\nNote that the root filesystem is transient -- the sled agent is permitted to destroy this dataset each time the zone is initialized.",
             "allOf": [
               {
                 "$ref": "#/components/schemas/ZpoolName"
diff --git a/schema/all-zones-requests.json b/schema/all-zones-requests.json
index 4d20959ad1..c504474589 100644
--- a/schema/all-zones-requests.json
+++ b/schema/all-zones-requests.json
@@ -241,7 +241,7 @@
       ],
       "properties": {
         "filesystem_pool": {
-          "description": "The pool on which we'll place this zone's filesystem.\n\nNote that this is transient -- the sled agent is permitted to destroy the zone's dataset on this pool each time the zone is initialized.",
+          "description": "The pool on which we'll place this zone's root filesystem.\n\nNote that the root filesystem is transient -- the sled agent is permitted to destroy this dataset each time the zone is initialized.",
           "anyOf": [
             {
               "$ref": "#/definitions/ZpoolName"
diff --git a/schema/rss-service-plan-v4.json b/schema/rss-service-plan-v4.json
index badfaf4589..09a80937d7 100644
--- a/schema/rss-service-plan-v4.json
+++ b/schema/rss-service-plan-v4.json
@@ -37,6 +37,7 @@
           ]
         },
         "filesystem_pool": {
+          "description": "zpool used for the zone's (transient) root filesystem",
           "anyOf": [
             {
               "$ref": "#/definitions/ZpoolName"