summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-getting-started
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-edge-getting-started')
-rw-r--r--doc/book-enea-edge-getting-started/doc/advanced_configurations.xml6
-rw-r--r--doc/book-enea-edge-getting-started/doc/grafana.xml103
-rw-r--r--doc/book-enea-edge-getting-started/doc/installation_guide.xml16
-rw-r--r--doc/book-enea-edge-getting-started/doc/introduction.xml3
-rw-r--r--doc/book-enea-edge-getting-started/doc/upgrade_ena.xml3
5 files changed, 109 insertions, 22 deletions
diff --git a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
index 70a9978..18c1545 100644
--- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
+++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml
@@ -417,9 +417,9 @@ node0.1048576kB = 3 </programlisting>
417 </section> 417 </section>
418 </section> 418 </section>
419 419
420 <section id="high_availability_ig"> 420
421 <title>Installing the Enea Edge Management in High Availability 421 <section condition="hidden" id="high_availability_ig">
422 Mode</title> 422 <title>Installing the Enea Edge Management in High Availability Mode</title>
423 423
424 <para>The following describes the setup needed for running the Enea Edge 424 <para>The following describes the setup needed for running the Enea Edge
425 Management in High Availabilty (HA) mode, with a MariaDB database cluster. 425 Management in High Availabilty (HA) mode, with a MariaDB database cluster.
diff --git a/doc/book-enea-edge-getting-started/doc/grafana.xml b/doc/book-enea-edge-getting-started/doc/grafana.xml
index 05276ed..5dfaa98 100644
--- a/doc/book-enea-edge-getting-started/doc/grafana.xml
+++ b/doc/book-enea-edge-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>
diff --git a/doc/book-enea-edge-getting-started/doc/installation_guide.xml b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
index d9784a0..50a90b0 100644
--- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
@@ -101,7 +101,7 @@
101 href="../../s_docbuild/olinkdb/pardoc-common.xml" 101 href="../../s_docbuild/olinkdb/pardoc-common.xml"
102 xmlns:xi="http://www.w3.org/2001/XInclude" 102 xmlns:xi="http://www.w3.org/2001/XInclude"
103 xpointer="element(book_enea_nfv_access_release_info/1)" /> 103 xpointer="element(book_enea_nfv_access_release_info/1)" />
104 manual.</para> 104 Manual.</para>
105 105
106 <para>Enea Edge Runtime needs EFI support in BIOS to boot. When 106 <para>Enea Edge Runtime needs EFI support in BIOS to boot. When
107 configuring the uCPE device BIOS a serial connection is 107 configuring the uCPE device BIOS a serial connection is
@@ -124,7 +124,7 @@
124 server and the laptop is required. Please see the <xi:include 124 server and the laptop is required. Please see the <xi:include
125 href="../../s_docbuild/olinkdb/pardoc-common.xml" 125 href="../../s_docbuild/olinkdb/pardoc-common.xml"
126 xmlns:xi="http://www.w3.org/2001/XInclude" 126 xmlns:xi="http://www.w3.org/2001/XInclude"
127 xpointer="element(book_enea_nfv_access_release_info/1)" /> manual 127 xpointer="element(book_enea_nfv_access_release_info/1)" /> Manual
128 available with your release, for recommended browsers.</para> 128 available with your release, for recommended browsers.</para>
129 </listitem> 129 </listitem>
130 </itemizedlist> 130 </itemizedlist>
@@ -186,7 +186,9 @@ sudo systemctl mask now firewalld</programlisting>
186 186
187 <entry>UDP</entry> 187 <entry>UDP</entry>
188 188
189 <entry>Required for the Enea Edge Management High Availability 189
190 <entry condition="hidden">Required for the Enea Edge Management High Availability
191
190 Configuration.</entry> 192 Configuration.</entry>
191 </row> 193 </row>
192 194
@@ -195,7 +197,8 @@ sudo systemctl mask now firewalld</programlisting>
195 197
196 <entry>TCP</entry> 198 <entry>TCP</entry>
197 199
198 <entry>Required for the Enea Edge Management High Availability 200 <entry condition="hidden">Required for the Enea Edge Management High Availability
201
199 Configuration.</entry> 202 Configuration.</entry>
200 </row> 203 </row>
201 204
@@ -470,6 +473,7 @@ userdel postgres</programlisting>
470 473
471 <orderedlist> 474 <orderedlist>
472 <listitem> 475 <listitem>
476
473 <para>Extract 477 <para>Extract
474 <literal>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para> 478 <literal>Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para>
475 479
@@ -569,10 +573,10 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
569 </itemizedlist> 573 </itemizedlist>
570 </listitem> 574 </listitem>
571 575
572 <listitem> 576 <listitem condition="hidden">
573 <para>High Availability Configurations:</para> 577 <para>High Availability Configurations:</para>
574 578
575 <itemizedlist spacing="compact"> 579 <itemizedlist>
576 <listitem> 580 <listitem>
577 <para>Specify the IP address of the local interface: The 581 <para>Specify the IP address of the local interface: The
578 CentOS 7 Server loopback address: 582 CentOS 7 Server loopback address:
diff --git a/doc/book-enea-edge-getting-started/doc/introduction.xml b/doc/book-enea-edge-getting-started/doc/introduction.xml
index 4dec1e1..8186ff1 100644
--- a/doc/book-enea-edge-getting-started/doc/introduction.xml
+++ b/doc/book-enea-edge-getting-started/doc/introduction.xml
@@ -44,6 +44,7 @@
44 </listitem> 44 </listitem>
45 </itemizedlist> 45 </itemizedlist>
46 46
47
47 <para>In addition, Enea Edge includes a framework for 48 <para>In addition, Enea Edge includes a framework for
48 automation and testing. More information can be found in 49 automation and testing. More information can be found in
49 <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 50 <xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
@@ -54,7 +55,7 @@
54 structure, are provided in the <xi:include 55 structure, are provided in the <xi:include
55 href="../../s_docbuild/olinkdb/pardoc-common.xml" 56 href="../../s_docbuild/olinkdb/pardoc-common.xml"
56 xmlns:xi="http://www.w3.org/2001/XInclude" 57 xmlns:xi="http://www.w3.org/2001/XInclude"
57 xpointer="element(book_enea_nfv_access_release_info/1)" /> manual included 58 xpointer="element(book_enea_nfv_access_release_info/1)" /> Manual included
58 with your release.</para> 59 with your release.</para>
59 60
60 <section id="nfv_access"> 61 <section id="nfv_access">
diff --git a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml
index 641775d..14ac049 100644
--- a/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml
+++ b/doc/book-enea-edge-getting-started/doc/upgrade_ena.xml
@@ -80,7 +80,8 @@ Enea_NFV_Access_uCPEManager_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</pr
80 Manual contains information about the input required to be entered during 80 Manual contains information about the input required to be entered during
81 the execution of the upgrade script.</para> 81 the execution of the upgrade script.</para>
82 82
83 <para>For an example on how to upgrade an Enea Edge Management installation 83
84 <para condition="hidden">For an example on how to upgrade an Enea Edge Management installation
84 in a High Availability setup, consult <olink 85 in a High Availability setup, consult <olink
85 targetdoc="book_enea_nfv_access_getting_started" 86 targetdoc="book_enea_nfv_access_getting_started"
86 targetptr="ha_upgrade">Upgrading a High Availability Deployment in the 87 targetptr="ha_upgrade">Upgrading a High Availability Deployment in the