nim: Ignore bootstrap and /config/GlobalConfig if onboarded

If we have a /persist/checkpoint/lastconfig we ignore
re-reading those files. They will have been taken into account
in forming /persist/status/nim/DevicePortConfigList/

Signed-off-by: eriknordmark <erik@zededa.com>

Author: eriknordmark

pkg/pillar/cmd/nim/nim.go

@@ -25,6 +25,7 @@ import (
 	"github.com/lf-edge/eve/pkg/pillar/pubsub"
 	"github.com/lf-edge/eve/pkg/pillar/types"
 	fileutils "github.com/lf-edge/eve/pkg/pillar/utils/file"
+	"github.com/lf-edge/eve/pkg/pillar/utils/persist"
 	"github.com/sirupsen/logrus"
 )
 
@@ -186,9 +187,14 @@ func (n *nim) init() (err error) {
 func (n *nim) run(ctx context.Context) (err error) {
 	n.Log.Noticef("Starting %s", agentName)
 
+	// This will re-ingest network configuration from the bootstrap config
+	// (priority) or ImportGlobalConfigFile (fallback) on each boot until
+	// the device is onboarded and has a /persist/checkpoint/lastconfig.
+	ignoreBootstraps := n.hasPersistLastconfig()
+
 	// Check if we have a /config/DevicePortConfig/*.json which we need to
 	// take into account by copying it to /run/global/DevicePortConfig/
-	n.ingestDevicePortConfig()
+	n.ingestDevicePortConfig(ignoreBootstraps)
 
 	// Start DPC Manager.
 	if err = n.dpcManager.Init(ctx); err != nil {
@@ -197,6 +203,12 @@ func (n *nim) run(ctx context.Context) (err error) {
 	installerDPCs := n.listPublishedDPCs(runDevicePortConfigDir)
 	haveBootstrapConf := fileutils.FileExists(n.Log, types.BootstrapConfFileName)
 	expectBootstrapDPCs := len(installerDPCs) > 0 || haveBootstrapConf
+	if expectBootstrapDPCs && ignoreBootstraps {
+		n.Log.Noticef("Not ingesting bootstrap config from config partition: " +
+			"/persist/checkpoint/lastconfig is present")
+		expectBootstrapDPCs = false
+	}
+
 	if err = n.dpcManager.Run(ctx, expectBootstrapDPCs); err != nil {
 		return err
 	}
@@ -313,6 +325,21 @@ func (n *nim) run(ctx context.Context) (err error) {
 	}
 }
 
+// Check if we have /persist/checkpoint/lastconfig
+// Does not verify they will be used since we do not do the protobuf decode
+// nor check the signature.
+func (n *nim) hasPersistLastconfig() bool {
+	contents, _, err := persist.ReadSavedConfig(n.Log, "lastconfig")
+	if err == nil && len(contents) != 0 {
+		return true
+	}
+	contents, _, err = persist.ReadSavedConfig(n.Log, "lastconfig.bak")
+	if err == nil && len(contents) != 0 {
+		return true
+	}
+	return false
+}
+
 func (n *nim) initPublications() (err error) {
 	n.pubDeviceNetworkStatus, err = n.PubSub.NewPublication(
 		pubsub.PublicationOptions{
@@ -856,13 +883,19 @@ func (n *nim) listPublishedDPCs(directory string) (dpcFilePaths []string) {
 
 // ingestPortConfig reads all json files in configDevicePortConfigDir, ensures
 // they have a TimePriority, and then writes to runDevicePortConfigDir.
-// XXX do we need something to avoid re-application of the same file?
-// Or is it sufficient to depend on the fact that we only do this until we have
-// a /persist/checkpoint/lastconfig from the controller? Do we check that in nim?
-func (n *nim) ingestDevicePortConfig() {
+func (n *nim) ingestDevicePortConfig(ignoreBootstraps bool) {
 	dpcFiles := n.listPublishedDPCs(configDevicePortConfigDir)
+	if len(dpcFiles) == 0 {
+		return
+	}
+	if ignoreBootstraps {
+		n.Log.Noticef("Not ingesting DPC jsons (%v) from config partition: "+
+			"/persist/checkpoint/lastconfig is present",
+			strings.Join(dpcFiles, ", "))
+		return
+	}
 	// Skip these legacy DPC json files if there is bootstrap config.
-	if fileutils.FileExists(n.Log, types.BootstrapConfFileName) && len(dpcFiles) > 0 {
+	if fileutils.FileExists(n.Log, types.BootstrapConfFileName) {
 		n.Log.Noticef("Not ingesting DPC jsons (%v) from config partition: "+
 			"bootstrap config is present", strings.Join(dpcFiles, ", "))
 		return

pkg/pillar/cmd/zedagent/handleconfig.go

@@ -315,8 +315,6 @@ func maybeLoadBootstrapConfig(getconfigCtx *getconfigContext) {
 	case obsoleteConfig:
 		log.Error("Bootstrap config is obsolete")
 	}
-	// XXX should we save it as /persist/checkpoint/lastconfig if we
-	// have no such file?
 }
 
 func indicateInvalidBootstrapConfig(getconfigCtx *getconfigContext) {
@@ -786,7 +784,6 @@ func requestConfigByURL(getconfigCtx *getconfigContext, url string,
 			// can be used to enable the local keyboard etc for
 			// debugging purposes.
 			confName := "lastconfig"
-			// XXX do we know bootreason?
 			if !ctx.bootReason.StartWithSavedConfig() {
 				log.Warnf("Use backup config due to boot reason %s",
 					ctx.bootReason.String())

pkg/pillar/cmd/zedagent/zedagent.go

@@ -426,9 +426,6 @@ func Run(ps *pubsub.PubSub, loggerArg *logrus.Logger, logArg *base.LogObject, ar
 	// Does NOT publish yet since we want to get any bootstrap or
 	foundCheckpoint := initializeConfigItemValueMap(zedagentCtx)
 
-	// XXX should a bootstrap or /config/GlobalConfig file be able
-	// to override a checkpoint? Do we need to handle such after the first
-	// boot? Here we only look if no /persist/checkpoint/lastconfig.
 	if !foundCheckpoint {
 		// Load bootstrap configuration if present.
 		maybeLoadBootstrapConfig(getconfigCtx)