VOL-4032 documentation updates
Change-Id: I773070ef95e5f8172d5f0398b64405eb32f81bb9
diff --git a/VERSION b/VERSION
index 5bc4571..658aed9 100644
--- a/VERSION
+++ b/VERSION
@@ -1,2 +1,2 @@
-1.0.0
+1.0.1
diff --git a/dmi.pb b/dmi.pb
index 703189e..96a47eb 100644
--- a/dmi.pb
+++ b/dmi.pb
Binary files differ
diff --git a/docs/DeviceImageManagement.md b/docs/DeviceImageManagement.md
index 014859e..dc70f16 100644
--- a/docs/DeviceImageManagement.md
+++ b/docs/DeviceImageManagement.md
@@ -41,3 +41,7 @@
Some of the devices have the concept of a running and a startup configuration. The running configuration is what gets created/updated at runtime and would be dependant on what the Device Manager or VOLTHA asks the device to do. For these type of devices, every time the device boots up, it overrides it's running configuration with the startup configuration.
The API UpdateStartupConfiguration can be used to modify this startup configuration of the devices. Most of the standard running configuration would come from VOLTHA or the Device Manager, but there could/would be some properitary configuration that the devices need and this can be modified using this API.
+
+The below diagram shows the FSM state transitions for the device image management.
+
+
diff --git a/docs/EventsMetrics.md b/docs/EventsMetrics.md
index e482365..443c85b 100644
--- a/docs/EventsMetrics.md
+++ b/docs/EventsMetrics.md
@@ -29,4 +29,4 @@
```
Note: The on-demand metrics query using the API `GetMetric` would be passed back over GRPC and not over the kafka bus.
-The device shall not locally persist the events across the reboot. The NEM implementations are expected to purge all the unresolved events (events for which the corresponding RECOVERED events have not yet been sent) on the device reboot, as the device shall detect and report the events afresh after the reboot.
+The device/device manager implementations shall persist the active events across the device reboot. On the device reboot, the alarms which are no longer active shall be cleared.
diff --git a/docs/images/device_image_management_fsm.drawio b/docs/images/device_image_management_fsm.drawio
new file mode 100644
index 0000000..42f14d0
--- /dev/null
+++ b/docs/images/device_image_management_fsm.drawio
@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2021-08-24T08:57:10.250Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36" etag="scmzSeVGdFex3GV5x4-M" version="14.9.8" type="google"><diagram id="NcIS7sIEoV0WtFvUQZnj" name="Page-1">7Vtbk6I4FP41PnYXEC76aCvtWuWlq7Vnup+moqSVLTQOxtv++g2SCOHiwEgDzm7VVA05HJJwLl++c7AboLM69ly4WQ6xhZyGIlnHBug2FEVWFaXh/ZOsky8xgOELFq5tMaVAMLH/QUwoMenOttBWUCQYO8TeiMI5Xq/RnAgy6Lr4IKp9YkdcdQMXKCaYzKETl363LbL0pU1FD+R/IXux5CvLesu/s4Jcmb3JdgktfAiJgNkAHRdj4l+tjh3keMbjdvGfe065e9mYi9YkywMfr+/HnQkcd2X8nC2Gs/189vagsr2RE39hZNH3Z0PskiVe4DV0zED65OLd2kLerBIdBToDjDdUKFPh34iQE3Mm3BFMRUuycthdumH39O49/6jx4Qeb7jzoHoXRiY3ib8yMsMU7d46uvCaPHOguELmix4LVs0FoAWbPHsIrRPdDFVzkQGLvxRiBLNQWFz32aNt14SmksMH2mmxDM794AqrAskZtNf0ZWc7ImuBZeuHPyEehrQWis/dzRILmL7mHzo69VkPRHWqsp0983lwQI/rPHeY3HrZnL7epgqxujmcv8fv0auH938WHtYOh1V95ycZmpZv0J/Z1EuNwAGcUToTYgY69WNPrOY0B5FLBHrnEpvnaZjdWtmX5YYro1uDsPJ8XPczqdHLtqaF12f5ZkMpqYnxdyxlvYXRsJIAQW1TIcyF82FMP0iMARkvwNQ/VfBEWhBBXwZ+fWxrqYtgUEihAqwQzjjZ5D12f8eJR0dgwQAxvwAHjAjSyADMB6qQAza8Do2jgkbVaII8eRR5FE8+UX+jrUglIBfQYVL0iLxuneELg2pqdGNDcDaLwlCoEUnRdatYdQ+SYB99GXfO5PzK7P/gBMXP52TCZtqdmzJ0BpHhePCxtgiYbeM7GA+WiopNTMzhm8lTTKnIkNzhFPQS8UOZkbxnihLqUbnnBsHmtaFQJxAxFGRTL2XC4NMKnZMRdvWjYvcmhSioHs+w9z4bO+OWjP+r9CBGp0N2EB/rDds9M0644qVQQSapm1UnFs7rcrPr9SC88gpNPei1y0qtKxAF+qrGnAh/kZSDRdYBaAqOQ44k3RUdyRwyCR+3tDEJ6lGXdEJOy9nSiFfPfZDefo+32v+pCTUzW2jswTgifoe3s3GQWXxbFEWrNjKVmTopTXKmpZ6Q8rYwHRhBMOseD+gZQvCRMIkIjWkkMBn8seQKVVyTNLG54e+m9trtmdh90xsOXgTmtqxs0kEKNquOw8XRoz2niQoLSWyN/UN1YHKg2M4Jq8f27mwIAgCpcXJzZs55RNxY1QIpUn8bXFDXRddQyPujEOXERWPzc7g/Mbk2RGNQOiZV6Edvqv4doWQHVqBWgKsr//rrur+aXQPat7SOjDKRVQCzJ76/9wCO8iPaDCjgDrW/FKKf/4CF0pL2aT+PxNFfF2DW/9TterQJX3gm3nm03IcWanZjR2kUzqj4xQSU/SSoQMQs/uJKRTmnKpXDX6DqlfOLnRgwXsJ1p/1t72h+PEr4Qc1ZaM/5ZfTYp8Y5MHRqrQg/gUvbn6gFcKNHXc6DMTYCacdZ8X0XuqKleQ9/zbyxZ2+oPlCWpLfA7LCk3gnN0ycKJS6VgmdrFnfFw2M9HwXjT/h4YWPTMMCrvWQA5ZpSang3F5Xnm9L2VtWnldByj6+igjDqY/zL6aj4nELl7/wKkSFKitb8ih+kw+JsR33PBX94A818=</diagram></mxfile>
\ No newline at end of file
diff --git a/docs/images/device_image_management_fsm.png b/docs/images/device_image_management_fsm.png
new file mode 100644
index 0000000..f00b035
--- /dev/null
+++ b/docs/images/device_image_management_fsm.png
Binary files differ
diff --git a/protos/dmi/sw_image.proto b/protos/dmi/sw_image.proto
index 08d6327..373795a 100644
--- a/protos/dmi/sw_image.proto
+++ b/protos/dmi/sw_image.proto
@@ -27,15 +27,15 @@
message ImageStatus {
enum ImageState {
- UNDEFINED_STATE = 0;
- COPYING_IMAGE = 1;
- INSTALLING_IMAGE = 2;
- COMMITTING_IMAGE = 3;
- REBOOTING_DEVICE = 4;
- UPGRADE_COMPLETE = 5;
- UPGRADE_FAILED = 6;
- ACTIVATION_COMPLETE = 7;
- ACTIVATION_FAILED = 8;
+ UNDEFINED_STATE = 0; // Initial state
+ COPYING_IMAGE = 1; // Downloading the image on the standby partition
+ INSTALLING_IMAGE = 2; // Installing the image on the standby partition
+ COMMITTING_IMAGE = 3; // Committing the image and marking it as the active partition
+ REBOOTING_DEVICE = 4; // Rebooting the device
+ UPGRADE_COMPLETE = 5; // Image upgrade on the standby partition completed
+ UPGRADE_FAILED = 6; // Image upgrade on the standby partition failed
+ ACTIVATION_COMPLETE = 7; // Image activation completed
+ ACTIVATION_FAILED = 8; // Image activation failed
}
enum Reason {
