From f4e0e6b56ee6d64526c7fc92f81e431300e36b7f Mon Sep 17 00:00:00 2001 From: Daniel Date: Mon, 22 Mar 2021 19:35:59 +0100 Subject: USERDOCAP-636 AFTH User Guide and OSR updates Change-Id: I5a9ed963da80e8681c5be80ff0d814a3b0feefc4 --- .../doc/about.xml | 2 +- .../doc/licenses.xml | 6 +- .../doc/automation_framework_test_harness.xml | 268 +++++++++++---------- .../doc/components.xml | 10 +- .../doc/getting_started.xml | 18 +- .../doc/overview.xml | 12 +- 6 files changed, 156 insertions(+), 160 deletions(-) diff --git a/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml b/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml index 4dc19aa..24f674d 100644 --- a/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml +++ b/doc/book-enea-edge-auto-fw-th-open-source/doc/about.xml @@ -5,7 +5,7 @@ About this Report This document contains the open source and license information - pertaining to the Automation Framework and Test Harness provided with + pertaining to the Enea Edge Automation Framework and Test Harness provided with Enea Edge - Automation Framework and Test Harness + Enea Edge Automation Framework and Test Harness - Automation Framework and Test Harness + Enea Edge Automation Framework and Test Harness ENEA-SRC-R2 - Copyright (C) 2019 by Enea. + Copyright (C) 2019 by Enea Software AB. All rights reserved. This Software is furnished under a software license agreement and diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml index a569d59..6a47839 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml @@ -32,12 +32,14 @@ Commands within the network folder that include the option -o allow the user to perform the action in an offline configuration store alternative available for use at a - later setup time. Commands that include the -n option refer to a uCPE device, with the - operation being performed on uCPE device. All options contain either - -n, -o - or both. One of them must always be provided, if both are provided, -o - has priority, and -n is thus ignored. + later setup time. + Commands that include the -n + option refer to a uCPE device, with the operation being performed on uCPE device. + All options contain either -n, + -o or both. One of them must always be provided, + if both are provided, -o has priority, and -n is thus ignored. + In the following script examples Enea Edge Management + is reffered as Enea uCPE Manager. The /unittestSuite folder contains JSON files for @@ -88,16 +90,16 @@ $ python unittestSuite.py -h Usage: unittestSuite.py [options] -Run selected unit-test suite against Enea Edge Management. +Run selected unit-test suite against Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -n DEVICENAME, --deviceName=DEVICENAME Name of vCPE device (Virtual Infrastructure Manager) -s SUITEFILE, --suite=SUITEFILE @@ -548,16 +550,16 @@ OK $ python addDevice.py -h Usage: addDevice.py [options] -Add a uCPE device in Enea Edge Management. +Add a uCPE device in Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format @@ -615,7 +617,7 @@ Options: 2019-03-07 17:33:10,756 - INFO: Add uCPE device 2019-03-07 17:33:10,975 - DEBUG: Login successful on host 'localhost' 2019-03-07 17:33:10,979 - DEBUG: Session token is: 508b6ea2-40ee-11e9-a81f525400d08e1d -2019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to Enea Edge Management host +2019-03-07 17:33:11,049 - DEBUG: Add new device 'intelc3850-2' to uCPE Manager host 2019-03-07 17:33:11,483 - INFO: Done 2019-03-07 17:33:11,501 - DEBUG: Logging out and exiting.... @@ -633,16 +635,16 @@ Options: $ python removeDevice.py -h Usage: removeDevice.py [options] -Remove a uCPE from Enea Edge Management. +Remove a uCPE from Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format @@ -689,7 +691,7 @@ Options: 2019-03-07 17:33:56,835 - INFO: Remove uCPE device 2019-03-07 17:33:56,856 - DEBUG: Login successful on host 'localhost' 2019-03-07 17:33:56,856 - DEBUG: Session token is: 6bebcb43-40ee-11e9-a81f525400d08e1d -2019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from Enea Edge Management +2019-03-07 17:33:56,856 - DEBUG: Delete device 'intelc3850-2' from uCPE Manager host 2019-03-07 17:33:56,875 - DEBUG: Found device with name 'intelc3850-2' 2019-03-07 17:33:57,159 - INFO: Done @@ -709,16 +711,16 @@ host $ python waitDeviceUp.py -h Usage: waitDeviceUp.py [options] -Wait for uCPE to connect to the Enea Edge Management after installation. +Wait for uCPE to connect to the Enea uCPE Manager after installation. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format -t TIMEOUT, --timeout=TIMEOUT @@ -787,14 +789,14 @@ Options: $ python getEventsForUcpe.py -h Usage: getEventsForUcpe.py [options] -Print the events log for a specific uCPE installed in Enea Edge Management. +Print the events log for a specific uCPE installed in Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit --u USERNAME, --username=USERNAME Enea Edge Management login username --p PASSWORD, --password=PASSWORD Enea Edge Management login password --H HOST, --host=HOST Enea Edge Management host name or IP address +-u USERNAME, --username=USERNAME Enea uCPE Manager login username +-p PASSWORD, --password=PASSWORD Enea uCPE Manager login password +-H HOST, --host=HOST Enea uCPE Manager host name or IP address -f DEVICEFILE, --file=DEVICEFILE File containing uCPE Information in JSON format -s SEVERITY, --severity=SEVERITY Event severity level (Critical|Major|Minor) @@ -869,10 +871,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -s STATE, --state=STATE Enable/Disable -n DEVICENAME, --device-name=DEVICENAME @@ -936,10 +938,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f NICFILE, --file=NICFILE File containing network interface Information in JSON format @@ -1042,10 +1044,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f NICFILE, --file=NICFILE File containing network interface Information in JSON format @@ -1131,9 +1133,9 @@ Usage: getNetworkInterfaces.py [options] Options: --version show program's version number and exit -h, --help show this help message and exit - -u USERNAME, --username=USERNAME Enea Edge Management login username - -p PASSWORD, --password=PASSWORD Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + -u USERNAME, --username=USERNAME Enea uCPE Manager login username + -p PASSWORD, --password=PASSWORD Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -n DEVICENAME, --device-name=DEVICENAME Name of the uCPE to get network / interfaces from @@ -1215,10 +1217,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f OVSFILE, --file=OVSFILE File containing OVS bridge Information in JSON format -n DEVICENAME, --device-name=DEVICENAME @@ -1306,10 +1308,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f OVSFILE, --file=OVSFILE File containing OVS bridge Information in JSON format -n DEVICENAME, --device-name=DEVICENAME @@ -1389,16 +1391,16 @@ Options: $ python onboardVNFRaw.py -h Usage: onboardVNFRaw.py [options] -Onboard a VNF in Enea Edge Management based upon its raw constituents. +Onboard a VNF in Enea uCPE Manager based upon its raw constituents. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f FTPUSERNAME, --ftpUsername=FTPUSERNAME Username for FTP -w FTPPASSWORD, --ftpPassword=FTPPASSWORD @@ -1506,16 +1508,16 @@ Options: $ python offboardVNF.py -h Usage: offboardVNF.py [options] -Offboard a VNF from Enea Edge Management. +Offboard a VNF from Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -n VNFDNAME, --vnfdName=VNFDNAME Name of VNF descriptor to offboard @@ -1571,16 +1573,16 @@ Options: $ python instantiateVNFI.py -h Usage: instantiateVNFI.py [options] -Instantiate a VNF via Enea Edge Management. +Instantiate a VNF via Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -t VNFTYPE, --vnfType=VNFTYPE VNF Type (Name of VNF descriptor) -n VIMDEVICENAME, --device-name=VIMDEVICENAME @@ -1660,16 +1662,16 @@ License("vnf_config/fortigateImage/fortigateLicense.lic") $ python controlVNFI.py -h Usage: controlVNFI.py [options] -Controls a VNF instance from Enea Edge Management. +Controls a VNF instance from Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME Name of VNF instance -n VIMDEVICENAME, --device-name=VIMDEVICENAME @@ -1744,16 +1746,16 @@ fortigateFWInstance -c stop $ python destroyVNFI.py -h Usage: destroyVNFI.py [options] -Destroys a VNF instance from Enea Edge Management. +Destroys a VNF instance from Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -i VNFINSTANCENAME, --vnfInstanceName=VNFINSTANCENAME Name of VNF instance -n VIMDEVICENAME, --device-name=VIMDEVICENAME @@ -1801,28 +1803,28 @@ fortigateFWInstance
- Uploading a Enea Edge image onto the Enea Edge Management + Uploading an Enea Edge image onto the Enea Edge Management - Steps and options on how to Upload a Enea Edge image onto the + Steps and options on how to Upload an Enea Edge image onto the Enea Edge Management are described below.
Script Options $ python uploadImage.py -h -Upload NFVA image on Enea Edge Management +Upload NFVA image on uCPE Manager Usage: uploadImage.py [options] -Upload NFVA image on Enea Edge Management. +Upload NFVA image on uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f FILENAME, --fileName=FILENAME Path to NFVA image file name -m MODULE, --module=MODULE @@ -1838,7 +1840,7 @@ Options:
Configuring the JSON File - The JSON configuration file needed to upload a Enea Edge image + The JSON configuration file needed to upload an Enea Edge image should contain a list of dictionaries. Each dictionary indicates the test case name and the test case arguments passed to the uploadImage Python module. @@ -1846,7 +1848,7 @@ Options: Sample unit-test JSON file format:[ { - "name": "Upload NFVA image on Enea Edge Management", + "name": "Upload NFVA image on uCPE Manager", "args": "-f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d" } ] @@ -1861,7 +1863,7 @@ Options: $ python uploadImage.py -u admin -p admin -H localhost \ -f /tmp/enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d 2020-02-28 11:38:42,754 - DEBUG: Started logging -2020-02-28 11:38:42,755 - INFO: Upload NFVA image on Enea Edge Management +2020-02-28 11:38:42,755 - INFO: Upload NFVA image on uCPE Manager 2020-02-28 11:38:43,307 - DEBUG: Login successful on host 'localhost' 2020-02-28 11:38:43,308 - DEBUG: Session token is: 7da3f960-5a16-11ea-a3de-5652b3ac1c30 2020-02-28 11:41:29,148 - INFO: Verify image validation flag @@ -1874,29 +1876,29 @@ Options:
- Deleting a Enea Edge image file from the + <title>Deleting an Enea Edge image file from the Enea Edge Management - Steps and options on how to Delete a Enea Edge image from the + Steps and options on how to Delete an Enea Edge image from the Enea Edge Management are described below.
Script Options $ python deleteUpgradeFile.py -h -Delete NFVA image from Enea Edge Management +Delete NFVA image from uCPE Manager Usage: deleteUpgradeFile.py [options] -Delete NFVA image from Enea Edge Management. +Delete NFVA image from uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -i IMAGENAME, --imageName=IMAGENAME NFVA Image name -m MODULE, --module=MODULE @@ -1909,7 +1911,7 @@ Options:
Configuring the JSON File - The JSON configuration file needed to delete a Enea Edge image + The JSON configuration file needed to delete an Enea Edge image should contain a list of dictionaries. Each dictionary indicates the test case name and the test case arguments passed to the deleteUpgradeFile Python module. @@ -1917,7 +1919,7 @@ Options: Sample unit-test JSON file format:[ { - "name": "Delete NFVA image on Enea Edge Management", + "name": "Delete NFVA image on uCPE Manager", "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2" } ] @@ -1932,7 +1934,7 @@ Options: $ python deleteUpgradeFile.py -u admin -p admin -H localhost -i \ enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 2020-02-28 12:06:20,111 - DEBUG: Started logging -2020-02-28 12:06:20,112 - INFO: Delete NFVA image from Enea Edge Management +2020-02-28 12:06:20,112 - INFO: Delete NFVA image from uCPE Manager 2020-02-28 12:06:20,210 - DEBUG: Login successful on host 'localhost' 2020-02-28 12:06:20,211 - DEBUG: Session token is: 594b2d50-5a1a-11ea-a3de-5652b3ac1c30 2020-02-28 12:06:20,255 - INFO: The image \ @@ -1948,10 +1950,10 @@ image was successfully removed
- Installing and activating a Enea Edge image on an uCPE device + <title>Installing and activating an Enea Edge image on an uCPE device from the Enea Edge Management - Steps and options on how to Install and Activate a Enea Edge + Steps and options on how to Install and Activate an Enea Edge image on an uCPE device from the Enea Edge Management are described below. @@ -1959,19 +1961,19 @@ image was successfully removed Script Options $ python installAndActivate.py -h -Install and activate NFVA image from Enea Edge Management +Install and activate NFVA image from uCPE Manager Usage: installAndActivate.py [options] -Install and activate NFVA image from Enea Edge Management. +Install and activate NFVA image from uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -i IMAGENAME, --imageName=IMAGENAME Image name -m MODULE, --module=MODULE @@ -1989,7 +1991,7 @@ Options:
Configuring the JSON File - The JSON configuration file needed to install and activate a Enea Edge + The JSON configuration file needed to install and activate an Enea Edge image on a uCPE device from the Enea Edge Management should contain a list of dictionaries. Each dictionary indicates the test case name and the test case arguments passed to the @@ -2000,7 +2002,7 @@ Options: [ { - "name": "Install and activate NFVA image on uCPE device from Enea Edge Management", + "name": "Install and activate NFVA image on uCPE device from uCPE Manager", "args": "-i enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16" } ] @@ -2015,7 +2017,7 @@ Options: $ python installAndActivate.py -u admin -p admin -H localhost -i \ enea-nfv-access-xeon-d.rootfs.ostree.tar.bz2 -t xeon_d -d inteld1521-16 2020-02-28 12:36:46,137 - DEBUG: Started logging -2020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from Enea Edge Management +2020-02-28 12:36:46,138 - INFO: Install and activate NFVA image from uCPE Manager 2020-02-28 12:36:46,288 - DEBUG: Login successful on host 'localhost' 2020-02-28 12:36:46,288 - DEBUG: Session token is: 99b7cde0-5a1e-11ea-a3de-5652b3ac1c30 2020-02-28 12:36:46,325 - DEBUG: Found device with name 'inteld1521-16' @@ -2074,10 +2076,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address Mandatory options: -H/--host @@ -2122,16 +2124,16 @@ Options: 2020-04-14 10:26:23,582 - INFO: Upload Custom Script Usage: upload.py [options] -Add a Custom Script to Enea Edge Management +Add a Custom Script to Enea uCPE Manager Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -f CUSTOMSCRIPT, --file=CUSTOMSCRIPT Custom Script File -e PHASE, --phase=PHASE @@ -2156,7 +2158,7 @@ Options: [ { - "name": "Uploading a Custom Script to the Enea Edge Management", + "name": "Uploading a Custom Script to the uCPE Manager", "args": "-f ../../lab_config/customScripts/test_success_after_always \ -e always-after-startup" } @@ -2175,7 +2177,7 @@ Options: 2020-04-14 14:08:02,915 - INFO: Upload Custom Script 2020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109' 2020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f -2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to Enea Edge Management. \ +2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \ Content: #!/bin/bash echo test_success_after_always 2020-04-14 14:08:03,138 - INFO: Done @@ -2203,12 +2205,12 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME - Custom Script Name that resides on Enea Edge Management + Custom Script Name that resides on Enea uCPE Manager -e PHASE, --phase=PHASE Execution phase. Must be one of the following: once- before-startup | always-before-startup | once-after- @@ -2236,7 +2238,7 @@ Options: [ { -"name": "Uploading a Custom Script from Enea Edge Management to device", +"name": "Uploading a Custom Script from uCPE Manager to device", "args": "-c test_success_after_always -e always-after-startup -n inteld1521-6" } ] @@ -2272,7 +2274,7 @@ test_success_after_always -e always-after-startup -n inteld1521-6 Script Options $ python customScripts/delete.py -h -2020-04-14 14:36:52,010 - INFO: Delete Custom Script on Enea Edge Management +2020-04-14 14:36:52,010 - INFO: Delete Custom Script on uCPE Manager Usage: delete.py [options] Delete a Custom Script from a Device @@ -2281,10 +2283,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME Custom Script Name that resides on a Device -e PHASE, --phase=PHASE @@ -2310,7 +2312,7 @@ Options: [ { -"name": "Removing a Custom Script from Enea Edge Management", +"name": "Removing a Custom Script from uCPE Manager", "args": "-c test_success_after_always -e always-after-startup" } ] @@ -2325,12 +2327,12 @@ Options: $ python automation_framework/customScripts/delete.py -c \ test_success_after_always -e always-after-startup 2020-04-14 14:39:22,042 - DEBUG: Started logging -2020-04-14 14:39:22,042 - INFO: Delete Custom Script on Enea Edge Management +2020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager 2020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' 2020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f 2020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always' 2020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \ -phase always-after-startup from Enea Edge Management +phase always-after-startup from uCPE Manager 2020-04-14 14:39:22,118 - INFO: Done 2020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...
@@ -2355,10 +2357,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -c CUSTOMSCRIPTNAME, --customScriptName=CUSTOMSCRIPTNAME Custom Script Name that resides on a Device -e PHASE, --phase=PHASE @@ -2477,7 +2479,7 @@ phase always-after-startup from inteld1521-6 2020-04-14 14:08:02,915 - INFO: Upload Custom Script 2020-04-14 14:08:02,994 - DEBUG: Login successful on host '172.24.3.109' 2020-04-14 14:08:02,995 - DEBUG: Session token is: 97544990-7e48-11ea-835c-02423a1c239f -2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to Enea Edge Management. \ +2020-04-14 14:08:02,996 - DEBUG: Upload test_success_after_always to uCPE Manager. \ Content: #!/bin/bash echo test_success_after_always 2020-04-14 14:08:03,138 - INFO: Done @@ -2522,12 +2524,12 @@ phase always-after-startup from inteld1521-6 $ python automation_framework/customScripts/delete.py -c \ test_success_after_always -e always-after-startup 2020-04-14 14:39:22,042 - DEBUG: Started logging -2020-04-14 14:39:22,042 - INFO: Delete Custom Script on Enea Edge Management +2020-04-14 14:39:22,042 - INFO: Delete Custom Script on uCPE Manager 2020-04-14 14:39:22,081 - DEBUG: Login successful on host '172.24.3.109' 2020-04-14 14:39:22,082 - DEBUG: Session token is: f75a83a0-7e4c-11ea-835c-02423a1c239f 2020-04-14 14:39:22,099 - DEBUG: Found custom script: 'test_success_after_always' 2020-04-14 14:39:22,099 - DEBUG: Delete script test_success_after_always, \ -phase always-after-startup from Enea Edge Management +phase always-after-startup from uCPE Manager 2020-04-14 14:39:22,118 - INFO: Done 2020-04-14 14:39:22,135 - DEBUG: Logging out and exiting...
@@ -2599,10 +2601,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -s STORE, --store=STORE Offline config store name -d DEVICE, --device=DEVICE @@ -2645,10 +2647,10 @@ Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -d DEVICE, --device=DEVICE Device Name @@ -2696,16 +2698,16 @@ Options: python removeConfigStore.py -h Usage: removeConfigStore.py [options] -Remove a config store from Enea Edge Management. +Remove a config store from Enea uCPE Manager. Options: --version show program's version number and exit -h, --help show this help message and exit -u USERNAME, --username=USERNAME - Enea Edge Management login username + Enea uCPE Manager login username -p PASSWORD, --password=PASSWORD - Enea Edge Management login password - -H HOST, --host=HOST Enea Edge Management host name or IP address + Enea uCPE Manager login password + -H HOST, --host=HOST Enea uCPE Manager host name or IP address -o STORENAME, --store-name=STORENAME Name of the Offline Config Store diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml index 24a7a29..33c1135 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/components.xml @@ -3,7 +3,7 @@ Components An overview of the Enea Edge Runtime and the Edge Management - in cooperation with the Automation Framework and Test Harness, will + in cooperation with the Enea Edge Automation Framework and Test Harness, will be presented in detail.
@@ -28,7 +28,7 @@ The Enea Edge Management application needs to be installed on a supported platform. Upon installation, the system will be set up to - manage Enea Edge "devices", these are the virtualized CPE devices + manage Enea Edge Runtime "devices", these are the virtualized CPE devices used in testing. For more on Enea Edge Management installation instructions, please @@ -49,7 +49,7 @@ known to the Enea Edge Management as the "VcpeAgent" device module. - Before running any use case with the Automation Framework or the + Before running any use case with the Enea Edge Automation Framework and Test Harness, make sure the uCPE device(s) have been added to the Edge Management. @@ -83,7 +83,7 @@
Automation Framework - Testing can be performed by running the available Python scripts + Testing can be performed by running Automation Framework (AF) Python scripts against the Enea Edge Management REST API (Python samples supplied). This can be done by using the Python scripts individually or by using the Python unit-test suite that is able to automatically run test-cases defined for @@ -100,7 +100,7 @@ The Test Harness (TH) provides a way for driving configuration with Ansible Playbooks, by running the python modules from the Automation - Framework (AF) and by direct connection over SSH to the boards that run + Framework and by direct connection over SSH to the boards that run Enea Edge. The Test Harness includes an automated test suite that diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml index 97666cf..1a6dc0b 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/getting_started.xml @@ -1,12 +1,12 @@ - Getting Started with the Automation Framework and Test + <title>Getting Started with the Enea Edge Automation Framework and Test Harness
Prerequisites - For installation of the Automation Framework and Test Harness a + For installation of the Enea Edge Automation Framework and Test Harness a CentOS 7 host machine is needed with support for: @@ -28,7 +28,7 @@ - The Automation Framework and Test Harness installation may be done + The Enea Edge Automation Framework and Test Harness installation may be done on the same machine used for Enea Edge Management installation, although this is not encouraged. For more details see section Unzip the - Enea_NFV_Access_AF-TH_<version>-build<build_number>.zip + Enea_Edge_AF-TH_<version>-build<build_number>.zip archive file, provided by Enea, on a supported host machine. The directory in which the archive has been unpacked will be @@ -187,9 +187,9 @@ Create the Enea Edge Management JSON config file in the <AF-TH-install-dir>/uCPEM_config/ directory:{ -"ucpe_usr":"Enea Edge Management Username", -"ucpe_pass":"Enea Edge Management Password", -"ucpe_host":"Enea Edge Management IP/Hostname", +"ucpe_usr":"uCPE Manager Username", +"ucpe_pass":"uCPE Manager Password", +"ucpe_host":"uCPE Manager IP/Hostname", "ftp_usr":"FTP Username", "ftp_pass":"FTP Password", "ftp_port":"FTP Port" @@ -221,7 +221,7 @@ <AF-THinstall-dir> directory. Subsequent use of the installation requires activating the Python - virtual enviroment before using the Automation Framework and Test Harness: + virtual enviroment before using the Enea Edge Automation Framework and Test Harness: source <AF-TH-install-dir>/testHarness-venv/bin/activate. @@ -231,7 +231,7 @@ JSON config for the new Enea Edge Management instance. - Automation Framework and Test Harness History Information can be + Enea Edge Automation Framework and Test Harness History Information can be found in the AF&TH CHANGELOG file available in: <AF-TH-install-dir>/CHANGELOG diff --git a/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml b/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml index b2486a0..4fec3d9 100644 --- a/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml +++ b/doc/book-enea-edge-auto-fw-th-user-guide/doc/overview.xml @@ -2,8 +2,7 @@ Overview - This document describes the Automation Framework and Test Harness for - Enea Edge, along with instructions regarding the necessary steps to + This document describes the Enea Edge Automation Framework and Test Harness, along with instructions regarding the necessary steps to run these software tools.
@@ -40,7 +39,7 @@ Enea Edge - The Enea Edge (with ODM) Runtime and the + The Enea Edge Runtime and the Enea Edge Management. @@ -128,12 +127,7 @@ Network Functions Virtualization. - - ODM - - Enea Element On Device Management. - - + OVS -- cgit v1.2.3-54-g00ecf