diff options
5 files changed, 22 insertions, 15 deletions
diff --git a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml index c1b554e..c5e7597 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml | |||
@@ -419,6 +419,13 @@ | |||
419 | <para><emphasis role="bold">Generating the device | 419 | <para><emphasis role="bold">Generating the device |
420 | config</emphasis></para> | 420 | config</emphasis></para> |
421 | 421 | ||
422 | <note> | ||
423 | <para>Make sure the management interface, the one that ensures the | ||
424 | connection between the Enea Edge Runtime Device and the Enea Edge | ||
425 | Management application, is not used when generating the JSON | ||
426 | configuration files.</para> | ||
427 | </note> | ||
428 | |||
422 | <orderedlist> | 429 | <orderedlist> |
423 | <listitem> | 430 | <listitem> |
424 | <para>Run <filename>generate_device_config.py</filename>:</para> | 431 | <para>Run <filename>generate_device_config.py</filename>:</para> |
@@ -502,7 +509,7 @@ store.json</programlisting> | |||
502 | 509 | ||
503 | <para>The names of the interfaces (<literal>mgmt_*, wan_*, | 510 | <para>The names of the interfaces (<literal>mgmt_*, wan_*, |
504 | lan_*</literal> and <literal>wap_*</literal>) are used to generate the | 511 | lan_*</literal> and <literal>wap_*</literal>) are used to generate the |
505 | config file for NIC and OVS bridges. Their values denpend on the input | 512 | config file for NIC and OVS bridges. Their values depend on the input |
506 | scenario.</para> | 513 | scenario.</para> |
507 | 514 | ||
508 | <para>When the script is interactively run, the parameter's value | 515 | <para>When the script is interactively run, the parameter's value |
@@ -631,7 +638,7 @@ Check 'test' directory for JSON configuration files</programlisting> | |||
631 | <itemizedlist> | 638 | <itemizedlist> |
632 | <listitem> | 639 | <listitem> |
633 | <para><filename>ibm_br.json</filename> - contains information | 640 | <para><filename>ibm_br.json</filename> - contains information |
634 | about the <literal>Inband management OVS | 641 | about the <literal>In-band management OVS |
635 | bridge</literal>:</para> | 642 | bridge</literal>:</para> |
636 | 643 | ||
637 | <programlisting>{ | 644 | <programlisting>{ |
@@ -789,7 +796,7 @@ Check 'test' directory for JSON configuration files</programlisting> | |||
789 | 796 | ||
790 | <para>Other classes from the <literal>automation_framework</literal> | 797 | <para>Other classes from the <literal>automation_framework</literal> |
791 | directory inherit this class, and call its methods.</para> | 798 | directory inherit this class, and call its methods.</para> |
792 | 799 | ||
793 | <note> | 800 | <note> |
794 | <para>The <literal>uCPEMgrHTTPClient</literal> class is a wrapper of | 801 | <para>The <literal>uCPEMgrHTTPClient</literal> class is a wrapper of |
795 | the <literal>ManagementClient</literal> class. All the methods defined | 802 | the <literal>ManagementClient</literal> class. All the methods defined |
@@ -809,7 +816,7 @@ Check 'test' directory for JSON configuration files</programlisting> | |||
809 | </listitem> | 816 | </listitem> |
810 | 817 | ||
811 | <listitem> | 818 | <listitem> |
812 | <para>The <literal>uCPEDeviceHandler</literal> class inherites the | 819 | <para>The <literal>uCPEDeviceHandler</literal> class inherits the |
813 | <literal>ManagementClient</literal> class.</para> | 820 | <literal>ManagementClient</literal> class.</para> |
814 | </listitem> | 821 | </listitem> |
815 | 822 | ||
@@ -891,7 +898,7 @@ Options: | |||
891 | </listitem> | 898 | </listitem> |
892 | </itemizedlist> | 899 | </itemizedlist> |
893 | 900 | ||
894 | <para>The <literal>uCPEDeviceHandler</literal> class inherites the | 901 | <para>The <literal>uCPEDeviceHandler</literal> class inherits the |
895 | <literal>Configuration</literal> class and all its methods.</para> | 902 | <literal>Configuration</literal> class and all its methods.</para> |
896 | 903 | ||
897 | <para>The functionalities for <literal>configure external | 904 | <para>The functionalities for <literal>configure external |
@@ -978,7 +985,7 @@ addDpdkExternalInterface eno4 vfio-pci</programlisting> | |||
978 | </listitem> | 985 | </listitem> |
979 | </itemizedlist> | 986 | </itemizedlist> |
980 | 987 | ||
981 | <para>The <literal>OfflineConfigHandler</literal> class inherites the | 988 | <para>The <literal>OfflineConfigHandler</literal> class inherits the |
982 | <literal>Configuration</literal> class with all its methods.</para> | 989 | <literal>Configuration</literal> class with all its methods.</para> |
983 | 990 | ||
984 | <para>The functionalities for the <literal>adding offline config | 991 | <para>The functionalities for the <literal>adding offline config |
@@ -1021,7 +1028,7 @@ addOfflineConfigStore -f <path_to_store_configuration_file></programlistin | |||
1021 | 1028 | ||
1022 | <para><emphasis role="bold">Example:</emphasis></para> | 1029 | <para><emphasis role="bold">Example:</emphasis></para> |
1023 | 1030 | ||
1024 | <programlisting>python automation_framework/OfflineConfigHandler.py -s testOfflienConfig -m | 1031 | <programlisting>python automation_framework/OfflineConfigHandler.py -s testOfflineConfig -m |
1025 | addOfflineConfigStore -f modules/enea/config/uCPEDevices/test/store.json</programlisting> | 1032 | addOfflineConfigStore -f modules/enea/config/uCPEDevices/test/store.json</programlisting> |
1026 | 1033 | ||
1027 | <para>The syntax for running the | 1034 | <para>The syntax for running the |
@@ -1107,7 +1114,7 @@ uploadImage <imagePath> <type></programlisting> | |||
1107 | 1114 | ||
1108 | <para>The default value for the <literal>module</literal> is | 1115 | <para>The default value for the <literal>module</literal> is |
1109 | <literal>VcepAgent</literal>, cannot be changed and it is | 1116 | <literal>VcepAgent</literal>, cannot be changed and it is |
1110 | ommited.</para> | 1117 | omitted.</para> |
1111 | 1118 | ||
1112 | <para><emphasis role="bold">Example:</emphasis></para> | 1119 | <para><emphasis role="bold">Example:</emphasis></para> |
1113 | 1120 | ||
@@ -1172,7 +1179,7 @@ Parameters(not needed): -- | |||
1172 | ...</programlisting> | 1179 | ...</programlisting> |
1173 | 1180 | ||
1174 | <para>The syntax for running the | 1181 | <para>The syntax for running the |
1175 | <literal>getManagementVersion</literal> functionaltity is:</para> | 1182 | <literal>getManagementVersion</literal> functionality is:</para> |
1176 | 1183 | ||
1177 | <programlisting>python automation_framework/ManagementHandler.py -m getManagementVersion -o</programlisting> | 1184 | <programlisting>python automation_framework/ManagementHandler.py -m getManagementVersion -o</programlisting> |
1178 | 1185 | ||
@@ -1289,7 +1296,7 @@ Parameters(not needed): -- | |||
1289 | 1296 | ||
1290 | <para>The <literal>test_harness</literal> directory contains all the | 1297 | <para>The <literal>test_harness</literal> directory contains all the |
1291 | implemented Ansible Playbooks. This directory contains the | 1298 | implemented Ansible Playbooks. This directory contains the |
1292 | <filename>check_errror.yml</filename> Playbook and many subdirectories, | 1299 | <filename>check_error.yml</filename> Playbook and many subdirectories, |
1293 | each subdirectory representing an Enea Edge Management module.</para> | 1300 | each subdirectory representing an Enea Edge Management module.</para> |
1294 | 1301 | ||
1295 | <para>The <filename>check_errors.yml</filename> Playbook checks the | 1302 | <para>The <filename>check_errors.yml</filename> Playbook checks the |
diff --git a/doc/book-enea-edge-automation-user-guide/doc/components.xml b/doc/book-enea-edge-automation-user-guide/doc/components.xml index 613644a..cb6c783 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/components.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/components.xml | |||
@@ -66,7 +66,7 @@ | |||
66 | <section id="automation"> | 66 | <section id="automation"> |
67 | <title>Enea Edge Automation</title> | 67 | <title>Enea Edge Automation</title> |
68 | 68 | ||
69 | <para>Enea Edge Automation has two compoments: Automation Framework and Test Harness. | 69 | <para>Enea Edge Automation has two components: Automation Framework and Test Harness. |
70 | It provides Python scripts using Enea Edge Management REST API and Ansible Playbooks.</para> | 70 | It provides Python scripts using Enea Edge Management REST API and Ansible Playbooks.</para> |
71 | 71 | ||
72 | <para>The Automation Framework component provides a Python unit-test suite that runs automatically the | 72 | <para>The Automation Framework component provides a Python unit-test suite that runs automatically the |
diff --git a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml index 517f165..c5b9568 100644 --- a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml +++ b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml | |||
@@ -215,12 +215,12 @@ | |||
215 | environment.</para> | 215 | environment.</para> |
216 | </note> | 216 | </note> |
217 | 217 | ||
218 | <para><emphasis role="bold">Setting up the enviroment for the Enea Edge | 218 | <para><emphasis role="bold">Setting up the environment for the Enea Edge |
219 | Automation</emphasis></para> | 219 | Automation</emphasis></para> |
220 | 220 | ||
221 | <orderedlist> | 221 | <orderedlist> |
222 | <listitem> | 222 | <listitem> |
223 | <para>Activate the Python virtual enviroment</para> | 223 | <para>Activate the Python virtual environment</para> |
224 | 224 | ||
225 | <programlisting>source <Automation-installdir>/testHarness-venv/bin/activate</programlisting> | 225 | <programlisting>source <Automation-installdir>/testHarness-venv/bin/activate</programlisting> |
226 | </listitem> | 226 | </listitem> |
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..980a84a 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 | |||
@@ -19,7 +19,7 @@ | |||
19 | </listitem> | 19 | </listitem> |
20 | 20 | ||
21 | <listitem> | 21 | <listitem> |
22 | <para><remark>ELCCR-527</remark>Cancelling a file upload in the Enea | 22 | <para><remark>ELCCR-527</remark>Canceling a file upload in the Enea |
23 | Edge Management will require the user to close and reopen the upload | 23 | Edge Management will require the user to close and reopen the upload |
24 | window for the next upload to work.</para> | 24 | window for the next upload to work.</para> |
25 | </listitem> | 25 | </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..63e2c47 100644 --- a/doc/book-enea-edge-release-info/doc/main_changes.xml +++ b/doc/book-enea-edge-release-info/doc/main_changes.xml | |||
@@ -15,7 +15,7 @@ | |||
15 | 15 | ||
16 | <itemizedlist> | 16 | <itemizedlist> |
17 | <listitem> | 17 | <listitem> |
18 | <para><remark>CPDX-3496</remark>Embedded WiFi support for all-in-one | 18 | <para><remark>CPDX-3496</remark>Embedded Wi-Fi support for all-in-one |
19 | store/home office deployment. For more details please see the <olink | 19 | store/home office deployment. For more details please see the <olink |
20 | targetdoc="book_enea_edge_getting_started" | 20 | targetdoc="book_enea_edge_getting_started" |
21 | targetptr="wap_interface_type">Wap Interface Type in the <xi:include | 21 | targetptr="wap_interface_type">Wap Interface Type in the <xi:include |