From 4e49c2c2fd68c56f054facddea608dc1a3c3935f Mon Sep 17 00:00:00 2001
From: Luana Mincu <luana.mincu@enea.com>
Date: Mon, 15 Feb 2021 18:35:24 +0200
Subject: ELCCR-1312: Grafana documentation updates

Change-Id: I776b25bff931e2cae042f47c81b9333ab6460e88
---
 .../doc/book.xml                                   |   3 +
 .../doc/grafana.xml                                | 183 +++++++++++++++++++++
 .../doc/images/telemetry_settings.png              | Bin 0 -> 28459 bytes
 .../doc/images/telemetry_start.png                 | Bin 0 -> 13522 bytes
 4 files changed, 186 insertions(+)
 create mode 100644 doc/book-enea-nfv-access-getting-started/doc/grafana.xml
 create mode 100644 doc/book-enea-nfv-access-getting-started/doc/images/telemetry_settings.png
 create mode 100644 doc/book-enea-nfv-access-getting-started/doc/images/telemetry_start.png

(limited to 'doc')

diff --git a/doc/book-enea-nfv-access-getting-started/doc/book.xml b/doc/book-enea-nfv-access-getting-started/doc/book.xml
index d148f3b..fa3fc4f 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/book.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/book.xml
@@ -36,6 +36,9 @@
   <xi:include href="log_collector.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
 
+  <xi:include href="grafana.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude" />
+
   <xi:include href="troubleshooting.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
 </book>
diff --git a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml
new file mode 100644
index 0000000..5f5aaf2
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml
@@ -0,0 +1,183 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter id="grafana">
+  <title>Using Grafana and InfluxDB</title>
+  
+  <para>InfluxDB is essentially a time series database process that runs on a 
+    server, while Grafana is a visualization tool for time series data. 
+    Grafana is a very lightweight server-side application, and most of the 
+    monitoring runs in a browser.</para>
+  
+  <section id="grafana_settings">
+    <title>Setting Grafana and InfluxDB parameters</title>
+
+    <para>Customizing InfluxDB and Grafana parameters can be done by selecting
+    <emphasis role="bold">System</emphasis>, then the <emphasis role="bold">Configuration</emphasis> 
+      menu, accessing the <emphasis role="bold">Properties</emphasis> tab, and clicking on the 
+      <emphasis role="bold">Telemetry</emphasis> tab. The settings that can be changed
+    are listed in the table below:</para>
+
+    <table>
+      <title>Telemetry settings</title>
+
+      <tgroup cols="3">
+        <colspec align="left" colname="1" colwidth="1*" />
+
+        <colspec align="left" colname="2" colwidth="3*" />
+
+        <colspec align="left" colname="3" colwidth="1*" />
+
+        <tbody>
+          <row>
+            <entry><emphasis role="bold">Field name</emphasis></entry>
+
+            <entry><emphasis role="bold">Description</emphasis></entry>
+
+            <entry><emphasis role="bold">Default value</emphasis></entry>
+          </row>
+
+          <row>
+            <entry>Grafana Hostname or IP Address</entry>
+
+            <entry>The hostname or IP address where the Grafana instance is
+            installed.</entry>
+
+            <entry>no default</entry>
+          </row>
+
+          <row>
+            <entry>Grafana Port</entry>
+
+            <entry>The port Grafana uses.</entry>
+
+            <entry>3000</entry>
+          </row>
+
+          <row>
+            <entry>Grafana Dashboard</entry>
+
+            <entry>The dashboard that should be used when opening Grafana
+            using the Enea uCPE Manager.</entry>
+
+            <entry>host</entry>
+          </row>
+
+          <row>
+            <entry>InfluxDB Hostname or IP Address</entry>
+
+            <entry>The hostname or IP address where the InfluxDB database is
+            installed.</entry>
+
+            <entry>no default</entry>
+          </row>
+
+          <row>
+            <entry>InfluxDB Port</entry>
+
+            <entry>The port used for communication between InfluxDB and the
+            Telemetry server.</entry>
+
+            <entry>25826</entry>
+          </row>
+
+          <row>
+            <entry>InfluxDB Username</entry>
+
+            <entry>The username used for encrypting communication between
+            InfluxDB and the Telemetry server.</entry>
+
+            <entry>admin</entry>
+          </row>
+
+          <row>
+            <entry>InfluxDB Password</entry>
+
+            <entry>The password used for encrypting communication between
+            InfluxDB and the Telemetry server.</entry>
+
+            <entry>admin</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </table>
+
+    <para>When changing any of the settings in the <emphasis
+    role="bold">Telemetry</emphasis> tab, the Enea uCPE Manager will inform all
+    uCPE devices of the change if they have telemetry running.</para>
+
+    <figure>
+      <title>Telemetry Properties</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata contentwidth="615"
+                     fileref="images/telemetry_settings.png" />
+        </imageobject>
+      </mediaobject>
+    </figure>
+  </section>
+
+  <section id="telemetry_start_stop">
+    <title>Starting and stopping Telemetry</title>
+
+    <para>When a uCPE Device is selected, in the <emphasis
+    role="bold">Operations</emphasis> menu, the <emphasis role="bold">Start
+    Telemetry</emphasis> and <emphasis role="bold">Stop
+    Telemetry</emphasis> options are available.</para>
+
+    <para>When starting Telemetry for a uCPE device, the Enea uCPE Manager sends
+    the following information about the InfluxDB:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>The IP address and hostname where InfluxDB is installed.</para>
+      </listitem>
+
+      <listitem>
+        <para>The port used for communication between InfluxDB and the
+        Telemetry server.</para>
+      </listitem>
+
+      <listitem>
+        <para>The credentials used for encrypting communication between
+        InfluxDB and the Telemetry server.</para>
+      </listitem>
+    </itemizedlist>
+
+    <para>These fields are read-only and are populated with the values already
+    set in the <emphasis role="bold">System Configuration</emphasis>. If one of the 
+      fields is not set or if it does not have the desired value, modify it in the 
+      <emphasis role="bold">System Configuration</emphasis>. The password is sent 
+      encrypted using the Base64 scheme.</para>
+
+    <figure>
+      <title>Telemetry Start Dialog</title>
+
+      <mediaobject>
+        <imageobject>
+          <imagedata contentwidth="615" fileref="images/telemetry_start.png" />
+        </imageobject>
+      </mediaobject>
+    </figure>
+
+    <para>When the Telemetry status is changed on a uCPE device, a notification is 
+      sent to the Enea uCPE Manager. These notifications can be inspected under 
+      <emphasis role="bold">Fault</emphasis> found in the 
+      <emphasis role="bold">Event</emphasis> menu.</para>
+  </section>
+
+  <section id="grafana_launch">
+    <title>Launching Grafana</title>
+
+    <para>When a uCPE Device is selected, the <emphasis
+    role="bold">Telemetry</emphasis> button is available. Pressing this
+    button will open a new window pointing to Grafana. The current uCPE device will
+    be selected in Grafana.</para>
+
+    <para>The hostname or IP Address and the port of the Grafana installation
+    can be customized by selecting <emphasis role="bold">System</emphasis>, then the 
+      <emphasis role="bold">Configuration</emphasis> menu, accessing the 
+      <emphasis role="bold">Properties</emphasis> tab, and clicking on the 
+      <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard available when
+      launching Grafana can be customized as well.</para>
+  </section>
+</chapter>
\ No newline at end of file
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/telemetry_settings.png b/doc/book-enea-nfv-access-getting-started/doc/images/telemetry_settings.png
new file mode 100644
index 0000000..92c0b1f
Binary files /dev/null and b/doc/book-enea-nfv-access-getting-started/doc/images/telemetry_settings.png differ
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/telemetry_start.png b/doc/book-enea-nfv-access-getting-started/doc/images/telemetry_start.png
new file mode 100644
index 0000000..36d3ff6
Binary files /dev/null and b/doc/book-enea-nfv-access-getting-started/doc/images/telemetry_start.png differ
-- 
cgit v1.2.3-54-g00ecf