summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Chiripuci <stci@enea.se>2021-03-18 17:23:10 +0200
committerMiruna Paun <mrpa@enea.se>2021-03-22 22:22:25 +0100
commite655b86c59bb3e94dc3174938a4c9b05509f4b0a (patch)
tree7f0175c46c8a75527caf1eaedbd757c8cf3417b0
parent187a04b578c6a504ca75ea449ab62103a235c317 (diff)
downloadnfv-access-documentation-e655b86c59bb3e94dc3174938a4c9b05509f4b0a.tar.gz
Telemetry getting started documentationEnea_NFV_Access_2.4.0_RC5
Default User and Pass for Grafana Incorrect instruction for unpacking telemetry kit, add brief note on installing docker. Change-Id: I7aecd5e4fab790513d22289c72821d131552e332
-rw-r--r--doc/book-enea-nfv-access-getting-started/doc/grafana.xml103
1 files changed, 92 insertions, 11 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 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 @@
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>Internet connection for installing the Docker tool.</para>
32 <literal>autostart</literal> as a service.</para>
33 </listitem> 32 </listitem>
34 33
35 <listitem> 34 <listitem>
36 <para>Superuser rights on the CentOS 7 machine.</para> 35 <para>Root rights on the CentOS 7 machine.</para>
37 </listitem> 36 </listitem>
38 </itemizedlist> 37 </itemizedlist>
39 </section> 38 </section>
40 39
40 <section id="docker_steps">
41 <title>Setting up Docker for Grafana and InfluxDB</title>
42
43 <para>In order to use the Grafana and InfluxDB containers, the Docker
44 tool that runs and manages containers needs to be available on
45 the server.</para>
46
47 <para>To install Docker on a CentOS 7 server open a terminal, log
48 into a bash shell with the root account and run the following commands:</para>
49
50 <orderedlist>
51 <listitem>
52 <para><literal>yum check-update</literal></para>
53 </listitem>
54
55 <listitem>
56 <para><literal>yum install -y yum-utils device-mapper-persistent-data lvm2</literal></para>
57 </listitem>
58
59 <listitem>
60 <para><literal>yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo</literal></para>
61 </listitem>
62
63 <listitem>
64 <para><literal>yum install docker</literal></para>
65 </listitem>
66 </orderedlist>
67
68 <para>In order to deploy the Grafana and InfluxDB images, the Docker
69 service needs to be started. To start the Docker service, log into
70 a bash shell with the root account and run the following command:
71 <literal>systemctl start docker</literal>.</para>
72
73 <note><para>By default, the Docker service is not configured to start at boot.
74 In order to configure it to autostart, log into a bash shell
75 with the root account and run the following command:
76 <literal>systemctl enable docker</literal>. The Grafana and InfluxDB
77 images are configured to autostart when the Docker service starts.</para></note>
78 </section>
79
80
41 <section id="deploy_steps"> 81 <section id="deploy_steps">
42 <title>Deploying Grafana and InfluxDB</title> 82 <title>Deploying Grafana and InfluxDB</title>
43 83
@@ -63,10 +103,19 @@
63 </listitem> 103 </listitem>
64 104
65 <listitem> 105 <listitem>
66 <para>When prompted, select what images you want to deploy.</para> 106 <para>When prompted, select what images you want to deploy.
67 107 Select <literal>Both</literal> unless you wish for the Grafana
68 <para>If an image is already deployed, you will be prompted to 108 and InfluxDB images to be on separate servers.</para>
69 replace it.</para> 109
110 <note>
111 <para>If an image is already deployed, you will be prompted
112 to replace it.</para>
113
114 <para>By default, Grafana is configured for deployment on the
115 same server as InfluxDB. Please read the Grafana documentation
116 on how to configure it if you wish to deploy the images
117 on separate servers.</para>
118 </note>
70 </listitem> 119 </listitem>
71 120
72 <listitem> 121 <listitem>
@@ -86,14 +135,46 @@
86 present and have the status <literal>Up</literal>.</para> 135 present and have the status <literal>Up</literal>.</para>
87 </listitem> 136 </listitem>
88 </orderedlist> 137 </orderedlist>
138
139 <note>
140 <para>The provided Grafana instance by default uses the
141 <literal>Username:</literal> <emphasis role="bold">admin</emphasis> and
142 <literal>Password:</literal> <emphasis role="bold">admin</emphasis>.</para>
143 </note>
144 </section>
89 </section> 145 </section>
146
147 <section id="telemetry_firewall_settings">
148 <title>Firewall settings for Grafana and InfluxDB</title>
149
150 <para>If a firewall is running on the machines where Grafana and InfluxDB are
151 deployed, this firewall needs to be configured so the required ports are
152 enabled.</para>
153
154 <para>To enable the ports, log into a bash shell with the root account and
155 perform the following:
156 </para>
157
158 <orderedlist>
159 <listitem>
160 <para>For InfluxDB, run the following command:</para>
161
162 <programlisting>firewall-cmd --permanent --add-port=25826/tcp</programlisting>
163 </listitem>
164
165 <listitem>
166 <para>For Grafana, run the following command:</para>
167
168 <programlisting>firewall-cmd --permanent --add-port=3000/tcp</programlisting>
169 </listitem>
170 </orderedlist>
90 </section> 171 </section>
91 172
92 <section id="grafana_settings"> 173 <section id="grafana_settings">
93 <title>Setting Grafana and InfluxDB parameters</title> 174 <title>Setting Grafana and InfluxDB parameters</title>
94 175
95 <para>Customizing InfluxDB and Grafana parameters can be done by selecting 176 <para>Customizing InfluxDB and Grafana parameters can be done in the Enea uCPE Manager
96 <emphasis role="bold">System</emphasis>, then the <emphasis 177 GUI by selecting <emphasis role="bold">System</emphasis>, then the <emphasis
97 role="bold">Configuration</emphasis> menu, accessing the <emphasis 178 role="bold">Configuration</emphasis> menu, accessing the <emphasis
98 role="bold">Properties</emphasis> tab, and clicking on the <emphasis 179 role="bold">Properties</emphasis> tab, and clicking on the <emphasis
99 role="bold">Telemetry</emphasis> tab. The settings that can be changed are 180 role="bold">Telemetry</emphasis> tab. The settings that can be changed are
@@ -121,7 +202,7 @@
121 <row> 202 <row>
122 <entry>Grafana Hostname or IP Address</entry> 203 <entry>Grafana Hostname or IP Address</entry>
123 204
124 <entry>The hostname or IP address where the Grafana instance is 205 <entry>The public hostname or IP address where the Grafana instance is
125 installed.</entry> 206 installed.</entry>
126 207
127 <entry>no default</entry> 208 <entry>no default</entry>
@@ -147,7 +228,7 @@
147 <row> 228 <row>
148 <entry>InfluxDB Hostname or IP Address</entry> 229 <entry>InfluxDB Hostname or IP Address</entry>
149 230
150 <entry>The hostname or IP address where the InfluxDB database is 231 <entry>The public hostname or IP address where the InfluxDB database is
151 installed.</entry> 232 installed.</entry>
152 233
153 <entry>no default</entry> 234 <entry>no default</entry>