add the todos

Author: karencfv

nexus/reconfigurator/planning/src/mgs_updates/host_phase_1.rs

@@ -273,6 +273,8 @@ pub(super) fn try_make_update(
     baseboard_id: &Arc<BaseboardId>,
     inventory: &Collection,
     current_artifacts: &TufRepoDescription,
+// TODO-K: Instead of this convoluted return type use an enum as suggested in
+// https://github.com/oxidecomputer/omicron/pull/9001#discussion_r2372837627
 ) -> Result<
     Option<(PendingMgsUpdate, PendingHostPhase2Changes)>,
     FailedMgsUpdateReason,

nexus/reconfigurator/planning/src/mgs_updates/rot.rs

@@ -107,6 +107,8 @@ pub fn try_make_update_rot(
     baseboard_id: &Arc<BaseboardId>,
     inventory: &Collection,
     current_artifacts: &TufRepoDescription,
+// TODO-K: Like the Host OS, use an enum here as the return type as suggested in
+// https://github.com/oxidecomputer/omicron/pull/9001#discussion_r2372837627
 ) -> Result<Option<PendingMgsUpdate>, FailedMgsUpdateReason> {
     let Some(sp_info) = inventory.sps.get(baseboard_id) else {
         return Err(FailedMgsUpdateReason::SpNotInInventory);

nexus/reconfigurator/planning/src/mgs_updates/rot_bootloader.rs

@@ -62,6 +62,8 @@ pub fn try_make_update_rot_bootloader(
     baseboard_id: &Arc<BaseboardId>,
     inventory: &Collection,
     current_artifacts: &TufRepoDescription,
+// TODO-K: Like the Host OS, use an enum here as the return type as suggested in
+// https://github.com/oxidecomputer/omicron/pull/9001#discussion_r2372837627
 ) -> Result<Option<PendingMgsUpdate>, FailedMgsUpdateReason> {
     let Some(sp_info) = inventory.sps.get(baseboard_id) else {
         return Err(FailedMgsUpdateReason::SpNotInInventory);

nexus/reconfigurator/planning/src/mgs_updates/sp.rs

@@ -61,6 +61,8 @@ pub fn try_make_update_sp(
     baseboard_id: &Arc<BaseboardId>,
     inventory: &Collection,
     current_artifacts: &TufRepoDescription,
+// TODO-K: Like the Host OS, use an enum here as the return type as suggested in
+// https://github.com/oxidecomputer/omicron/pull/9001#discussion_r2372837627
 ) -> Result<Option<PendingMgsUpdate>, FailedMgsUpdateReason> {
     let Some(sp_info) = inventory.sps.get(baseboard_id) else {
         return Err(FailedMgsUpdateReason::SpNotInInventory);

nexus/types/src/deployment/planning_report.rs

@@ -486,6 +486,10 @@ impl PlanningMupdateOverrideStepReport {
 )]
 #[serde(rename_all = "snake_case")]
 #[serde(tag = "type", content = "value")]
+// TODO-K: Separate into enums for each component as suggested in
+// https://github.com/oxidecomputer/omicron/pull/9001#discussion_r2372863166
+// and including more detailed information as suggested in
+// https://github.com/oxidecomputer/omicron/pull/9001#discussion_r2372842378
 pub enum FailedMgsUpdateReason {
     /// The active host phase 1 slot does not match the boot disk
     #[error("active phase 1 slot {0:?} does not match boot disk")]