diff options
author | Luana Mincu <luana.mincu@enea.com> | 2021-03-12 16:40:08 +0200 |
---|---|---|
committer | Luana Mincu <luana.mincu@enea.com> | 2021-03-12 16:40:08 +0200 |
commit | 496d75b3a39e05a16e570210e433b244beb6047f (patch) | |
tree | 269deedf491d420c6cfeacedec60b9ee35d765f2 | |
parent | caf139a980f34b872270e161ac19402adf60af27 (diff) | |
download | nfv-access-documentation-496d75b3a39e05a16e570210e433b244beb6047f.tar.gz |
ELCCR-1442: remove the Base64 encoding of the InfluxDB password
Change-Id: If623705391a6aceb34453fa14e680387f52a7072
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/grafana.xml | 206 |
1 files changed, 103 insertions, 103 deletions
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 0da3855..91e38f3 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/grafana.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/grafana.xml | |||
@@ -1,102 +1,103 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <chapter id="grafana"> | 2 | <chapter id="grafana"> |
3 | <title>Using Grafana and InfluxDB</title> | 3 | <title>Using Grafana and InfluxDB</title> |
4 | 4 | ||
5 | <para>InfluxDB is essentially a time series database process that runs on a | 5 | <para>InfluxDB is essentially a time series database process that runs on a |
6 | server, while Grafana is a visualization tool for time series data. | 6 | server, while Grafana is a visualization tool for time series data. Grafana |
7 | Grafana is a very lightweight server-side application, and most of the | 7 | is a very lightweight server-side application, and most of the monitoring |
8 | monitoring runs in a browser.</para> | 8 | runs in a browser.</para> |
9 | 9 | ||
10 | <section id="telemetry_deployment"> | 10 | <section id="telemetry_deployment"> |
11 | <title>Deploying Grafana and InfluxDB</title> | 11 | <title>Deploying Grafana and InfluxDB</title> |
12 | 12 | ||
13 | <para>Grafana and InfluxDB can be deployed using images for Docker on linux. | 13 | <para>Grafana and InfluxDB can be deployed using images for Docker on |
14 | These images are provided by Enea along with a deploy script and | 14 | linux. These images are provided by Enea along with a deploy script and |
15 | predefined dashboards.</para> | 15 | predefined dashboards.</para> |
16 | 16 | ||
17 | <para>The Grafana and InfluxDB images can be deployed on the same machine | 17 | <para>The Grafana and InfluxDB images can be deployed on the same machine |
18 | or on separate machines.</para> | 18 | or on separate machines.</para> |
19 | 19 | ||
20 | <section id="prereq_deploy"> | 20 | <section id="prereq_deploy"> |
21 | <title>Prerequisites for Deploying an Image</title> | 21 | <title>Prerequisites for Deploying an Image</title> |
22 | 22 | ||
23 | <para>The following must be present in order to deploy an image:</para> | 23 | <para>The following must be present in order to deploy an image:</para> |
24 | 24 | ||
25 | <itemizedlist> | 25 | <itemizedlist> |
26 | <listitem> | 26 | <listitem> |
27 | <para>CentOS 7 Linux.</para> | 27 | <para>CentOS 7 Linux.</para> |
28 | </listitem> | 28 | </listitem> |
29 | 29 | ||
30 | <listitem> | 30 | <listitem> |
31 | <para>Docker for CentOS 7 installed on the machine and set to | 31 | <para>Docker for CentOS 7 installed on the machine and set to |
32 | <literal>autostart</literal> as a service.</para> | 32 | <literal>autostart</literal> as a service.</para> |
33 | </listitem> | 33 | </listitem> |
34 | 34 | ||
35 | <listitem> | 35 | <listitem> |
36 | <para>Superuser rights on the CentOS 7 machine.</para> | 36 | <para>Superuser rights on the CentOS 7 machine.</para> |
37 | </listitem> | 37 | </listitem> |
38 | </itemizedlist> | 38 | </itemizedlist> |
39 | </section> | 39 | </section> |
40 | 40 | ||
41 | <section id="deploy_steps"> | 41 | <section id="deploy_steps"> |
42 | <title>Deploying Grafana and InfluxDB</title> | 42 | <title>Deploying Grafana and InfluxDB</title> |
43 | 43 | ||
44 | <para>On the CentOS 7 server open a terminal, log into a bash shell | 44 | <para>On the CentOS 7 server open a terminal, log into a bash shell with |
45 | with the root account and perform the following:</para> | 45 | the root account and perform the following:</para> |
46 | 46 | ||
47 | <orderedlist> | 47 | <orderedlist> |
48 | <listitem> | 48 | <listitem> |
49 | <para>Extract | 49 | <para>Extract |
50 | <filename>Enea_NFV_Access_Telemetry_Deploy_<version>-build<build_number>.tar.gz</filename>.</para> | 50 | <filename>Enea_NFV_Access_Telemetry_Deploy_<version>-build<build_number>.tar.gz</filename>.</para> |
51 | 51 | ||
52 | <para>The directory in which the archive will be unpacked will be | 52 | <para>The directory in which the archive will be unpacked will be |
53 | denoted as: <literal><Telemetry-installdir></literal>.</para> | 53 | denoted as: <literal><Telemetry-installdir></literal>.</para> |
54 | </listitem> | 54 | </listitem> |
55 | 55 | ||
56 | <listitem> | 56 | <listitem> |
57 | <para>Enter <literal><Telemetry-installdir></literal>.</para> | 57 | <para>Enter <literal><Telemetry-installdir></literal>.</para> |
58 | </listitem> | 58 | </listitem> |
59 | 59 | ||
60 | <listitem> | 60 | <listitem> |
61 | <para>Run the provided <filename>telemetry_deploy.sh</filename> script.</para> | 61 | <para>Run the provided <filename>telemetry_deploy.sh</filename> |
62 | </listitem> | 62 | script.</para> |
63 | 63 | </listitem> | |
64 | <listitem> | 64 | |
65 | <para>When prompted, select what images you want to deploy.</para> | 65 | <listitem> |
66 | 66 | <para>When prompted, select what images you want to deploy.</para> | |
67 | <para>If an image is already deployed, you will be prompted to replace it.</para> | 67 | |
68 | </listitem> | 68 | <para>If an image is already deployed, you will be prompted to |
69 | 69 | replace it.</para> | |
70 | <listitem> | 70 | </listitem> |
71 | <para>During the InfluxDB deployment, you will be prompted to provide | 71 | |
72 | a username and password. These must match the ones configured in the | 72 | <listitem> |
73 | Enea uCPE Manager for Telemetry. | 73 | <para>During the InfluxDB deployment, you will be prompted to |
74 | </para> | 74 | provide a username and password. These must match the ones |
75 | 75 | configured in the Enea uCPE Manager for Telemetry.</para> | |
76 | <note> | 76 | |
77 | <para>Changing the InfluxDB username and password requires redeploying | 77 | <note> |
78 | the InfluxDB image.</para> | 78 | <para>Changing the InfluxDB username and password requires |
79 | </note> | 79 | redeploying the InfluxDB image.</para> |
80 | </listitem> | 80 | </note> |
81 | 81 | </listitem> | |
82 | <listitem> | 82 | |
83 | <para>Verify the installation by running the command <literal>docker ps -a</literal>. | 83 | <listitem> |
84 | The Grafana and InfluxDB containers should be present and have | 84 | <para>Verify the installation by running the command <literal>docker |
85 | the status <literal>Up</literal>. | 85 | ps -a</literal>. The Grafana and InfluxDB containers should be |
86 | </para> | 86 | present and have the status <literal>Up</literal>.</para> |
87 | </listitem> | 87 | </listitem> |
88 | </orderedlist> | 88 | </orderedlist> |
89 | </section> | ||
90 | </section> | 89 | </section> |
90 | </section> | ||
91 | 91 | ||
92 | <section id="grafana_settings"> | 92 | <section id="grafana_settings"> |
93 | <title>Setting Grafana and InfluxDB parameters</title> | 93 | <title>Setting Grafana and InfluxDB parameters</title> |
94 | 94 | ||
95 | <para>Customizing InfluxDB and Grafana parameters can be done by selecting | 95 | <para>Customizing InfluxDB and Grafana parameters can be done by selecting |
96 | <emphasis role="bold">System</emphasis>, then the <emphasis role="bold">Configuration</emphasis> | 96 | <emphasis role="bold">System</emphasis>, then the <emphasis |
97 | menu, accessing the <emphasis role="bold">Properties</emphasis> tab, and clicking on the | 97 | role="bold">Configuration</emphasis> menu, accessing the <emphasis |
98 | <emphasis role="bold">Telemetry</emphasis> tab. The settings that can be changed | 98 | role="bold">Properties</emphasis> tab, and clicking on the <emphasis |
99 | are listed in the table below:</para> | 99 | role="bold">Telemetry</emphasis> tab. The settings that can be changed are |
100 | listed in the table below:</para> | ||
100 | 101 | ||
101 | <table> | 102 | <table> |
102 | <title>Telemetry settings</title> | 103 | <title>Telemetry settings</title> |
@@ -183,8 +184,8 @@ | |||
183 | </table> | 184 | </table> |
184 | 185 | ||
185 | <para>When changing any of the settings in the <emphasis | 186 | <para>When changing any of the settings in the <emphasis |
186 | role="bold">Telemetry</emphasis> tab, the Enea uCPE Manager will inform all | 187 | role="bold">Telemetry</emphasis> tab, the Enea uCPE Manager will inform |
187 | uCPE devices of the change if they have telemetry running.</para> | 188 | all uCPE devices of the change if they have telemetry running.</para> |
188 | 189 | ||
189 | <figure> | 190 | <figure> |
190 | <title>Telemetry Properties</title> | 191 | <title>Telemetry Properties</title> |
@@ -203,11 +204,11 @@ | |||
203 | 204 | ||
204 | <para>When a uCPE Device is selected, in the <emphasis | 205 | <para>When a uCPE Device is selected, in the <emphasis |
205 | role="bold">Operations</emphasis> menu, the <emphasis role="bold">Start | 206 | role="bold">Operations</emphasis> menu, the <emphasis role="bold">Start |
206 | Telemetry</emphasis> and <emphasis role="bold">Stop | 207 | Telemetry</emphasis> and <emphasis role="bold">Stop Telemetry</emphasis> |
207 | Telemetry</emphasis> options are available.</para> | 208 | options are available.</para> |
208 | 209 | ||
209 | <para>When starting Telemetry for a uCPE device, the Enea uCPE Manager sends | 210 | <para>When starting Telemetry for a uCPE device, the Enea uCPE Manager |
210 | the following information about the InfluxDB:</para> | 211 | sends the following information about the InfluxDB:</para> |
211 | 212 | ||
212 | <itemizedlist> | 213 | <itemizedlist> |
213 | <listitem> | 214 | <listitem> |
@@ -226,10 +227,9 @@ | |||
226 | </itemizedlist> | 227 | </itemizedlist> |
227 | 228 | ||
228 | <para>These fields are read-only and are populated with the values already | 229 | <para>These fields are read-only and are populated with the values already |
229 | set in the <emphasis role="bold">System Configuration</emphasis>. If one of the | 230 | set in the <emphasis role="bold">System Configuration</emphasis>. If one |
230 | fields is not set or if it does not have the desired value, modify it in the | 231 | of the fields is not set or if it does not have the desired value, modify |
231 | <emphasis role="bold">System Configuration</emphasis>. The password is sent | 232 | it in the <emphasis role="bold">System Configuration</emphasis>.</para> |
232 | encrypted using the Base64 scheme.</para> | ||
233 | 233 | ||
234 | <figure> | 234 | <figure> |
235 | <title>Telemetry Start Dialog</title> | 235 | <title>Telemetry Start Dialog</title> |
@@ -241,25 +241,25 @@ | |||
241 | </mediaobject> | 241 | </mediaobject> |
242 | </figure> | 242 | </figure> |
243 | 243 | ||
244 | <para>When the Telemetry status is changed on a uCPE device, a notification is | 244 | <para>When the Telemetry status is changed on a uCPE device, a |
245 | sent to the Enea uCPE Manager. These notifications can be inspected under | 245 | notification is sent to the Enea uCPE Manager. These notifications can be |
246 | <emphasis role="bold">Fault</emphasis> found in the | 246 | inspected under <emphasis role="bold">Fault</emphasis> found in the |
247 | <emphasis role="bold">Event</emphasis> menu.</para> | 247 | <emphasis role="bold">Event</emphasis> menu.</para> |
248 | </section> | 248 | </section> |
249 | 249 | ||
250 | <section id="grafana_launch"> | 250 | <section id="grafana_launch"> |
251 | <title>Launching Grafana</title> | 251 | <title>Launching Grafana</title> |
252 | 252 | ||
253 | <para>When a uCPE Device is selected, the <emphasis | 253 | <para>When a uCPE Device is selected, the <emphasis |
254 | role="bold">Telemetry</emphasis> button is available. Pressing this | 254 | role="bold">Telemetry</emphasis> button is available. Pressing this button |
255 | button will open a new window pointing to Grafana. The current uCPE device will | 255 | will open a new window pointing to Grafana. The current uCPE device will |
256 | be selected in Grafana.</para> | 256 | be selected in Grafana.</para> |
257 | 257 | ||
258 | <para>The hostname or IP Address and the port of the Grafana installation | 258 | <para>The hostname or IP Address and the port of the Grafana installation |
259 | can be customized by selecting <emphasis role="bold">System</emphasis>, then the | 259 | can be customized by selecting <emphasis role="bold">System</emphasis>, |
260 | <emphasis role="bold">Configuration</emphasis> menu, accessing the | 260 | then the <emphasis role="bold">Configuration</emphasis> menu, accessing |
261 | <emphasis role="bold">Properties</emphasis> tab, and clicking on the | 261 | the <emphasis role="bold">Properties</emphasis> tab, and clicking on the |
262 | <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard available when | 262 | <emphasis role="bold">Telemetry</emphasis> tab. The default dashboard |
263 | launching Grafana can be customized as well.</para> | 263 | available when launching Grafana can be customized as well.</para> |
264 | </section> | 264 | </section> |
265 | </chapter> \ No newline at end of file | 265 | </chapter> \ No newline at end of file |