From e655b86c59bb3e94dc3174938a4c9b05509f4b0a Mon Sep 17 00:00:00 2001
From: Stefan Chiripuci <stci@enea.se>
Date: Thu, 18 Mar 2021 17:23:10 +0200
Subject: Telemetry getting started documentation Default User and Pass for
 Grafana Incorrect instruction for unpacking telemetry kit, add brief note on
 installing docker.

Change-Id: I7aecd5e4fab790513d22289c72821d131552e332
---
 .../doc/grafana.xml                                | 103 ++++++++++++++++++---
 1 file changed, 92 insertions(+), 11 deletions(-)

(limited to 'doc')

diff --git a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml
index 91e38f3..8278261 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml
@@ -28,16 +28,56 @@
         </listitem>
 
         <listitem>
-          <para>Docker for CentOS 7 installed on the machine and set to
-          <literal>autostart</literal> as a service.</para>
+            <para>Internet connection for installing the Docker tool.</para>
         </listitem>
 
         <listitem>
-          <para>Superuser rights on the CentOS 7 machine.</para>
+            <para>Root rights on the CentOS 7 machine.</para>
         </listitem>
       </itemizedlist>
     </section>
 
+    <section id="docker_steps">
+        <title>Setting up Docker for Grafana and InfluxDB</title>
+      
+        <para>In order to use the Grafana and InfluxDB containers, the Docker 
+          tool that runs and manages containers needs to be available on 
+          the server.</para>
+      
+        <para>To install Docker on a CentOS 7 server open a terminal, log 
+          into a bash shell with the root account and run the following commands:</para>
+
+      <orderedlist>
+         <listitem>
+           <para><literal>yum check-update</literal></para>
+         </listitem>
+        
+        <listitem>
+          <para><literal>yum install -y yum-utils device-mapper-persistent-data lvm2</literal></para>
+         </listitem>
+        
+         <listitem>
+           <para><literal>yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo</literal></para>
+         </listitem>
+        
+         <listitem>
+           <para><literal>yum install docker</literal></para>
+         </listitem>
+        </orderedlist>
+        
+        <para>In order to deploy the Grafana and InfluxDB images, the Docker 
+          service needs to be started. To start the Docker service, log into 
+          a bash shell with the root account and run the following command: 
+          <literal>systemctl start docker</literal>.</para>
+        
+        <note><para>By default, the Docker service is not configured to start at boot. 
+          In order to configure it to autostart, log into a bash shell
+        with the root account and run the following command: 
+          <literal>systemctl enable docker</literal>. The Grafana and InfluxDB 
+          images are configured to autostart when the Docker service starts.</para></note>
+    </section>
+
+
     <section id="deploy_steps">
       <title>Deploying Grafana and InfluxDB</title>
 
@@ -63,10 +103,19 @@
         </listitem>
 
         <listitem>
-          <para>When prompted, select what images you want to deploy.</para>
-
-          <para>If an image is already deployed, you will be prompted to
-          replace it.</para>
+            <para>When prompted, select what images you want to deploy. 
+              Select <literal>Both</literal> unless you wish for the Grafana 
+              and InfluxDB images to be on separate servers.</para>
+          
+            <note>
+              <para>If an image is already deployed, you will be prompted 
+                to replace it.</para>
+              
+              <para>By default, Grafana is configured for deployment on the 
+                same server as InfluxDB. Please read the Grafana documentation 
+                on how to configure it if you wish to deploy the images 
+                on separate servers.</para>
+            </note>
         </listitem>
 
         <listitem>
@@ -86,14 +135,46 @@
           present and have the status <literal>Up</literal>.</para>
         </listitem>
       </orderedlist>
+        
+        <note>
+           <para>The provided Grafana instance by default uses the 
+             <literal>Username:</literal> <emphasis role="bold">admin</emphasis> and 
+           <literal>Password:</literal> <emphasis role="bold">admin</emphasis>.</para>
+        </note>
+      </section>
     </section>
+  
+    <section id="telemetry_firewall_settings">
+        <title>Firewall settings for Grafana and InfluxDB</title>
+      
+      <para>If a firewall is running on the machines where Grafana and InfluxDB are 
+        deployed, this firewall needs to be configured so the required ports are 
+        enabled.</para>
+      
+      <para>To enable the ports, log into a bash shell with the root account and 
+           perform the following:
+         </para>
+      
+      <orderedlist>
+        <listitem>
+          <para>For InfluxDB, run the following command:</para> 
+          
+          <programlisting>firewall-cmd --permanent --add-port=25826/tcp</programlisting>
+        </listitem>
+        
+        <listitem>
+          <para>For Grafana, run the following command:</para>
+          
+          <programlisting>firewall-cmd --permanent --add-port=3000/tcp</programlisting>
+        </listitem>
+      </orderedlist>
   </section>
 
   <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
+    <para>Customizing InfluxDB and Grafana parameters can be done in the Enea uCPE Manager 
+      GUI 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
@@ -121,7 +202,7 @@
           <row>
             <entry>Grafana Hostname or IP Address</entry>
 
-            <entry>The hostname or IP address where the Grafana instance is
+            <entry>The public hostname or IP address where the Grafana instance is
             installed.</entry>
 
             <entry>no default</entry>
@@ -147,7 +228,7 @@
           <row>
             <entry>InfluxDB Hostname or IP Address</entry>
 
-            <entry>The hostname or IP address where the InfluxDB database is
+            <entry>The public hostname or IP address where the InfluxDB database is
             installed.</entry>
 
             <entry>no default</entry>
-- 
cgit v1.2.3-54-g00ecf