Update iotedge tool for prefer_module_identity_cache (#7085) (#7108)

Update the iotedge tool for the new option introduced in Azure/iot-identity-service#543

edgelet/contrib/config/linux/template.toml

@@ -43,6 +43,20 @@
 #
 # allow_elevated_docker_permissions = false
 
+# ==============================================================================
+# Module identity cache preference
+# ==============================================================================
+#
+# The default behavior is to request module identities from IoT Hub and fall back to a
+# cached backup if the Hub request fails. This keeps identities in sync with IoT Hub,
+# but results in extra requests to Hub that may not be necessary depending on use case.
+#
+# Setting prefer_module_identity_cache to true reverses the behavior so that the cached
+# identities are preferred to IoT Hub requests. Requests to Hub are still made if identities
+# are not found in the cache.
+#
+# prefer_module_identity_cache = false
+
 # ==============================================================================
 # Provisioning
 # ==============================================================================

edgelet/iotedge/src/config/import/mod.rs

@@ -388,6 +388,8 @@ fn execute_inner(
 
             aziot_max_requests: Default::default(),
 
+            prefer_module_identity_cache: Default::default(),
+
             aziot_keys: Default::default(),
 
             preloaded_keys: Default::default(),

edgelet/iotedge/src/config/mp.rs

@@ -72,6 +72,8 @@ To reconfigure IoT Edge, run:
 
             aziot_max_requests: Default::default(),
 
+            prefer_module_identity_cache: Default::default(),
+
             aziot_keys: Default::default(),
 
             preloaded_keys: Default::default(),

edgelet/iotedge/test-files/config/ca-certs-est/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/ca-certs-local-ca/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/ca-certs/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/ca-certs/super-config.toml

@@ -1,6 +1,7 @@
 trust_bundle_cert = "file:///var/secrets/trusted-ca.pem"
 auto_reprovisioning_mode = "OnErrorOnly"
 hostname = "my-device"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/ca-quickstart-custom/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/ca-quickstart/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/ca-quickstart/super-config.toml

@@ -1,5 +1,6 @@
 auto_reprovisioning_mode = "OnErrorOnly"
 hostname = "my-device"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/complex-agent-spec/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/complex-agent-spec/super-config.toml

@@ -1,5 +1,6 @@
 auto_reprovisioning_mode = "OnErrorOnly"
 hostname = "my-device"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "manual"

edgelet/iotedge/test-files/config/dps-no-reprovisioning-flags/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "dps"

edgelet/iotedge/test-files/config/dps-no-reprovisioning-flags/super-config.toml

@@ -1,5 +1,6 @@
 auto_reprovisioning_mode = "OnErrorOnly"
 hostname = "my-device"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "dps"

edgelet/iotedge/test-files/config/dps-symmetric-key-no-pad/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "dps"

edgelet/iotedge/test-files/config/dps-symmetric-key-no-pad/super-config.toml

@@ -1,5 +1,6 @@
 auto_reprovisioning_mode = "Dynamic"
 hostname = "my-device"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "dps"

edgelet/iotedge/test-files/config/dps-symmetric-key/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "dps"

edgelet/iotedge/test-files/config/dps-symmetric-key/super-config.toml

@@ -1,5 +1,6 @@
 auto_reprovisioning_mode = "Dynamic"
 hostname = "my-device"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "dps"

edgelet/iotedge/test-files/config/dps-tpm/identityd.toml

@@ -3,6 +3,7 @@
 
 hostname = "my-device"
 homedir = "/var/lib/aziot/identityd"
+prefer_module_identity_cache = false
 
 [provisioning]
 source = "dps"