diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml | 55 |
1 files changed, 28 insertions, 27 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 f710ccb..bdc3343 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 | |||
| @@ -192,9 +192,9 @@ | |||
| 192 | <filename>OfflineConfigHandler.py</filename> script, where the | 192 | <filename>OfflineConfigHandler.py</filename> script, where the |
| 193 | <literal>OfflineConfigHandler</literal> class is defined. Inside | 193 | <literal>OfflineConfigHandler</literal> class is defined. Inside |
| 194 | this class, the methods for offline configuration functionality are | 194 | this class, the methods for offline configuration functionality are |
| 195 | implemented: <literal>addOfflineConfig</literal>, | 195 | implemented: <literal>addOfflineConfigStore</literal>, |
| 196 | <literal>removeOfflineConfig</literal>, | 196 | <literal>deleteOfflineConfigStore</literal>, |
| 197 | <literal>uploaOfflineConfig</literal> and so on.</para> | 197 | <literal>uploadConfigToDevice</literal> and so on.</para> |
| 198 | </listitem> | 198 | </listitem> |
| 199 | </itemizedlist> | 199 | </itemizedlist> |
| 200 | </section> | 200 | </section> |
| @@ -430,17 +430,17 @@ | |||
| 430 | <listitem> | 430 | <listitem> |
| 431 | <para>Run <filename>generate_device_config.py</filename>:</para> | 431 | <para>Run <filename>generate_device_config.py</filename>:</para> |
| 432 | 432 | ||
| 433 | <programlisting>testHarness-venv)> python generate_device_config.py | 433 | <programlisting>python generate_device_config.py |
| 434 | Device name: test | 434 | Device name: test |
| 435 | Device ID: test_id | 435 | Device ID: test_id |
| 436 | Device groupings tags [ ]: test_id | 436 | Device groupings tags [ ]: test_id |
| 437 | uCPE Device version [2.4.0]: 2.4.0 | 437 | uCPE Device version [2.5.0]: 2.5.0 |
| 438 | Device IP address [No]: 10.0.0.1 | 438 | Device IP address [No]: 10.0.0.1 |
| 439 | Call home [false]: | 439 | Call home [false]: |
| 440 | Mgmt network interface [No]: eth0 | 440 | Mgmt network interface - it must not be the management interface [No]: eth0 |
| 441 | WAN network interface [No]: eth1 | 441 | WAN network interface - it must not be the management interface [No]: eth1 |
| 442 | LAN network interface [No]: eth2 | 442 | LAN network interface - it must not be the management interface [No]: eth2 |
| 443 | WAP network interface [No]: wlan0 | 443 | WAP network interface - it must not be the management interface [No]: wlan0 |
| 444 | 444 | ||
| 445 | The following JSON config file was successfully created (uCPE Device config file): | 445 | The following JSON config file was successfully created (uCPE Device config file): |
| 446 | test.json | 446 | test.json |
| @@ -464,7 +464,7 @@ store.json</programlisting> | |||
| 464 | "deviceId": "test_id", | 464 | "deviceId": "test_id", |
| 465 | "deviceGroupingTags": "test_id", | 465 | "deviceGroupingTags": "test_id", |
| 466 | "name": "test", | 466 | "name": "test", |
| 467 | "version": "2.4.0", | 467 | "version": "2.5.0", |
| 468 | "callHome": "false", | 468 | "callHome": "false", |
| 469 | "address": "10.0.0.1", | 469 | "address": "10.0.0.1", |
| 470 | "certificate": null, | 470 | "certificate": null, |
| @@ -503,8 +503,8 @@ store.json</programlisting> | |||
| 503 | executed in a non-interactive way using the | 503 | executed in a non-interactive way using the |
| 504 | <command>--non-interactive</command> option, as follows:</para> | 504 | <command>--non-interactive</command> option, as follows:</para> |
| 505 | 505 | ||
| 506 | <programlisting>testHarness-venv)>python generate_device_config.py --non-interactive --device_name=test | 506 | <programlisting>python generate_device_config.py --non-interactive --device_name=test |
| 507 | --device_id=test_id --device_grouping_tags=test_id --version 2.4.0 | 507 | --device_id=test_id --device_grouping_tags=test_id --version 2.5.0 |
| 508 | --device_ip_addr=10.0.0.1 --call_home=false --mgmt_nic=eth0 --wan_nic=eth1 | 508 | --device_ip_addr=10.0.0.1 --call_home=false --mgmt_nic=eth0 --wan_nic=eth1 |
| 509 | --lan_nic=eth2 --wap_nic=wlan0</programlisting> | 509 | --lan_nic=eth2 --wap_nic=wlan0</programlisting> |
| 510 | 510 | ||
| @@ -529,7 +529,7 @@ store.json</programlisting> | |||
| 529 | <para>Run | 529 | <para>Run |
| 530 | <filename>generate_nics_config_files.py</filename>:</para> | 530 | <filename>generate_nics_config_files.py</filename>:</para> |
| 531 | 531 | ||
| 532 | <programlisting>(testHarness-venv)> python generate_nics_config_files.py | 532 | <programlisting>python generate_nics_config_files.py |
| 533 | Device name: test | 533 | Device name: test |
| 534 | Check 'test' directory for JSON configuration files</programlisting> | 534 | Check 'test' directory for JSON configuration files</programlisting> |
| 535 | </listitem> | 535 | </listitem> |
| @@ -606,7 +606,7 @@ Check 'test' directory for JSON configuration files</programlisting> | |||
| 606 | <para>The <filename>generate_nics_config_files.py</filename> script | 606 | <para>The <filename>generate_nics_config_files.py</filename> script |
| 607 | can be executed in a non-interactive way, as follows:</para> | 607 | can be executed in a non-interactive way, as follows:</para> |
| 608 | 608 | ||
| 609 | <programlisting>(testHarness-venv)> python generate_nics_config_files.py --device_name=test | 609 | <programlisting>python generate_nics_config_files.py --device_name=test |
| 610 | Check 'test' directory for JSON configuration files</programlisting> | 610 | Check 'test' directory for JSON configuration files</programlisting> |
| 611 | 611 | ||
| 612 | <para>The values from the JSON files depend on the input | 612 | <para>The values from the JSON files depend on the input |
| @@ -624,7 +624,7 @@ Check 'test' directory for JSON configuration files</programlisting> | |||
| 624 | <para>Run | 624 | <para>Run |
| 625 | <filename>generate_bridges_config_files.py</filename>:</para> | 625 | <filename>generate_bridges_config_files.py</filename>:</para> |
| 626 | 626 | ||
| 627 | <programlisting>(testHarness-venv)> python generate_bridges_config_files.py | 627 | <programlisting>python generate_bridges_config_files.py |
| 628 | Device name: test | 628 | Device name: test |
| 629 | Check 'test' directory for JSON configuration files</programlisting> | 629 | Check 'test' directory for JSON configuration files</programlisting> |
| 630 | </listitem> | 630 | </listitem> |
| @@ -720,7 +720,7 @@ Check 'test' directory for JSON configuration files</programlisting> | |||
| 720 | <para>The <filename>generate_bridges_config_files.py</filename> script | 720 | <para>The <filename>generate_bridges_config_files.py</filename> script |
| 721 | can be executed in a non-interactive way, as follows:</para> | 721 | can be executed in a non-interactive way, as follows:</para> |
| 722 | 722 | ||
| 723 | <programlisting>(testHarness-venv)> python generate_bridges_config_files.py --device-name=test | 723 | <programlisting>python generate_bridges_config_files.py --device-name=test |
| 724 | Check 'test' directory for JSON configuration files</programlisting> | 724 | Check 'test' directory for JSON configuration files</programlisting> |
| 725 | 725 | ||
| 726 | <para>The values from the JSON files depend on the input | 726 | <para>The values from the JSON files depend on the input |
| @@ -799,13 +799,14 @@ Check 'test' directory for JSON configuration files</programlisting> | |||
| 799 | directory inherit this class, and call its methods.</para> | 799 | directory inherit this class, and call its methods.</para> |
| 800 | 800 | ||
| 801 | <note> | 801 | <note> |
| 802 | <para>The <literal>uCPEMgrHTTPClient</literal> class is a wrapper of | 802 | <para>The <literal>uCPEMgrHTTPClientRestAPIv2</literal> class is a |
| 803 | the <literal>ManagementClient</literal> class. All the methods defined | 803 | wrapper of the <literal>ManagementClient</literal> class. All the |
| 804 | in the <literal>ManagementClient</literal> class can be used when the | 804 | methods defined in the <literal>ManagementClient</literal> class can |
| 805 | <literal>uCPEMgrHTTPClient</literal> object is instantiated. The | 805 | be used when the <literal>uCPEMgrHTTPClientRestAPIv2</literal> object |
| 806 | <literal>uCPEMgrHTTPClient</literal> object is deprecated and will be | 806 | is instantiated. The <literal>uCPEMgrHTTPClientRestAPIv2</literal> |
| 807 | removed starting with the next major release. It is recommended to use | 807 | object is deprecated and will be removed starting with the next major |
| 808 | the <literal>ManagementClient</literal> class instead.</para> | 808 | release. It is recommended to use the |
| 809 | <literal>ManagementClient</literal> class instead.</para> | ||
| 809 | </note> | 810 | </note> |
| 810 | 811 | ||
| 811 | <para><emphasis role="bold">Examples</emphasis>:</para> | 812 | <para><emphasis role="bold">Examples</emphasis>:</para> |
| @@ -882,9 +883,9 @@ Options: | |||
| 882 | 883 | ||
| 883 | <itemizedlist> | 884 | <itemizedlist> |
| 884 | <listitem> | 885 | <listitem> |
| 885 | <para>Run the Python API using only the values of the parameters | 886 | <para>Run the Python API using only the values of the parameters |
| 886 | without specifying the parameters' names. All parameters will | 887 | without specifying the parameters' names. All parameters will be |
| 887 | be given and the value will be the position of each parameter.</para> | 888 | given and the value will be the position of each parameter.</para> |
| 888 | </listitem> | 889 | </listitem> |
| 889 | 890 | ||
| 890 | <listitem> | 891 | <listitem> |
| @@ -1155,7 +1156,7 @@ uploadImage <imagePath> <type></programlisting> | |||
| 1155 | <para><emphasis role="bold">Example:</emphasis></para> | 1156 | <para><emphasis role="bold">Example:</emphasis></para> |
| 1156 | 1157 | ||
| 1157 | <programlisting>python automation_framework/DeviceUpgradeHandler.py -m uploadImage | 1158 | <programlisting>python automation_framework/DeviceUpgradeHandler.py -m uploadImage |
| 1158 | /tmp/enea-nfv-access-xeon-d.tar.gz xeon-d</programlisting> | 1159 | /tmp/enea-edge-runtime-xeon-d.tar.gz xeon-d</programlisting> |
| 1159 | 1160 | ||
| 1160 | <para>All the other methods run in a similar way.</para> | 1161 | <para>All the other methods run in a similar way.</para> |
| 1161 | </section> | 1162 | </section> |
