summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormrpa <miruna.paun@enea.com>2021-10-28 15:37:15 +0200
committerMiruna Paun <mrpa@enea.se>2021-10-29 13:54:10 +0100
commit14f96b3f1dd730267930cae025e572761dbcb6d4 (patch)
tree9c6e778c9ddc4bfae0b1d33407b120bc3a26c2d1
parentb98804c55651770b0e5fb5f001a28e6b99b1551b (diff)
downloadnfv-access-documentation-14f96b3f1dd730267930cae025e572761dbcb6d4.tar.gz
Updating the Mg Controller User Guide with needed data.
USERDOCAP-725, ELCCR-2064 Change-Id: I6e2c2592f67036ff7277c92330d2a24c850e5586 Signed-off-by: mrpa <miruna.paun@enea.com>
Diffstat
-rw-r--r--doc/book-enea-edge-management-controller-open-source/doc/book.xml2
-rw-r--r--doc/book-enea-edge-management-controller-user-guide/doc/management_controller.xml782
2 files changed, 404 insertions, 380 deletions
diff --git a/doc/book-enea-edge-management-controller-open-source/doc/book.xml b/doc/book-enea-edge-management-controller-open-source/doc/book.xml
index 49fd2be..e248e19 100644
--- a/doc/book-enea-edge-management-controller-open-source/doc/book.xml
+++ b/doc/book-enea-edge-management-controller-open-source/doc/book.xml
@@ -6,7 +6,7 @@
6<book id="book_enea_edge_management_controller_open_source"> 6<book id="book_enea_edge_management_controller_open_source">
7 <title><trademark class="registered">Enea</trademark> Edge Management Controller Open Source Report</title> 7 <title><trademark class="registered">Enea</trademark> Edge Management Controller Open Source Report</title>
8 <subtitle>Release Version 8 <subtitle>Release Version
9 <xi:include href="../../s_doceneacommon/doc/eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" 9 <xi:include href="../../eltf_params_updated.xml" xpointer="element(EneaEdge_REL_VER/1)"
10 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> 10 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle>
11 <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb --> 11 <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb -->
12 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 12 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/doc/book-enea-edge-management-controller-user-guide/doc/management_controller.xml b/doc/book-enea-edge-management-controller-user-guide/doc/management_controller.xml
index b93601e..27fe956 100644
--- a/doc/book-enea-edge-management-controller-user-guide/doc/management_controller.xml
+++ b/doc/book-enea-edge-management-controller-user-guide/doc/management_controller.xml
@@ -2,446 +2,440 @@
2<chapter id="edgemanagementcontroller"> 2<chapter id="edgemanagementcontroller">
3 <title>Deploying and using the Enea Edge Management Controller</title> 3 <title>Deploying and using the Enea Edge Management Controller</title>
4 4
5 <para>The Enea Edge Management Controller provides a means of connecting from one web page to multiple 5 <para>The Enea Edge Management Controller provides a means of connecting
6 instances of the Enea Edge Management application. It also provides 6 from one web page to multiple instances of the Enea Edge Management
7 information about the status of each instance.</para> 7 application. It also provides information about the status of each
8 instance.</para>
8 9
9 <section id="edge_mg_ctrl_deployment"> 10 <section id="edge_mg_ctrl_deployment">
10 <title>Installing the Enea Edge Management Controller</title> 11 <title>Installing the Enea Edge Management Controller</title>
11 12
12 <para>The setup and installation steps detailed below will deploy a base 13 <para>The setup and installation steps detailed below will deploy a base
13 configuration which will be used as a reference for more complex deployment 14 configuration which will be used as a reference for more complex
14 scenarios.</para> 15 deployment scenarios.</para>
15 16
16 <section id="Hardware requirements"> 17 <section id="Hardware requirements">
17 <title>Hardware Requirements</title> 18 <title>Hardware Requirements</title>
18 19
19 <itemizedlist> 20 <itemizedlist>
20 <listitem> 21 <listitem>
21 <para>One server running the CentOS 7 distribution.</para> 22 <para>One server running the CentOS 7 distribution.</para>
22 23
23 <note> 24 <note>
24 <para>The CentOS 7 server must be updated to the latest revision 25 <para>The CentOS 7 server must be updated to the latest revision
25 before installing the Enea Edge Management Controller, and configured for English language 26 before installing the Enea Edge Management Controller, and
26 usage.</para> 27 configured for English language usage.</para>
27 28
28 <para>The Enea Edge Management Controller does not support deployment on a server where an 29 <para>The Enea Edge Management Controller does not support
29 instance of the Enea Edge Management application is already deployed.</para> 30 deployment on a server where an instance of the Enea Edge
30 </note> 31 Management application is already deployed.</para>
32 </note>
31 33
32 <para>The following will detail CPU, RAM and storage requirements for 34 <para>The following will detail CPU, RAM and storage requirements
33 the Enea Edge Management Controller:</para> 35 for the Enea Edge Management Controller:</para>
34 36
35 <itemizedlist spacing="compact"> 37 <itemizedlist spacing="compact">
36 <listitem> 38 <listitem>
37 <para>4 cores</para> 39 <para>4 cores</para>
38 </listitem> 40 </listitem>
39 41
40 <listitem> 42 <listitem>
41 <para>16 GB RAM</para> 43 <para>16 GB RAM</para>
42 </listitem> 44 </listitem>
43 45
44 <listitem> 46 <listitem>
45 <para>300 GB single disk storage</para> 47 <para>300 GB single disk storage</para>
46 </listitem> 48 </listitem>
47 </itemizedlist> 49 </itemizedlist>
48 </listitem> 50 </listitem>
49 </itemizedlist> 51 </itemizedlist>
50 52
51 <para>The purpose of the CentOS 7 server is to host the Enea Edge Management Controller application. 53 <para>The purpose of the CentOS 7 server is to host the Enea Edge
52 Network access between the CentOS 7 server and the Edge Management instances is required. 54 Management Controller application. Network access between the CentOS 7
53 Public IPs are needed for the Enea Edge Management instances.</para> 55 server and the Edge Management instances is required. Public IPs are
56 needed for the Enea Edge Management instances.</para>
54 </section> 57 </section>
55 58
56 <section id="edge_mg_ctrl_sw_config"> 59 <section id="edge_mg_ctrl_sw_config">
57 <title>Software Configuration</title> 60 <title>Software Configuration</title>
58 61
59 <para>The CentOS 7 server requires a specific configuration for the setup 62 <para>The CentOS 7 server requires a specific configuration for the
60 to work.</para> 63 setup to work.</para>
61 64
62 <section id="edge_mg_ctrl_firewall_config"> 65 <section id="edge_mg_ctrl_firewall_config">
63 <title>Firewall Configuration</title> 66 <title>Firewall Configuration</title>
64 67
65 <para>Any firewall running on the CentOS 7 server may block the 68 <para>Any firewall running on the CentOS 7 server may block the
66 management protocols required to communicate between the Enea Edge 69 management protocols required to communicate between the Enea Edge
67 Management Controller and the Enea Edge Management application, as well 70 Management Controller and the Enea Edge Management application, as
68 as between the Enea Edge Management Controller application 71 well as between the Enea Edge Management Controller application and
69 and its northbound clients. Quick handling of a 72 its northbound clients. Quick handling of a blocking firewall would be
70 blocking firewall would be to disable it, typical for a lab environment:</para> 73 to disable it, typical for a lab environment:</para>
71 74
72 <programlisting>sudo systemctl stop firewalld 75 <programlisting>sudo systemctl stop firewalld
73sudo systemctl disable firewalld 76sudo systemctl disable firewalld
74sudo systemctl mask now firewalld</programlisting> 77sudo systemctl mask now firewalld</programlisting>
75 78
76 <para>For an advanced firewall configuration, the following ports need 79 <para>For an advanced firewall configuration, the following ports need
77 to be opened:</para> 80 to be opened:</para>
78
79 <table>
80 <title>Ports to be Activated</title>
81 81
82 <tgroup cols="3"> 82 <table>
83 <colspec align="left" /> 83 <title>Ports to be Activated</title>
84 84
85 <tbody> 85 <tgroup cols="3">
86 <row> 86 <colspec align="left" />
87 <entry>80</entry>
88 87
89 <entry>TCP</entry> 88 <tbody>
89 <row>
90 <entry>80</entry>
90 91
91 <entry>Required for GUI Access.</entry> 92 <entry>TCP</entry>
92 </row>
93 93
94 <row> 94 <entry>Required for GUI Access.</entry>
95 <entry>443</entry> 95 </row>
96 96
97 <entry>TCP</entry> 97 <row>
98 <entry>443</entry>
98 99
99 <entry>Required for GUI Access and Connectivity.</entry> 100 <entry>TCP</entry>
100 </row>
101 101
102 </tbody> 102 <entry>Required for GUI Access and Connectivity.</entry>
103 </tgroup> 103 </row>
104 </table> 104 </tbody>
105 </tgroup>
106 </table>
105 107
106 <para>Use the following command sequence to enable the required ports 108 <para>Use the following command sequence to enable the required ports
107 for deployment of the Enea Edge Management Controller:</para> 109 for deployment of the Enea Edge Management Controller:</para>
108 110
109 <programlisting>sudo firewall-cmd --permanent --add-port=80/tcp 111 <programlisting>sudo firewall-cmd --permanent --add-port=80/tcp
110sudo firewall-cmd --permanent --add-port=443/tcp 112sudo firewall-cmd --permanent --add-port=443/tcp
111sudo firewall-cmd --reload</programlisting> 113sudo firewall-cmd --reload</programlisting>
112 </section> 114 </section>
113
114 <section id="edge_mg_ctrl_openjdk_postgresql_config">
115 <title>Configuring OpenJDK and PostgreSQL</title>
116 115
117 <para>The Enea Edge Management Controller requires a specific Java 116 <section id="edge_mg_ctrl_openjdk_postgresql_config">
118 version (OpenJDK 11) and a PostgreSQL version to operate 117 <title>Configuring OpenJDK and PostgreSQL</title>
119 correctly.</para>
120 118
121 <para><emphasis role="bold">Installing OpenJDK</emphasis></para> 119 <para>The Enea Edge Management Controller requires a specific Java
120 version (OpenJDK 11) and a PostgreSQL version to operate
121 correctly.</para>
122 122
123 <orderedlist spacing="compact"> 123 <para><emphasis role="bold">Installing OpenJDK</emphasis></para>
124 <listitem>
125 <para>Install OpenJDK 11 using the root account:</para>
126 124
127 <programlisting>yum install java-11-openjdk-devel</programlisting> 125 <orderedlist spacing="compact">
128 </listitem> 126 <listitem>
127 <para>Install OpenJDK 11 using the root account:</para>
129 128
130 <listitem> 129 <programlisting>yum install java-11-openjdk-devel</programlisting>
131 <para>Verify the installation:</para> 130 </listitem>
131
132 <listitem>
133 <para>Verify the installation:</para>
132 134
133 <programlisting>java -version 135 <programlisting>java -version
134openjdk version "11.0.3" 2019-04-16 LTS 136openjdk version "11.0.3" 2019-04-16 LTS
135OpenJDK Run Time Environment 18.9 (build 11.0.3+7-LTS) 137OpenJDK Run Time Environment 18.9 (build 11.0.3+7-LTS)
136OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting> 138OpenJDK 64-Bit Server VM 18.9 (build 11.0.3+7-LTS, mixed mode, sharing)</programlisting>
137 139
138 <note> 140 <note>
139 <para>If there are multiple java versions installed, switch 141 <para>If there are multiple java versions installed, switch
140 between them using the following command:</para> 142 between them using the following command:</para>
141 143
142 <programlisting>alternatives --config java</programlisting> 144 <programlisting>alternatives --config java</programlisting>
143 145
144 <para>Optionally, the user can switch between the 146 <para>Optionally, the user can switch between the
145 <literal>javac</literal> versions using:</para> 147 <literal>javac</literal> versions using:</para>
146 148
147 <programlisting>alternatives --config javac</programlisting> 149 <programlisting>alternatives --config javac</programlisting>
148 </note> 150 </note>
149 </listitem> 151 </listitem>
150 152
151 <listitem> 153 <listitem>
152 <para>The following system variables need to point to the OpenJDK 11 154 <para>The following system variables need to point to the OpenJDK
153 installation:</para> 155 11 installation:</para>
154 156
155 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which java))))) 157 <programlisting>export JAVA_HOME=$(dirname $(dirname $(readlink $(readlink $(which java)))))
156export PATH=$PATH:$JAVA_HOME/bin 158export PATH=$PATH:$JAVA_HOME/bin
157export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting> 159export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</programlisting>
158 160
159 <note> 161 <note>
160 <para>In order to make these system variables persistent, the 162 <para>In order to make these system variables persistent, the
161 commands given above should be added to a script in the 163 commands given above should be added to a script in the
162 <literal>/etc/profile.d/</literal> folder. <emphasis 164 <literal>/etc/profile.d/</literal> folder. <emphasis
163 role="bold">Sudo</emphasis> access is needed for this 165 role="bold">Sudo</emphasis> access is needed for this
164 operation.</para> 166 operation.</para>
165 </note> 167 </note>
166 </listitem> 168 </listitem>
167 </orderedlist> 169 </orderedlist>
168 170
169 <para>The Enea Edge Management Controller application requires a specific 171 <para>The Enea Edge Management Controller application requires a
170 PostgreSQL version. This is embedded in the Enea Edge Management Controller 172 specific PostgreSQL version. This is embedded in the Enea Edge
171 installation. In order to avoid conflicts, any existing PostgreSQL 173 Management Controller installation. In order to avoid conflicts, any
172 installation needs to be uninstalled.</para> 174 existing PostgreSQL installation needs to be uninstalled.</para>
173 </section> 175 </section>
174 176
175 <section id="edge_mg_ctrl_install"> 177 <section id="edge_mg_ctrl_install">
176 <title>Installing the Enea Edge Management Controller</title> 178 <title>Installing the Enea Edge Management Controller</title>
177 179
178 <para>The Enea Edge Management Controller application can be installed using a 180 <para>The Enea Edge Management Controller application can be installed
179 fresh (first-time) configuration.</para> 181 using a fresh (first-time) configuration.</para>
180 182
181 <section id="edge_mg_ctrl_fresh_ucpemg_install"> 183 <section id="edge_mg_ctrl_fresh_ucpemg_install">
182 <title>Fresh Installation of the Enea Edge Management Controller</title> 184 <title>Fresh Installation of the Enea Edge Management
185 Controller</title>
183 186
184 <para>On the CentOS 7 server open a terminal, log into a bash shell 187 <para>On the CentOS 7 server open a terminal, log into a bash shell
185 with the root account and perform the following:</para> 188 with the root account and perform the following:</para>
186 189
187 <orderedlist> 190 <orderedlist>
188 <listitem> 191 <listitem>
189 <para>Extract 192 <para>Extract
190 <literal>Enea_Edge_Management_Controller_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para> 193 <literal>Enea_Edge_Management_Controller_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</literal></para>
191 194
192 <para>The directory in which the archive has been unpacked will 195 <para>The directory in which the archive has been unpacked will
193 be denoted as: 196 be denoted as:
194 <literal>&lt;EneaEdgeManagementController-installerdir&gt;</literal>.</para> 197 <literal>&lt;EneaEdgeManagementController-installerdir&gt;</literal>.</para>
195 </listitem> 198 </listitem>
196 199
197 <listitem> 200 <listitem>
198 <para>Enter 201 <para>Enter
199 <literal>&lt;EneaEdgeManagementController-installerdir&gt;/dist</literal>.</para> 202 <literal>&lt;EneaEdgeManagementController-installerdir&gt;/dist</literal>.</para>
200 </listitem> 203 </listitem>
201 204
202 <listitem> 205 <listitem>
203 <para>Choose the target installation folder, e.g. 206 <para>Choose the target installation folder, e.g.
204 <literal>/opt/ems</literal>. Everything will be installed under 207 <literal>/opt/ems</literal>. Everything will be installed under
205 a folder called <literal>/EneaEdgeManagementController</literal> 208 a folder called <literal>/EneaEdgeManagementController</literal>
206 within the target installation folder.</para> 209 within the target installation folder.</para>
207 210
208 <para>The application files will be installed in the 211 <para>The application files will be installed in the
209 <literal>/opt/ems/EneaEdgeManagementController/application</literal> 212 <literal>/opt/ems/EneaEdgeManagementController/application</literal>
210 folder. The database will be installed in 213 folder. The database will be installed in
211 <literal>/opt/ems/EneaEdgeManagementController/database</literal>.</para> 214 <literal>/opt/ems/EneaEdgeManagementController/database</literal>.</para>
212 </listitem> 215 </listitem>
213 216
214 <listitem> 217 <listitem>
215 <para>Run the following interactive command:</para> 218 <para>Run the following interactive command:</para>
216 219
217 <programlisting>./install.sh /opt/ems \ 220 <programlisting>./install.sh /opt/ems \
218Enea_Edge_Management_Controller_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting> 221Enea_Edge_Management_Controller_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programlisting>
219 222
220 <para>The default configuration values are specified in brackets. 223 <para>The default configuration values are specified in
221 If no other value is preferred and typed in, pressing 224 brackets. If no other value is preferred and typed in, pressing
222 <literal>ENTER</literal> will keep the default values. When there 225 <literal>ENTER</literal> will keep the default values. When
223 is an option within parentheses (i.e.Y/N), a value must be 226 there is an option within parentheses (i.e.Y/N), a value must be
224 specified.</para> 227 specified.</para>
225 228
226 <itemizedlist> 229 <itemizedlist>
227 <listitem> 230 <listitem>
228 <para>Database Configurations:</para> 231 <para>Database Configurations:</para>
229 232
230 <itemizedlist spacing="compact"> 233 <itemizedlist spacing="compact">
231 <listitem> 234 <listitem>
232 <para>Are you using the embedded PostgreSQL database? 235 <para>Are you using the embedded PostgreSQL database?
233 [Y/N]: <literal>Y</literal>.</para> 236 [Y/N]: <literal>Y</literal>.</para>
234 </listitem> 237 </listitem>
235 238
236 <listitem> 239 <listitem>
237 <para>Specify the database process password 240 <para>Specify the database process password
238 <literal>[postgres]</literal>:</para> 241 <literal>[postgres]</literal>:</para>
239 </listitem> 242 </listitem>
240 243
241 <listitem> 244 <listitem>
242 <para>Specify the database ID (or name) 245 <para>Specify the database ID (or name)
243 <literal>[EneaEdgeManagementController]</literal>:</para> 246 <literal>[EneaEdgeManagementController]</literal>:</para>
244 </listitem> 247 </listitem>
245 248
246 <listitem> 249 <listitem>
247 <para>Specify the database server port 250 <para>Specify the database server port
248 <literal>[5432]</literal>:</para> 251 <literal>[5432]</literal>:</para>
249 </listitem> 252 </listitem>
250 253
251 <listitem> 254 <listitem>
252 <para>Specify a database user name 255 <para>Specify a database user name
253 <literal>[postgres]</literal>:</para> 256 <literal>[postgres]</literal>:</para>
254 </listitem> 257 </listitem>
255 258
256 <listitem> 259 <listitem>
257 <para>Specify a database password 260 <para>Specify a database password
258 <literal>[postgres]</literal>:</para> 261 <literal>[postgres]</literal>:</para>
259 </listitem> 262 </listitem>
260 263
261 <listitem> 264 <listitem>
262 <para>Specify the database startup thread pool size 265 <para>Specify the database startup thread pool size
263 <literal>[1]</literal>:</para> 266 <literal>[1]</literal>:</para>
264 </listitem> 267 </listitem>
265 </itemizedlist> 268 </itemizedlist>
266 </listitem> 269 </listitem>
267 270
268 <listitem> 271 <listitem>
269 <para>Service Configurations:</para> 272 <para>Service Configurations:</para>
270 273
271 <itemizedlist spacing="compact"> 274 <itemizedlist spacing="compact">
272 <listitem> 275 <listitem>
273 <para>Specify a service username 276 <para>Specify a service username
274 <literal>[EneaEdgeManagementController]:</literal></para> 277 <literal>[EneaEdgeManagementController]:</literal></para>
275 </listitem> 278 </listitem>
276 279
277 <listitem> 280 <listitem>
278 <para>Specify a service password 281 <para>Specify a service password
279 <literal>[EneaEdgeManagementController]</literal>:</para> 282 <literal>[EneaEdgeManagementController]</literal>:</para>
280 </listitem> 283 </listitem>
281 </itemizedlist> 284 </itemizedlist>
282 </listitem> 285 </listitem>
283 286
284 <listitem> 287 <listitem>
285 <para>Network Configurations:</para> 288 <para>Network Configurations:</para>
286 289
287 <itemizedlist spacing="compact"> 290 <itemizedlist spacing="compact">
288 <listitem> 291 <listitem>
289 <para>Specify the IP address of the local interface: The 292 <para>Specify the IP address of the local interface: The
290 CentOS 7 Server loopback address: 293 CentOS 7 Server loopback address:
291 <literal>127.0.0.1</literal>.</para> 294 <literal>127.0.0.1</literal>.</para>
292 </listitem> 295 </listitem>
293 296
294 <listitem> 297 <listitem>
295 <para>Is this server part of a cluster? [Y/N]: 298 <para>Is this server part of a cluster? [Y/N]:
296 <literal>N</literal>.</para> 299 <literal>N</literal>.</para>
297 </listitem> 300 </listitem>
298 </itemizedlist> 301 </itemizedlist>
299 </listitem> 302 </listitem>
300 303
301 <listitem> 304 <listitem>
302 <para>Create the self-signed certificate: <literal>Specify IP or domain name</literal> 305 <para>Create the self-signed certificate: <literal>Specify
303 (or press <literal>Enter</literal> to skip):</para> 306 IP or domain name</literal> (or press
307 <literal>Enter</literal> to skip):</para>
304 308
305 <para>The Tomcat self-signed certificate can be generated 309 <para>The Tomcat self-signed certificate can be generated
306 again by running the 310 again by running the
307 <filename>createCertificate.sh</filename> script. For more details, please see <olink 311 <filename>createCertificate.sh</filename> script. For more
312 details, please see <olink
308 targetdoc="book_enea_edge_getting_started" 313 targetdoc="book_enea_edge_getting_started"
309 targetptr="create_certificate">Tomcat Certificate 314 targetptr="create_certificate">Tomcat Certificate Generation
310 Generation in the <ns:include 315 in the <ns:include
311 href="../../s_docbuild/olinkdb/pardoc-names.xml" 316 href="../../s_docbuild/olinkdb/pardoc-names.xml"
312 xpointer="element(book_enea_edge_getting_started/1)" 317 xmlns:ns="http://www.w3.org/2001/XInclude"
313 xmlns:ns="http://www.w3.org/2001/XInclude" /></olink> Manual.</para> 318 xpointer="element(book_enea_edge_getting_started/1)" /></olink>
314 319 Manual.</para>
315 <note> 320
316 <para>The generation of the Tomcat self-signed certificate 321 <note>
317 should be skipped only if another certifcate will be 322 <para>The generation of the Tomcat self-signed certificate
318 provided.</para> 323 should be skipped only if another certificate will be
319 </note> 324 provided.</para>
320 </listitem> 325 </note>
321 326 </listitem>
322 <listitem> 327
323 <para>Heap Configuration: <literal>Please enter the new 328 <listitem>
324 Maximum Heap Size [4g]</literal>:</para> 329 <para>Heap Configuration: <literal>Please enter the new
325 </listitem> 330 Maximum Heap Size [4g]</literal>:</para>
326 </itemizedlist> 331 </listitem>
327 332 </itemizedlist>
328 <para>These commands will:</para> 333
329 334 <para>These commands will:</para>
330 <itemizedlist spacing="compact"> 335
331 <listitem> 336 <itemizedlist spacing="compact">
332 <para>Extract the application files from the compressed 337 <listitem>
333 installation kit.</para> 338 <para>Extract the application files from the compressed
334 </listitem> 339 installation kit.</para>
335 340 </listitem>
336 <listitem> 341
337 <para>Install the bundled database.</para> 342 <listitem>
338 </listitem> 343 <para>Install the bundled database.</para>
339 344 </listitem>
340 <listitem> 345
346 <listitem>
341 <para>Install the Enea Edge Management Controller 347 <para>Install the Enea Edge Management Controller
342 application as a service with the name 348 application as a service with the name
343 <literal>EneaEdgeManagementController</literal>.</para> 349 <literal>EneaEdgeManagementController</literal>.</para>
344 </listitem> 350 </listitem>
345 351
346 <listitem> 352 <listitem>
347 <para>Start the 353 <para>Start the
348 <literal>EneaEdgeManagementController</literal> 354 <literal>EneaEdgeManagementController</literal>
349 service.</para> 355 service.</para>
350 </listitem> 356 </listitem>
351 </itemizedlist> 357 </itemizedlist>
352 </listitem> 358 </listitem>
353 359
354 <listitem> 360 <listitem>
355 <para>Using the IPv4 address of the CentOS 7 Server in a web 361 <para>Using the IPv4 or the FQDN address of the CentOS 7 Server
356 browser, log into the Enea Edge Management Controller GUI using the default 362 in a web browser, log into the Enea Edge Management Controller
357 username and password: <literal>admin/admin</literal>.</para> 363 GUI using the default username and password:
358 </listitem> 364 <literal>admin/admin</literal>.</para>
359 </orderedlist> 365 </listitem>
360 366 </orderedlist>
367 </section>
361 </section> 368 </section>
362 </section> 369 </section>
363 </section> 370 </section>
364 </section> 371
365 372 <section id="edge_mg_ctrl_uninstall">
366 <section id="edge_mg_ctrl_uninstall"> 373 <title>Uninstalling an existing Enea Edge Management Controller
367 <title>Uninstalling an existing Enea Edge Management Controller Installation</title> 374 Installation</title>
368 375
369 <emphasis role="bold">How to uninstall an existing Enea Edge Management 376 <emphasis role="bold">How to uninstall an existing Enea Edge Management
370 Controller installation</emphasis> 377 Controller installation</emphasis>
371 378
372 <orderedlist> 379 <orderedlist>
373 <listitem> 380 <listitem>
374 <para>Navigate to the folder where the Enea Edge Management Controller 381 <para>Navigate to the folder where the Enea Edge Management Controller
375 application is unpacked: 382 application is unpacked:
376 <filename>&lt;EneaEdgeManagementController-installerdir&gt;</filename>.</para> 383 <filename>&lt;EneaEdgeManagementController-installerdir&gt;</filename>.</para>
377 </listitem> 384 </listitem>
378
379 <listitem>
380 <para>Enter
381 <literal>&lt;EneaEdgeManagementController-installerdir&gt;/dist</literal>.</para>
382 </listitem>
383
384 <listitem>
385 <para>Run the following command with the root user and change
386 <literal>/opt/ems</literal> to the correct location of the Enea Edge
387 Management Controller installation:</para>
388 385
389 <programlisting>./uninstall.sh /opt/ems</programlisting> 386 <listitem>
390 </listitem> 387 <para>Enter
391 </orderedlist> 388 <literal>&lt;EneaEdgeManagementController-installerdir&gt;/dist</literal>.</para>
389 </listitem>
392 390
393 <para>Running this command will:</para> 391 <listitem>
392 <para>Run the following command with the root user and change
393 <literal>/opt/ems</literal> to the correct location of the Enea Edge
394 Management Controller installation:</para>
394 395
395 <itemizedlist> 396 <programlisting>./uninstall.sh /opt/ems</programlisting>
396 <listitem> 397 </listitem>
397 <para>Stop the currently running 398 </orderedlist>
398 <literal>EneaEdgeManagementController</literal> service.</para>
399 </listitem>
400 399
401 <listitem> 400 <para>Running this command will:</para>
402 <para>Create a compressed file of the <literal>EneaEdgeManagementController</literal>
403 application folder:
404 <filename>EneaEdgeManagementController-Backup-YYYYddMMHHmm.tar.gz</filename>,
405 which contains a snapshot of the existing installation and functions
406 as a restore point.</para>
407 401
408 <note> 402 <itemizedlist>
409 <para>The snapshot file created during the uninstall can be used for 403 <listitem>
410 restoring the Enea Edge Management Controller application.</para> 404 <para>Stop the currently running
411 </note> 405 <literal>EneaEdgeManagementController</literal> service.</para>
412 </listitem> 406 </listitem>
413 407
414 <listitem> 408 <listitem>
415 <para>Uninstall the <literal>EneaEdgeManagementController</literal> 409 <para>Uninstall the <literal>EneaEdgeManagementController</literal>
416 service, so that it will not start up on reboot.</para> 410 service, so that it will not start up on reboot.</para>
417 </listitem> 411 </listitem>
418 412
419 <listitem> 413 <listitem>
420 <para>Uninstall the database service.</para> 414 <para>Uninstall the database service.</para>
421 </listitem> 415 </listitem>
422 416
423 <listitem> 417 <listitem>
424 <para>Completely remove the contents of the application and database 418 <para>Completely remove the contents of the application and database
425 folders.</para> 419 folders.</para>
426 </listitem> 420 </listitem>
427 </itemizedlist> 421 </itemizedlist>
422
423 <para>After these steps, the Enea Edge Management Controller application
424 is completely removed from the system.</para>
425 </section>
428 426
429 <para>After these steps, the Enea Edge Management Controller application is
430 completely removed from the system.</para>
431 </section>
432
433 <section id="edge_mg_ctrl_usage"> 427 <section id="edge_mg_ctrl_usage">
434 <title>Using the Enea Edge Management Controller application</title> 428 <title>Using the Enea Edge Management Controller application</title>
435 429
436 <para>Usage of the Enea Edge Management Controller application will be detailed in the 430 <para>Usage of the Enea Edge Management Controller application will be
437 sections below.</para> 431 detailed in the sections below.</para>
438 432
439 <section id="edge_mg_ctrl_landing"> 433 <section id="edge_mg_ctrl_landing">
440 <title>Login for the Enea Edge Management Controller</title> 434 <title>Login for the Enea Edge Management Controller</title>
441 435
442 <para>When accessing the Enea Edge Management Controller login page the 436 <para>When accessing the Enea Edge Management Controller login page the
443 following fields will be available:</para> 437 following fields will be available:</para>
444 438
445 <itemizedlist> 439 <itemizedlist>
446 <listitem> 440 <listitem>
447 <programlisting>User Name:</programlisting> 441 <programlisting>User Name:</programlisting>
@@ -456,82 +450,112 @@ Enea_Edge_Management_Controller_&lt;version&gt;-build&lt;build_number&gt;.tar.gz
456 <para>Used to input the Enea Edge Management Controller 450 <para>Used to input the Enea Edge Management Controller
457 password.</para> 451 password.</para>
458 </listitem> 452 </listitem>
459 </itemizedlist> 453 </itemizedlist>
454 <para>Default values for the username and password credentials
455 are <emphasis role="bold">admin/admin</emphasis>, respectively.</para>
460 </section> 456 </section>
461 457
462 <section id="edge_mg_ctrl_add_element"> 458 <section id="edge_mg_ctrl_add_element">
463 <title>Adding Enea Edge Management application instances to the Enea 459 <title>Adding Enea Edge Management application instances to the Enea
464 Edge Management Controller</title> 460 Edge Management Controller</title>
465 461
466 <para>Use the following steps when adding a new Enea Edge Management 462 <para>Use the following steps when adding a new Enea Edge Management
467 application instance to the Enea Edge Management Controller:</para> 463 application instance to the Enea Edge Management Controller:</para>
468 464
469 <orderedlist> 465 <orderedlist>
470 <listitem> 466 <listitem>
471 <para>Log into the Enea Edge Management Controller. This is done 467 <para>Log into the Enea Edge Management Controller. This is done
472 using the configured credentials.</para> 468 using the configured credentials.</para>
473 </listitem> 469 </listitem>
474
475 <listitem>
476 <para>From the <emphasis role="bold">Devices</emphasis> menu, select the
477 <emphasis role="bold">Manage</emphasis> option.</para>
478 </listitem>
479
480 <listitem>
481 <para>In the <emphasis role="bold">Manage Devices</emphasis> menu, click the
482 <emphasis role="bold">Add</emphasis> button.</para>
483 </listitem>
484
485 <listitem>
486 <para>Fill in the required parameters in the newly opened window:
487 the Enea Edge Management application server name, the public IP, the
488 username and password to be used to connect to the application, and
489 the server name.</para>
490 </listitem>
491 470
492 <listitem> 471 <listitem>
472 <para>From the <emphasis role="bold">Devices</emphasis> menu, select
473 the <emphasis role="bold">Manage</emphasis> option.</para>
474 </listitem>
475
476 <listitem>
477 <para>In the <emphasis role="bold">Manage Devices</emphasis> menu,
478 click the <emphasis role="bold">Add</emphasis> button.</para>
479 </listitem>
480
481 <listitem>
482 <para>Fill in the required parameters in the newly opened window:
483 the Enea Edge Management application server name, the public IP or
484 FQDN address, the username and password to be used to connect to the
485 application, and the server name.</para>
486 </listitem>
487
488 <listitem>
489 <para>If actions are done on an Enea Edge Management application that
490 might require ignoring events coming from it (e.g.: an upgrade or a
491 temporary shutdown) then the <emphasis role="bold">Maintenance</emphasis>
492 checkbox can be enabled. With this enabled, the Controller will consider
493 the Enea Edge Management application to be in Maintenance mode. It will
494 set a blue dot to mark this mode and will ignore events raised by
495 the application.</para>
496 </listitem>
497
498 <listitem>
493 <para>Click <emphasis role="bold">OK</emphasis>. If the provided IP 499 <para>Click <emphasis role="bold">OK</emphasis>. If the provided IP
494 and credentials are correct, the status of the device will become 500 or FQDN address and credentials are correct, the status of the
495 green in a few minutes.</para> 501 device will become green in a few minutes.</para>
496 </listitem> 502 </listitem>
497 </orderedlist> 503 </orderedlist>
498 504
499 <para>Once an Enea Edge Management application is added as a device, it 505 <para>Once an Enea Edge Management application is added as a device, it
500 can be accessed from the browser at the following address: 506 can be accessed from the browser at the following address:
501 <literal>https://&lt;edgecontrolleraddress&gt;/edgemanagement/&lt;name_of_the_edge_management_application&gt;</literal>.</para> 507 <literal>https://&lt;edgecontrolleraddress&gt;/edgemanagement/&lt;name_of_the_edge_management_application&gt;</literal>.</para>
502 </section> 508 </section>
503 509
504 <section id="edge_mg_ctrl_alarms"> 510 <section id="edge_mg_ctrl_alarms">
505 <title>Support for Enea Edge Management application alarms in the Enea 511 <title>Support for Enea Edge Management application alarms in the Enea
506 Edge Management Controller</title> 512 Edge Management Controller</title>
513
514 <para>After a new Enea Edge Management application instance has been
515 added to the Enea Edge Management Controller, alarms raised in the
516 application will be visible on the Controller side. Each Enea Edge
517 Management application has its own alarms.</para>
518
519 <para>For multiple instances of an alarm raised on a single Enea Edge
520 Management application instance e.g.: multiple devices are
521 disconnected), only one instance of the alarm will be raised on the
522 Controller side. In that alarm's details, the IDs of all the devices
523 that have triggered it on the Enea Edge Management application side will
524 be displayed. An alarm displayed in the Management Controller will be
525 visible as long as there is an instance of it in the Enea Edge
526 Management application that raised it.</para>
507 527
508 <para>After a new Enea Edge Management application instance has been added 528 <para>For more details regarding an alarm, the user can access the Enea
509 to the Enea Edge Management Controller, alarms raised in the application will 529 Edge Management application that raised it. This can be done either by
510 be visible on the Controller side. Each Enea Edge Management application has 530 using the mechanism described in the previous chapter or by clicking
511 its own alarms.</para> 531 the <emphasis role="bold">Web UI</emphasis> button available in the
512 532 Controller's toolbar or context menu when the application is selected.
513 <para>For multiple instances of an alarm raised on a single Enea Edge 533 The names associated to the IDs from the alarm details can be found in
514 Management application instance e.g.: multiple devices are disconnected), 534 the Enea Edge Management application by selecting the
515 only one instance of the alarm will be raised on the Controller side. In that 535 <emphasis role="bold">Manage</emphasis> option in the
516 alarm's details, the IDs of all the devices that have triggered it on the 536 <emphasis role="bold">Devices</emphasis> menu, and checking the
517 Enea Edge Management application side will be displayed. An alarm displayed in the 537 <emphasis role="bold">ID</emphasis> column in the window that opens.</para>
518 Management Controller will be visible as long as there is an instance of it in the 538
519 Enea Edge Management application that raised it.</para> 539 <para>Alarms keep the severity listed in the Enea Edge Management
520 540 application when they are displayed in the Enea Edge Management
521 <para>Alarms keep the severity listed in the Enea Edge Management application when they 541 Controller (e.g: a Critical alarm from the Management application will
522 are displayed in the Enea Edge Management Controller (e.g: a Critical alarm from the 542 be raised as a Critical alarm on the Controller side).</para>
523 Management application will be raised as a Critical alarm on the Controller side).</para> 543
524 544 <para>Alarms raised on the Enea Edge Management application cannot be
525 <para>Alarms raised on the Enea Edge Management application cannot be cleared in the Enea Edge 545 cleared in the Enea Edge Management Controller. Once an alarm has been
526 Management Controller. Once an alarm has been cleared in the Enea Edge Management application, it 546 cleared in the Enea Edge Management application, it will be
527 will be automatically cleared in the Enea Edge Management Controller as well.</para> 547 automatically cleared in the Enea Edge Management Controller as
528 548 well.</para>
529 <para>Deleting an instance of the Enea Edge Management application will also remove any 549
530 associated alarms from the Enea Edge Management Controller.</para> 550 <para>Deleting an instance of the Enea Edge Management application will
531 551 also remove any associated alarms from the Enea Edge Management
532 <note><para>Up to 1 minute can pass between an alarm being raised or cleared in an 552 Controller.</para>
533 Enea Edge Management Application and the same alarm being raised or cleared 553
534 in the Enea Edge Management Controller.</para></note> 554 <note>
555 <para>Up to 1 minute can pass between an alarm being raised or cleared
556 in an Enea Edge Management Application and the same alarm being raised
557 or cleared in the Enea Edge Management Controller.</para>
558 </note>
535 </section> 559 </section>
536 </section> 560 </section>
537</chapter> \ No newline at end of file 561</chapter> \ No newline at end of file
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-13 03:49:24 +0000