ELCCR-1607 Review existing user documentation and add it to getting started.feature_CPDX-3605feature_CPDX-3405_req3

Change-Id: Ief47399f7a7b1094827aa8606b85c3714fa1d846
Signed-off-by: Toma Bilius <toma.bilius@enea.com>

1 files changed, 125 insertions, 0 deletions

diff --git a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
index 058be40..d1b6f08 100644
--- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
+++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
@@ -526,4 +526,129 @@
       </listitem>
     </orderedlist>
   </section>
+
+  <section id="vnf_snapshots">
+    <title>VNF Snapshots</title>
+
+    <para>The following sections describe the mechanism of saving
+    (snapshotting) and restoring a VNF context on the uCPE device using the
+    Enea Edge Management application.</para>
+
+    <para>It is assumed the uCPE device referenced already contains at least
+    one instantiated VNF, added into the Edge Management application and is
+    connected.</para>
+
+    <section id="vnf_live_snapshot">
+      <title>VNF Live Snapshot</title>
+
+      <para>To perform a snapshot of an existing VNF on a uCPE device, do the
+      following in the Enea Edge Management application:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Select the uCPE device and access the <emphasis
+          role="bold">Configuration</emphasis> menu, then select <emphasis
+          role="bold">Virtual Machines</emphasis> and <emphasis
+          role="bold">VMs</emphasis>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Select a virtual machine and click the <emphasis
+          role="bold">Snapshots..</emphasis> button. The <emphasis
+          role="bold">VM Snapshot Table on &lt;device-name&gt; (IP)</emphasis>
+          window will open.</para>
+        </listitem>
+
+        <listitem>
+          <para>Press the <emphasis role="bold">Create</emphasis> button and
+          the <emphasis role="bold">Create VM Snapshot on &lt;device-name&gt;
+          (IP)</emphasis> window will open.</para>
+        </listitem>
+
+        <listitem>
+          <para>Change the file name, if needed, and press the <emphasis
+          role="bold">Create</emphasis> button. The current popup window will
+          close after a few seconds and a new entry will be shown in the
+          <emphasis role="bold">VM Snapshot Table on &lt;device-name
+          (IP)&gt;</emphasis>.</para>
+
+          <para>On the uCPE device, the snapshot file will be created under
+          <literal>/var/odm/vm_images/snapshots/{vm-id}/</literal> (e.g:
+          <filename>/var/odm/vm_images/snapshots/e1b165f0-2590-11eb-be3a-525400070d85/</filename>).</para>
+        </listitem>
+      </orderedlist>
+    </section>
+
+    <section id="restore_snapshot">
+      <title>Restoring a VNF Snapshot</title>
+
+      <para>When needed, a VNF snapshot can be restored by doing the
+      following:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Select the uCPE device and access the <emphasis
+          role="bold">Configuration</emphasis> menu, then select <emphasis
+          role="bold">Virtual Machines</emphasis> and choose <emphasis
+          role="bold">VMs</emphasis>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Select a virtual machine and press the <emphasis
+          role="bold">Snapshots..</emphasis> button. The <emphasis
+          role="bold">VM Snapshot Table on &lt;device-name&gt; (IP)</emphasis>
+          window will open.</para>
+        </listitem>
+
+        <listitem>
+          <para>Select the snapshot entry from table.</para>
+        </listitem>
+
+        <listitem>
+          <para>Press the <emphasis role="bold">Restore</emphasis> button. A
+          success message will appear in the same window: <literal>Restored VM
+          from snapshot</literal>.</para>
+        </listitem>
+      </orderedlist>
+    </section>
+
+    <section id="delete_snapshot">
+      <title>Deleting a VNF Snapshot</title>
+
+      <para>Deleting an older snapshot can be performed by doing the
+      following:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Select the uCPE device and access the <emphasis
+          role="bold">Configuration</emphasis> menu, then select <emphasis
+          role="bold">Virtual Machines</emphasis> and choose <emphasis
+          role="bold">VMs</emphasis>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Select a virtual machine and press the <emphasis
+          role="bold">Snapshots..</emphasis> button. The <emphasis
+          role="bold">VM Snapshot Table on &lt;device-name&gt; (IP)</emphasis>
+          window will open.</para>
+        </listitem>
+
+        <listitem>
+          <para>Select the snapshot entry from the table.</para>
+        </listitem>
+
+        <listitem>
+          <para>Press the <emphasis role="bold">Delete</emphasis>
+          button.</para>
+        </listitem>
+      </orderedlist>
+
+      <para>A success message will be shown in the same window:
+      <literal>Snapshot deleted</literal>. The snapshot file will be deleted 
+        from the uCPE device and the table will be updated.</para>
+
+      <note><para>Deleting a VNF instance automatically deletes all snapshots
+        associated with it.</para></note>
+    </section>
+  </section>
 </chapter>
\ No newline at end of file