cargo: add feature flag which disables nmstate by default

With the latest release for f42 dependencies which are
required for nmstate will no longer be available.
There is a PR which has landed nmstate/nmstate#2820
but a build of nmstate needs to land with those changes in f42.

To prevent issues for coreos-installer add a featureflag to make nmstate
dependency an optional one. If the feature 'use-nmstate' is not available
coreos-installer will lose functionality around customizing network settings.
By adding the feature 'use-nmstate' functionality would be restored.

resolves: #1602

Author: prestist

Cargo.toml

@@ -28,6 +28,9 @@ all-features = true
 # rdcore is only useful inside the initrd of a CoreOS system
 rdcore = []
 docgen = ["clap/string", "dep:clap_mangen"]
+# nmstate has deprecated deps and cannot be used in f42 in its current state
+# nmstate/nmstate#2820 should make allow for this feature to be removed.
+use-nmstate = ["nmstate"]
 
 [lib]
 name = "libcoreinst"
@@ -64,7 +67,7 @@ ignition-config = ">= 0.3, < 0.6"
 lazy_static = "^1.4"
 libc = "^0.2"
 nix = { version = ">= 0.24, < 0.28", "default_features" = false, "features" = [ "dir", "ioctl", "mount", "process", "sched", "signal", "user"] }
-nmstate = { version = ">= 2.2.3, < 3", default-features = false, features = ["gen_conf"] }
+nmstate = { version = ">= 2.2.3, < 3", default-features = false, features = ["gen_conf"], optional = true }
 openssl = "^0.10"
 pipe = ">= 0.3, < 0.5"
 regex = ">= 1.4, < 2"

docs/release-notes.md

@@ -15,6 +15,7 @@ Minor changes:
 
 Internal changes:
 - s390x: Use options and logic compatible with both C-based `genprotimg` and Rust-based `pvimg`
+- nmstate: add feature-flag to remove hard dependency
 
 Packaging changes:
 

src/cmdline/mod.rs

@@ -299,6 +299,7 @@ pub struct CommonCustomizeConfig {
     /// environment, including when Ignition is run.  If installer is enabled
     /// via additional options, network settings will also be applied in the
     /// destination system, including when Ignition is run.
+    #[cfg(feature = "use-nmstate")]
     #[arg(long, value_name = "path")]
     pub network_nmstate: Vec<String>,
     /// Ignition PEM CA bundle for live & dest

src/live/customize.rs

@@ -15,10 +15,12 @@
 //! Infrastructure for high-level ISO/PXE customizations
 
 use anyhow::{bail, Context, Result};
+#[cfg(feature = "use-nmstate")]
 use nmstate::NetworkState;
 use serde::Deserialize;
 use serde_json;
 use std::fs::read;
+#[cfg(feature = "use-nmstate")]
 use std::path::Path;
 
 use crate::cmdline::*;
@@ -122,6 +124,7 @@ impl LiveInitrd {
         for path in &common.network_keyfile {
             conf.network_keyfile(path)?;
         }
+        #[cfg(feature = "use-nmstate")]
         for path in &common.network_nmstate {
             conf.network_nmstate(path)?;
         }
@@ -201,7 +204,7 @@ impl LiveInitrd {
         self.installer_copy_network = true;
         Ok(())
     }
-
+    #[cfg(feature = "use-nmstate")]
     pub fn network_nmstate(&mut self, path: &str) -> Result<()> {
         if !self.features.live_initrd_network {
             bail!("This OS image does not support customizing network settings.");