From ebd12cb7cd17fd038f18cbf48a8b7234f62f2448 Mon Sep 17 00:00:00 2001 From: mrpa Date: Thu, 22 Oct 2020 13:31:47 +0200 Subject: Separated the Offline Config content into 4 sections. Change-Id: Ifdb0c53d07679a38273a4697790aea1469759f0a Signed-off-by: mrpa --- .../doc/automation_framework_test_harness.xml | 154 ++++++++++++++------- 1 file changed, 106 insertions(+), 48 deletions(-) diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml index 2cf02b6..d2c686a 100644 --- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml @@ -491,8 +491,8 @@ OK fortigateCleanup.json -d "Fortigate cleanup scenario" Setting the console logging level to INFO: - - consoleLoggingLevel = logging.INFO + + consoleLoggingLevel = logging.INFO Expected Output: @@ -2407,13 +2407,13 @@ phase always-after-startup from inteld1521-6 -
- Setting up an Offline Configuration Store +
+ Adding an Offline Configuration Store - Steps and options on how to add and remove a Config Store in the - Enea uCPE Manager are described below. + Steps and options on how to add a Config Store in the Enea uCPE + Manager are described below. -
+
Script Options To add a config store in the Enea uCPE Manager use the @@ -2421,41 +2421,48 @@ phase always-after-startup from inteld1521-6 mind a CONFIGSTORE json file is needed to successfully run the script in order to add an offline configuration store. +
+ +
+ Configuring the JSON file Example of a CONFIGSTORE json file: { - "descr": "intelc3850-2", - "version": "2.2.2", - "deviceGroupingTags": "", - "deviceId": "intelc3850-2", - "name": "intelc3850-2" +"descr": "intelc3850-2", +"version": "2.2.2", +"deviceGroupingTags": "", +"deviceId": "intelc3850-2", +"name": "intelc3850-2" } +
+ +
+ Running the Python Module Adding an offline config store in the Enea uCPE Manager using the command line: - $ python addConfigStore.py -h -Usage: addConfigStore.py [options] + python automation_framework/device/addConfigStore.py -f \ +lab_config/inteld1521-16/store.json +2020-10-16 09:35:51,084 - INFO: Add offline config store +2020-10-16 09:35:51,160 - INFO: Done +
+
-Add a config store in Enea uCPE Manager. +
+ Uploading an Offline Configuration Store to an uCPE + Device -Options: - --version show program's version number and exit - -h, --help show this help message and exit - -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 CONFIGSTOREFILE, --file=CONFIGSTOREFILE - File containing Store Information in JSON format + Steps and options on how to upload a config store to a device are + described below. - Mandatory options: - -H/--host, -f/--file +
+ Script options - Uploading an offline configuration store to a uCPE Device - using the command line: + To upload a config store to a uCPE Device use the + uploadConfigStore.py script detailed + below. python uploadConfigStore.py -h Usage: uploadConfigStore.py [options] @@ -2477,9 +2484,31 @@ Options: Mandatory options: -H/--host, -s/--store, -d/--device +
+ +
+ Running the Python Modules + + python automation_framework/device/uploadConfigStore.py -s inteld1521-16 \ +-d inteld1521-16 +2020-10-16 09:37:29,074 - INFO: Upload offline configuration to uCPE Device +2020-10-16 09:37:49,321 - INFO: The 'inteld1521-16' config store was successfully \ +uploaded on device! +2020-10-16 09:37:49,322 - INFO: Done +
+
+ +
+ Checking the Upload of an Offline Configuration Store + + Steps and options on how to check an upload of a Config Store to a + Device are described below. - Checking the upload of an offline configuration store to a uCPE - Device using the command line: +
+ Script options + + To check an upload a config store to a uCPE Device use the + getUploadStatus.py script detailed below. python getUploadStatus.py -h Usage: getUploadStatus.py [options] @@ -2499,9 +2528,44 @@ Options: Mandatory options: -H/--host, -d/--device +
+ +
+ Running the Python Modules + + python automation_framework/device/getUploadStatus.py -d inteld1521-16 +2020-10-16 09:38:33,388 - INFO: Get upload offline configure status on uCPE Device +2020-10-16 09:38:33,486 - INFO: Successful: True +2020-10-16 09:38:33,487 - INFO: Store name: inteld1521-16 +2020-10-16 09:38:33,488 - INFO: In progress: False +2020-10-16 09:38:33,489 - INFO: A config store was successfully uploaded on device! +2020-10-16 09:38:33,490 - INFO: Done +
+
+ +
+ Removing an Offline Configuration Store in the Enea uCPE + Manager + + Steps and options on how to remove an upload of a Config Store + from the uCPE Manager are described below. + + + Modifications of an Offline Configurations Store are not + possible post deployment in the uCPE Manager, as there is no option + for changing script states (e.g. changing the DPDK state in the + configDPDK.py python script or unbinding + interfaces). The offline store must be deleted and the new + state(s)/changes added in, before being deployed anew. This was not + deemed necessary for the current ZTP functionality. + + +
+ Script options - Removing a config store in the Enea uCPE Manager using the - command line: + To remove a config store from the uCPE Manager use the + removeConfigStore.py script detailed + below. python removeConfigStore.py -h Usage: removeConfigStore.py [options] @@ -2521,20 +2585,14 @@ Options: Mandatory options: -H/--host, -o/--store-name +
- Modifications of an Offline Configurations Store are not - possible post deployment in the uCPE Manager, as there is no option - for changing script states (e.g. changing the DPDK state in the - configDPDK.py python script or unbinding - interfaces). The offline store must be deleted and the new - state(s)/changes added in, before being deployed anew. This was not - deemed necessary for the current ZTP functionality. +
+ Running the Python Modules - An action on a device is applied immediately, while a - configuration in an offline configuration store is something prepared - for the future (when the device is added to the uCPE Manager and the - configuration is sent to it). The configuration is ideally created - with the needed modifications from the start. + python automation_framework/device/removeConfigStore.py -o inteld1521-16 +2020-10-16 09:39:39,127 - INFO: Remove offline config store +2020-10-16 09:39:39,289 - INFO: Done
@@ -2573,8 +2631,8 @@ Options: needed by Automation Framework python modules and installing Ansible. - The Ansible package version installed in the test environment is 2.9.6. - The playbooks are based on this version of Ansible. + The Ansible package version installed in the test environment is + 2.9.6. The playbooks are based on this version of Ansible. The /playbooks directory contains all the implemented Ansible Playbooks. For more details please refer to the ansible.log and debug.log files, respectively.
- + \ No newline at end of file -- cgit v1.2.3-54-g00ecf