diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml | 154 |
1 files 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</programlisting> | |||
| 491 | fortigateCleanup.json -d "Fortigate cleanup scenario"</programlisting> | 491 | fortigateCleanup.json -d "Fortigate cleanup scenario"</programlisting> |
| 492 | 492 | ||
| 493 | <para>Setting the console logging level to INFO:</para> | 493 | <para>Setting the console logging level to INFO:</para> |
| 494 | 494 | ||
| 495 | <programlisting>consoleLoggingLevel = logging.INFO</programlisting> | 495 | <programlisting>consoleLoggingLevel = logging.INFO</programlisting> |
| 496 | 496 | ||
| 497 | <para><emphasis role="bold">Expected Output:</emphasis></para> | 497 | <para><emphasis role="bold">Expected Output:</emphasis></para> |
| 498 | 498 | ||
| @@ -2407,13 +2407,13 @@ phase always-after-startup from inteld1521-6 | |||
| 2407 | </section> | 2407 | </section> |
| 2408 | </section> | 2408 | </section> |
| 2409 | 2409 | ||
| 2410 | <section id="offline_config_store"> | 2410 | <section id="add_offline_config_store"> |
| 2411 | <title>Setting up an Offline Configuration Store</title> | 2411 | <title>Adding an Offline Configuration Store</title> |
| 2412 | 2412 | ||
| 2413 | <para>Steps and options on how to add and remove a Config Store in the | 2413 | <para>Steps and options on how to add a Config Store in the Enea uCPE |
| 2414 | Enea uCPE Manager are described below.</para> | 2414 | Manager are described below.</para> |
| 2415 | 2415 | ||
| 2416 | <section id="script_opts_config_store"> | 2416 | <section id="script_opts_add_config_store"> |
| 2417 | <title>Script Options</title> | 2417 | <title>Script Options</title> |
| 2418 | 2418 | ||
| 2419 | <para>To add a config store in the Enea uCPE Manager use the | 2419 | <para>To add a config store in the Enea uCPE Manager use the |
| @@ -2421,41 +2421,48 @@ phase always-after-startup from inteld1521-6 | |||
| 2421 | mind a <filename>CONFIGSTORE</filename> json file is needed to | 2421 | mind a <filename>CONFIGSTORE</filename> json file is needed to |
| 2422 | successfully run the script in order to add an offline configuration | 2422 | successfully run the script in order to add an offline configuration |
| 2423 | store.</para> | 2423 | store.</para> |
| 2424 | </section> | ||
| 2425 | |||
| 2426 | <section id="json_add_config_store"> | ||
| 2427 | <title>Configuring the JSON file</title> | ||
| 2424 | 2428 | ||
| 2425 | <para>Example of a <filename>CONFIGSTORE</filename> json file:</para> | 2429 | <para>Example of a <filename>CONFIGSTORE</filename> json file:</para> |
| 2426 | 2430 | ||
| 2427 | <programlisting>{ | 2431 | <programlisting>{ |
| 2428 | "descr": "intelc3850-2", | 2432 | "descr": "intelc3850-2", |
| 2429 | "version": "2.2.2", | 2433 | "version": "2.2.2", |
| 2430 | "deviceGroupingTags": "", | 2434 | "deviceGroupingTags": "", |
| 2431 | "deviceId": "intelc3850-2", | 2435 | "deviceId": "intelc3850-2", |
| 2432 | "name": "intelc3850-2" | 2436 | "name": "intelc3850-2" |
| 2433 | }</programlisting> | 2437 | }</programlisting> |
| 2438 | </section> | ||
| 2439 | |||
| 2440 | <section id="runpy_add_config_store"> | ||
| 2441 | <title>Running the Python Module</title> | ||
| 2434 | 2442 | ||
| 2435 | <para>Adding an offline config store in the Enea uCPE Manager using | 2443 | <para>Adding an offline config store in the Enea uCPE Manager using |
| 2436 | the command line:</para> | 2444 | the command line:</para> |
| 2437 | 2445 | ||
| 2438 | <programlisting>$ python addConfigStore.py -h | 2446 | <programlisting>python automation_framework/device/addConfigStore.py -f \ |
| 2439 | Usage: addConfigStore.py [options] | 2447 | lab_config/inteld1521-16/store.json |
| 2448 | 2020-10-16 09:35:51,084 - INFO: Add offline config store | ||
| 2449 | 2020-10-16 09:35:51,160 - INFO: Done</programlisting> | ||
| 2450 | </section> | ||
| 2451 | </section> | ||
| 2440 | 2452 | ||
| 2441 | Add a config store in Enea uCPE Manager. | 2453 | <section id="upload_offline_config_store"> |
| 2454 | <title>Uploading an Offline Configuration Store to an uCPE | ||
| 2455 | Device</title> | ||
| 2442 | 2456 | ||
| 2443 | Options: | 2457 | <para>Steps and options on how to upload a config store to a device are |
| 2444 | --version show program's version number and exit | 2458 | described below.</para> |
| 2445 | -h, --help show this help message and exit | ||
| 2446 | -u USERNAME, --username=USERNAME | ||
| 2447 | Enea uCPE Manager login username | ||
| 2448 | -p PASSWORD, --password=PASSWORD | ||
| 2449 | Enea uCPE Manager login password | ||
| 2450 | -H HOST, --host=HOST Enea uCPE Manager host name or IP address | ||
| 2451 | -f CONFIGSTOREFILE, --file=CONFIGSTOREFILE | ||
| 2452 | File containing Store Information in JSON format | ||
| 2453 | 2459 | ||
| 2454 | Mandatory options: | 2460 | <section id="script_opts_upload_config_store"> |
| 2455 | -H/--host, -f/--file</programlisting> | 2461 | <title>Script options</title> |
| 2456 | 2462 | ||
| 2457 | <para>Uploading an offline configuration store to a uCPE Device | 2463 | <para>To upload a config store to a uCPE Device use the |
| 2458 | using the command line:</para> | 2464 | <filename>uploadConfigStore.py</filename> script detailed |
| 2465 | below.</para> | ||
| 2459 | 2466 | ||
| 2460 | <programlisting>python uploadConfigStore.py -h | 2467 | <programlisting>python uploadConfigStore.py -h |
| 2461 | Usage: uploadConfigStore.py [options] | 2468 | Usage: uploadConfigStore.py [options] |
| @@ -2477,9 +2484,31 @@ Options: | |||
| 2477 | 2484 | ||
| 2478 | Mandatory options: | 2485 | Mandatory options: |
| 2479 | -H/--host, -s/--store, -d/--device</programlisting> | 2486 | -H/--host, -s/--store, -d/--device</programlisting> |
| 2487 | </section> | ||
| 2488 | |||
| 2489 | <section id="runpy_upload_config_store"> | ||
| 2490 | <title>Running the Python Modules</title> | ||
| 2491 | |||
| 2492 | <programlisting>python automation_framework/device/uploadConfigStore.py -s inteld1521-16 \ | ||
| 2493 | -d inteld1521-16 | ||
| 2494 | 2020-10-16 09:37:29,074 - INFO: Upload offline configuration to uCPE Device | ||
| 2495 | 2020-10-16 09:37:49,321 - INFO: The 'inteld1521-16' config store was successfully \ | ||
| 2496 | uploaded on device! | ||
| 2497 | 2020-10-16 09:37:49,322 - INFO: Done</programlisting> | ||
| 2498 | </section> | ||
| 2499 | </section> | ||
| 2500 | |||
| 2501 | <section id="check_upload_offline_config_store"> | ||
| 2502 | <title>Checking the Upload of an Offline Configuration Store</title> | ||
| 2503 | |||
| 2504 | <para>Steps and options on how to check an upload of a Config Store to a | ||
| 2505 | Device are described below.</para> | ||
| 2480 | 2506 | ||
| 2481 | <para>Checking the upload of an offline configuration store to a uCPE | 2507 | <section id="script_opts_check_upload_config_store"> |
| 2482 | Device using the command line:</para> | 2508 | <title>Script options</title> |
| 2509 | |||
| 2510 | <para>To check an upload a config store to a uCPE Device use the | ||
| 2511 | <filename>getUploadStatus.py</filename> script detailed below.</para> | ||
| 2483 | 2512 | ||
| 2484 | <programlisting>python getUploadStatus.py -h | 2513 | <programlisting>python getUploadStatus.py -h |
| 2485 | Usage: getUploadStatus.py [options] | 2514 | Usage: getUploadStatus.py [options] |
| @@ -2499,9 +2528,44 @@ Options: | |||
| 2499 | 2528 | ||
| 2500 | Mandatory options: | 2529 | Mandatory options: |
| 2501 | -H/--host, -d/--device</programlisting> | 2530 | -H/--host, -d/--device</programlisting> |
| 2531 | </section> | ||
| 2532 | |||
| 2533 | <section id="runpy_check_upload_config_store"> | ||
| 2534 | <title>Running the Python Modules</title> | ||
| 2535 | |||
| 2536 | <programlisting>python automation_framework/device/getUploadStatus.py -d inteld1521-16 | ||
| 2537 | 2020-10-16 09:38:33,388 - INFO: Get upload offline configure status on uCPE Device | ||
| 2538 | 2020-10-16 09:38:33,486 - INFO: Successful: True | ||
| 2539 | 2020-10-16 09:38:33,487 - INFO: Store name: inteld1521-16 | ||
| 2540 | 2020-10-16 09:38:33,488 - INFO: In progress: False | ||
| 2541 | 2020-10-16 09:38:33,489 - INFO: A config store was successfully uploaded on device! | ||
| 2542 | 2020-10-16 09:38:33,490 - INFO: Done</programlisting> | ||
| 2543 | </section> | ||
| 2544 | </section> | ||
| 2545 | |||
| 2546 | <section id="remove_offline_config_store"> | ||
| 2547 | <title>Removing an Offline Configuration Store in the Enea uCPE | ||
| 2548 | Manager</title> | ||
| 2549 | |||
| 2550 | <para>Steps and options on how to remove an upload of a Config Store | ||
| 2551 | from the uCPE Manager are described below.</para> | ||
| 2552 | |||
| 2553 | <note> | ||
| 2554 | <para>Modifications of an Offline Configurations Store are not | ||
| 2555 | possible post deployment in the uCPE Manager, as there is no option | ||
| 2556 | for changing script states (e.g. changing the DPDK state in the | ||
| 2557 | <filename>configDPDK.py</filename> python script or unbinding | ||
| 2558 | interfaces). The offline store must be deleted and the new | ||
| 2559 | state(s)/changes added in, before being deployed anew. This was not | ||
| 2560 | deemed necessary for the current ZTP functionality.</para> | ||
| 2561 | </note> | ||
| 2562 | |||
| 2563 | <section id="script_opts_remove_config_store"> | ||
| 2564 | <title>Script options</title> | ||
| 2502 | 2565 | ||
| 2503 | <para>Removing a config store in the Enea uCPE Manager using the | 2566 | <para>To remove a config store from the uCPE Manager use the |
| 2504 | command line:</para> | 2567 | <filename>removeConfigStore.py</filename> script detailed |
| 2568 | below.</para> | ||
| 2505 | 2569 | ||
| 2506 | <programlisting>python removeConfigStore.py -h | 2570 | <programlisting>python removeConfigStore.py -h |
| 2507 | Usage: removeConfigStore.py [options] | 2571 | Usage: removeConfigStore.py [options] |
| @@ -2521,20 +2585,14 @@ Options: | |||
| 2521 | 2585 | ||
| 2522 | Mandatory options: | 2586 | Mandatory options: |
| 2523 | -H/--host, -o/--store-name</programlisting> | 2587 | -H/--host, -o/--store-name</programlisting> |
| 2588 | </section> | ||
| 2524 | 2589 | ||
| 2525 | <para>Modifications of an Offline Configurations Store are not | 2590 | <section id="runpy_remove_config_store"> |
| 2526 | possible post deployment in the uCPE Manager, as there is no option | 2591 | <title>Running the Python Modules</title> |
| 2527 | for changing script states (e.g. changing the DPDK state in the | ||
| 2528 | <filename>configDPDK.py</filename> python script or unbinding | ||
| 2529 | interfaces). The offline store must be deleted and the new | ||
| 2530 | state(s)/changes added in, before being deployed anew. This was not | ||
| 2531 | deemed necessary for the current ZTP functionality.</para> | ||
| 2532 | 2592 | ||
| 2533 | <para>An action on a device is applied immediately, while a | 2593 | <programlisting>python automation_framework/device/removeConfigStore.py -o inteld1521-16 |
| 2534 | configuration in an offline configuration store is something prepared | 2594 | 2020-10-16 09:39:39,127 - INFO: Remove offline config store |
| 2535 | for the future (when the device is added to the uCPE Manager and the | 2595 | 2020-10-16 09:39:39,289 - INFO: Done</programlisting> |
| 2536 | configuration is sent to it). The configuration is ideally created | ||
| 2537 | with the needed modifications from the start.</para> | ||
| 2538 | </section> | 2596 | </section> |
| 2539 | </section> | 2597 | </section> |
| 2540 | </section> | 2598 | </section> |
| @@ -2573,8 +2631,8 @@ Options: | |||
| 2573 | needed by Automation Framework python modules and installing | 2631 | needed by Automation Framework python modules and installing |
| 2574 | Ansible.</para> | 2632 | Ansible.</para> |
| 2575 | 2633 | ||
| 2576 | <para>The Ansible package version installed in the test environment is 2.9.6. | 2634 | <para>The Ansible package version installed in the test environment is |
| 2577 | The playbooks are based on this version of Ansible.</para> | 2635 | 2.9.6. The playbooks are based on this version of Ansible.</para> |
| 2578 | 2636 | ||
| 2579 | <para>The <literal>/playbooks</literal> directory contains all the | 2637 | <para>The <literal>/playbooks</literal> directory contains all the |
| 2580 | implemented Ansible Playbooks. For more details please refer to the <olink | 2638 | implemented Ansible Playbooks. For more details please refer to the <olink |
| @@ -2613,4 +2671,4 @@ Options: | |||
| 2613 | <filename>ansible.log</filename> and <filename>debug.log</filename> files, | 2671 | <filename>ansible.log</filename> and <filename>debug.log</filename> files, |
| 2614 | respectively.</para> | 2672 | respectively.</para> |
| 2615 | </section> | 2673 | </section> |
| 2616 | </chapter> | 2674 | </chapter> \ No newline at end of file |
