diff options
author | Stefan Chiripuci <stci@enea.se> | 2021-06-18 13:32:35 +0300 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2021-06-23 10:02:29 +0100 |
commit | 3f9821c56bdd592cd424970b0ddc427479e0f7e3 (patch) | |
tree | f7770b177627dc8d689a805bb0b0c53c1fd4a70b | |
parent | 3759f553476c1c568d5a136f4cd997d04c1fdd37 (diff) | |
download | nfv-access-documentation-PoC_CPDX-3520.tar.gz |
Update release info with Edge Management Controller information.feature_CPDX-3520PoC_CPDX-3520
Update naming scheme in getting started documentation.
Change-Id: Id4bb85edf08547d7053ac2062c073fd61742d732
5 files changed, 91 insertions, 24 deletions
diff --git a/doc/book-enea-edge-getting-started/doc/management_controller.xml b/doc/book-enea-edge-getting-started/doc/management_controller.xml index 851c14f..a82dbaa 100644 --- a/doc/book-enea-edge-getting-started/doc/management_controller.xml +++ b/doc/book-enea-edge-getting-started/doc/management_controller.xml | |||
@@ -200,13 +200,13 @@ export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar</p | |||
200 | <listitem> | 200 | <listitem> |
201 | <para>Choose the target installation folder, e.g. | 201 | <para>Choose the target installation folder, e.g. |
202 | <literal>/opt/ems</literal>. Everything will be installed under a | 202 | <literal>/opt/ems</literal>. Everything will be installed under a |
203 | folder called <literal>/managementcontroller</literal> within the target | 203 | folder called <literal>/Enea_Edge_Management_Controller</literal> within the target |
204 | installation folder.</para> | 204 | installation folder.</para> |
205 | 205 | ||
206 | <para>The application files will be installed in the | 206 | <para>The application files will be installed in the |
207 | <literal>/opt/ems/managementcontroller/application</literal> folder, while the database | 207 | <literal>/opt/ems/Enea_Edge_Management_Controller/application</literal> folder, while the database |
208 | will be installed in | 208 | will be installed in |
209 | <literal>/opt/ems/managementcontroller/database</literal>.</para> | 209 | <literal>/opt/ems/Enea_Edge_Management_Controller/database</literal>.</para> |
210 | </listitem> | 210 | </listitem> |
211 | 211 | ||
212 | <listitem> | 212 | <listitem> |
@@ -238,7 +238,7 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
238 | 238 | ||
239 | <listitem> | 239 | <listitem> |
240 | <para>Specify the database ID (or name) | 240 | <para>Specify the database ID (or name) |
241 | <literal>[managementcontroller]</literal>:</para> | 241 | <literal>[Enea_Edge_Management_Controller]</literal>:</para> |
242 | </listitem> | 242 | </listitem> |
243 | 243 | ||
244 | <listitem> | 244 | <listitem> |
@@ -269,12 +269,12 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
269 | <itemizedlist spacing="compact"> | 269 | <itemizedlist spacing="compact"> |
270 | <listitem> | 270 | <listitem> |
271 | <para>Specify a service username | 271 | <para>Specify a service username |
272 | <literal>[managementcontroller]:</literal></para> | 272 | <literal>[Enea_Edge_Management_Controller]:</literal></para> |
273 | </listitem> | 273 | </listitem> |
274 | 274 | ||
275 | <listitem> | 275 | <listitem> |
276 | <para>Specify a service password | 276 | <para>Specify a service password |
277 | <literal>[managementcontroller]</literal>:</para> | 277 | <literal>[Enea_Edge_Management_Controller]</literal>:</para> |
278 | </listitem> | 278 | </listitem> |
279 | </itemizedlist> | 279 | </itemizedlist> |
280 | </listitem> | 280 | </listitem> |
@@ -337,11 +337,11 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
337 | 337 | ||
338 | <listitem> | 338 | <listitem> |
339 | <para>Install the Enea Edge Management Controller application as a | 339 | <para>Install the Enea Edge Management Controller application as a |
340 | service with the name <literal>managementcontroller</literal>.</para> | 340 | service.</para> |
341 | </listitem> | 341 | </listitem> |
342 | 342 | ||
343 | <listitem> | 343 | <listitem> |
344 | <para>Start the <literal>managementcontroller</literal> service.</para> | 344 | <para>Start the Enea Edge Management Controller service.</para> |
345 | </listitem> | 345 | </listitem> |
346 | </itemizedlist> | 346 | </itemizedlist> |
347 | </listitem> | 347 | </listitem> |
@@ -388,14 +388,14 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
388 | 388 | ||
389 | <itemizedlist> | 389 | <itemizedlist> |
390 | <listitem> | 390 | <listitem> |
391 | <para>Stop the currently running <literal>managementcontroller</literal> | 391 | <para>Stop the currently running Enea Edge Management Controller |
392 | service.</para> | 392 | service.</para> |
393 | </listitem> | 393 | </listitem> |
394 | 394 | ||
395 | <listitem> | 395 | <listitem> |
396 | <para>Create a compressed file of the <literal>managementcontroller</literal> | 396 | <para>Create a compressed file of the Enea Edge Management Controller |
397 | application folder: | 397 | application folder: |
398 | <filename>managementcontroller-Backup-YYYYddMMHHmm.tar.gz</filename>, which | 398 | <filename>Enea_Edge_Management_Controller-Backup-YYYYddMMHHmm.tar.gz</filename>, which |
399 | contains a snapshot of the existing installation and functions as a | 399 | contains a snapshot of the existing installation and functions as a |
400 | restore point.</para> | 400 | restore point.</para> |
401 | 401 | ||
@@ -406,7 +406,7 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
406 | </listitem> | 406 | </listitem> |
407 | 407 | ||
408 | <listitem> | 408 | <listitem> |
409 | <para>Uninstall the <literal>managementcontroller</literal> service, so that | 409 | <para>Uninstall the Enea Edge Management Controller service, so that |
410 | it will not start up on reboot.</para> | 410 | it will not start up on reboot.</para> |
411 | </listitem> | 411 | </listitem> |
412 | 412 | ||
@@ -438,10 +438,12 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
438 | 438 | ||
439 | <itemizedlist> | 439 | <itemizedlist> |
440 | <listitem><programlisting>User Name:</programlisting> | 440 | <listitem><programlisting>User Name:</programlisting> |
441 | <para>Used to input the Enea Edge Management Controller username.</para></listitem> | 441 | <para>Used to input the Enea Edge Management Controller username or the access username |
442 | configured for a Management application.</para></listitem> | ||
442 | 443 | ||
443 | <listitem><programlisting>Password:</programlisting> | 444 | <listitem><programlisting>Password:</programlisting> |
444 | <para>Used to input the Enea Edge Management Controller password.</para></listitem> | 445 | <para>Used to input the Enea Edge Management Controller password or the access password |
446 | configured for a Management application.</para></listitem> | ||
445 | 447 | ||
446 | <listitem><programlisting>Edge Management name:</programlisting> | 448 | <listitem><programlisting>Edge Management name:</programlisting> |
447 | <para>Used to input the Enea Edge Management application instance you wish to | 449 | <para>Used to input the Enea Edge Management application instance you wish to |
@@ -449,7 +451,7 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
449 | itself.</para></listitem> | 451 | itself.</para></listitem> |
450 | </itemizedlist> | 452 | </itemizedlist> |
451 | 453 | ||
452 | <para>If a valid Enea Edge Management Controller username and password are provided | 454 | <para>If a valid access username and password are provided |
453 | along with a valid Enea Edge Management application name, the user will be | 455 | along with a valid Enea Edge Management application name, the user will be |
454 | redirected to the Enea Edge Management application login page of the specified | 456 | redirected to the Enea Edge Management application login page of the specified |
455 | application.</para> | 457 | application.</para> |
@@ -479,14 +481,18 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
479 | </listitem> | 481 | </listitem> |
480 | 482 | ||
481 | <listitem> | 483 | <listitem> |
482 | <para>Fill in the required parameters in the newly opened window: the Edge Management | 484 | <para>Fill in the required parameters in the newly opened window: the Enea |
483 | application server name, the public IP, the username and password to be used to connect | 485 | Edge Management application server name, the public IP, the access username |
484 | to the application and the server name.</para> | 486 | and password and the Enea Edge Management username and password used to |
487 | connect to the application.</para> | ||
488 | |||
489 | <note><para>The access username and password are used to redirect to an | ||
490 | Enea Edge Management instance from the Controller's login page.</para></note> | ||
485 | </listitem> | 491 | </listitem> |
486 | 492 | ||
487 | <listitem> | 493 | <listitem> |
488 | <para>Click <emphasis role="bold">OK</emphasis>. If the provided IP and credentials | 494 | <para>Click <emphasis role="bold">OK</emphasis>. If the provided IP and Edge Management |
489 | are correct, the status of the device will become green in a few minutes.</para> | 495 | credentials are correct, the status of the device will become green in a few minutes.</para> |
490 | </listitem> | 496 | </listitem> |
491 | </orderedlist> | 497 | </orderedlist> |
492 | </section> | 498 | </section> |
@@ -498,9 +504,8 @@ Enea_Edge_Management_Controller_<version>-build<build_number>.tar.gz | |||
498 | Controller can be accessed from it in one of the following ways:</para> | 504 | Controller can be accessed from it in one of the following ways:</para> |
499 | 505 | ||
500 | <itemizedlist> | 506 | <itemizedlist> |
501 | <listitem><para>From the login page using the Edge Management name and your login | 507 | <listitem><para>From the login page using the Edge Management name and the access username |
502 | credentials for the Management Controller. This will redirect you to the | 508 | and password. This will redirect you to the application's login page.</para> |
503 | application's login page.</para> | ||
504 | </listitem> | 509 | </listitem> |
505 | 510 | ||
506 | <listitem><para>From the Management Controller's interface, by selecting the Enea | 511 | <listitem><para>From the Management Controller's interface, by selecting the Enea |
diff --git a/doc/book-enea-edge-release-info/doc/about_release.xml b/doc/book-enea-edge-release-info/doc/about_release.xml index 3cc854e..113f129 100644 --- a/doc/book-enea-edge-release-info/doc/about_release.xml +++ b/doc/book-enea-edge-release-info/doc/about_release.xml | |||
@@ -62,6 +62,14 @@ | |||
62 | </listitem> | 62 | </listitem> |
63 | </itemizedlist> | 63 | </itemizedlist> |
64 | 64 | ||
65 | <para>Early Access Components:</para> | ||
66 | |||
67 | <itemizedlist> | ||
68 | <listitem> | ||
69 | <para>Enea_Edge_Management_Controller_<version>-build<build_number>_EA.tar.gz</para> | ||
70 | </listitem> | ||
71 | </itemizedlist> | ||
72 | |||
65 | <programlisting condition="arm">-- documentation/ | 73 | <programlisting condition="arm">-- documentation/ |
66 | /* Enea Edge documentation */ | 74 | /* Enea Edge documentation */ |
67 | -- README | 75 | -- README |
diff --git a/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml index cecdb36..9a1401d 100644 --- a/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-edge-release-info/doc/known_bugs_and_limitations.xml | |||
@@ -9,6 +9,46 @@ | |||
9 | 9 | ||
10 | <itemizedlist> | 10 | <itemizedlist> |
11 | <listitem> | 11 | <listitem> |
12 | <para><remark>ELCCR-1603</remark> The Enea Edge Management Controller | ||
13 | Early Access Release has the following limitations:</para> | ||
14 | |||
15 | <itemizedlist> | ||
16 | <listitem> | ||
17 | <para>The Enea Edge Management Controller supports only the | ||
18 | embeded Postgres SQL as a deployment database.</para> | ||
19 | </listitem> | ||
20 | |||
21 | <listitem> | ||
22 | <para>The Enea Edge Management Controller and the Enea Edge | ||
23 | Management application cannot be deployed on the same | ||
24 | machine.</para> | ||
25 | </listitem> | ||
26 | |||
27 | <listitem> | ||
28 | <para>Cluster functionality is not supported for the Enea Edge | ||
29 | Management application. Select <emphasis role="bold">N</emphasis> when | ||
30 | prompted for this during deployment.</para> | ||
31 | </listitem> | ||
32 | |||
33 | <listitem> | ||
34 | <para>In the <emphasis role="bold">Statistics</emphasis> menu, | ||
35 | only the | ||
36 | <emphasis role="bold">Edge Management Controller</emphasis> | ||
37 | option is supported. The other options are currently not | ||
38 | supported.</para> | ||
39 | </listitem> | ||
40 | |||
41 | <listitem> | ||
42 | <para>In the <emphasis role="bold">Scheduled Ops</emphasis> | ||
43 | window, when creating a new scheduled operation, only the | ||
44 | <emphasis role="bold">System Back-up</emphasis> | ||
45 | functionality is supported. All other options are currently | ||
46 | not supported.</para> | ||
47 | </listitem> | ||
48 | </itemizedlist> | ||
49 | </listitem> | ||
50 | |||
51 | <listitem> | ||
12 | <para><remark>LXCR-9904</remark>Enea Edge Runtime cannot be installed on | 52 | <para><remark>LXCR-9904</remark>Enea Edge Runtime cannot be installed on |
13 | USB storage devices.</para> | 53 | USB storage devices.</para> |
14 | </listitem> | 54 | </listitem> |
diff --git a/doc/book-enea-edge-release-info/doc/main_changes.xml b/doc/book-enea-edge-release-info/doc/main_changes.xml index 8824aa3..87156d7 100644 --- a/doc/book-enea-edge-release-info/doc/main_changes.xml +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml | |||
@@ -15,6 +15,20 @@ | |||
15 | 15 | ||
16 | <itemizedlist> | 16 | <itemizedlist> |
17 | <listitem> | 17 | <listitem> |
18 | <para><remark>CPDX-3520</remark>Enea Edge Management Controller Early Access. | ||
19 | The Enea Edge Management controller is a tool for overseeing Enea Edge | ||
20 | Management applications and handling multiple tenant setups. Since it is | ||
21 | an Early Access solution, please see the list of limitations detailed in | ||
22 | the next chapter for possible issues. For more details on this feature, see <olink | ||
23 | targetdoc="book_enea_edge_getting_started" | ||
24 | targetptr="mgmt_controller">Deploying and using the Enea Edge Management Controller in the <xi:include | ||
25 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
26 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
27 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> | ||
28 | Manual.</para> | ||
29 | </listitem> | ||
30 | |||
31 | <listitem> | ||
18 | <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one | 32 | <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one |
19 | store/home office deployment. For more details please see the <olink | 33 | store/home office deployment. For more details please see the <olink |
20 | targetdoc="book_enea_edge_getting_started" | 34 | targetdoc="book_enea_edge_getting_started" |
diff --git a/doc/eltf_params_updated.xml b/doc/eltf_params_updated.xml index 34739ee..120a966 100644 --- a/doc/eltf_params_updated.xml +++ b/doc/eltf_params_updated.xml | |||
@@ -42,7 +42,7 @@ export PATH=~/bin:$PATH</programlisting></para> | |||
42 | correct also compared to the "previous" REL VER in pardoc-distro.xml | 42 | correct also compared to the "previous" REL VER in pardoc-distro.xml |
43 | "prev_baseline".</bridgehead> | 43 | "prev_baseline".</bridgehead> |
44 | 44 | ||
45 | <para id="EneaEdge_REL_VER"><phrase>2.5.0</phrase></para> | 45 | <para id="EneaEdge_REL_VER"><phrase>2.4.0</phrase></para> |
46 | 46 | ||
47 | <para id="ENA_BUILD_VER"><phrase>1</phrase></para> | 47 | <para id="ENA_BUILD_VER"><phrase>1</phrase></para> |
48 | 48 | ||