From 07bcd42e5e0115a93858e94dbc897ab07fa938e9 Mon Sep 17 00:00:00 2001 From: Daniel Date: Fri, 20 Dec 2019 12:22:15 +0100 Subject: Minor updates for EvalKit book. Change-Id: Id46a2f3467d6e09d8272ac1f93310e178f95f6d9 --- .../doc/appendix_1.xml | 28 +- .../doc/eltf_params_template.xml | 151 ---------- .../doc/eltf_params_updated.xml | 105 +------ .../eltf_params_updated_template_how_to_use.txt | 320 --------------------- .../doc/images/br_to_br_conn_overview.png | Bin .../doc/images/br_to_br_conn_setup.png | Bin .../doc/introduction.xml | 16 +- .../doc/run_example_uc_auto_fm.xml | 23 +- .../doc/sdwan_arch.xml | 105 +++---- .../doc/setup_cleanup.xml | 4 +- .../doc/validating_setup.xml | 13 +- 11 files changed, 100 insertions(+), 665 deletions(-) delete mode 100644 doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_template.xml delete mode 100755 doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt mode change 100755 => 100644 doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_overview.png mode change 100755 => 100644 doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_setup.png diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml index f89372a..0895bcb 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml @@ -3,7 +3,7 @@ How to create a flexiwan cloud-init iso image (day-0 configuration) - Prerequisites: + Prerequisites: @@ -15,21 +15,21 @@ - Contact the flexiWAN VNF provider to get access to their controller and a valid token. + + Contact the flexiWAN VNF provider to get access to their controller + and a valid token. + - Unpack the flexiwan/flexiwan-cloud-init-example.tar.gz and check - the README file for more details: - - tar -zxf flexiwant-cloud-init-example.tar.gz + Unpack the + flexiwan/flexiwan-cloud-init-example.tar.gz and check + the README file for more details: tar -zxf flexiwant-cloud-init-example.tar.gz cd flexiwan/cloud-init-example/ To generate the cloud-init iso image: - - - > create_flexiwan_cloudinit.sh <token> - > create_flexiwan_cloudinit.sh - > $cat token.txt - - - The flexiWAN_cloudinit.iso file can be used to instantiate the flexiWAN VNF on NFV Access. + + > create_flexiwan_cloudinit.sh <token> +> create_flexiwan_cloudinit.sh $cat token.txt + + The flexiWAN_cloudinit.iso file can be used to + instantiate the flexiWAN VNF on NFV Access. \ No newline at end of file diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_template.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_template.xml deleted file mode 100644 index eaa7ebd..0000000 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_template.xml +++ /dev/null @@ -1,151 +0,0 @@ - - -
- File with Parameters in the Book Auto-updated by ELFT - - - See the eltf_params_updated_template_howto_use.txt text - file for description of how to create the final eltf_params_updated.xml from this template and for - all REQUIREMENTS. Use the command - "make eltf" to extract a full list of all - ELTF variables, which always begins with ELTF_ and don't only rely on the - howto text file list! The plan is that ELTF will auto-update this when - needed. - - -
- Common Parameters - - A programlisting, ID - "eltf-prereq-apt-get-commands-host" - - ELTF_PL_HOST_PREREQ - - A programlisting, ID - "eltf-getting-repo-install-command" - - ELTF_PL_GET_REPO - - Several phrase elements, various IDs. Ensure EL_REL_VER is - correct also compared to the "previous" REL VER in pardoc-distro.xml - "prev_baseline". - - ELTF_EL_REL_VER - - ELTF_YOCTO_VER - - ELTF_YOCTO_NAME - - ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL - - ELTF_EL_DOWNLOAD_TXTURL - - A programlisting, ID "eltf-repo-cloning-enea-linux". Use - $MACHINE/default.xml as parameter, where MACHINE is one of the target - directory names in the manifest. - - ELTF_PL_CLONE_W_REPO - - A table with ONE row, only the row with ID - "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the - template.xml and in the updated.xml, set condition hidden on the - <row>, if eclipse is not in the release. - - - - - - Eclipse version ELTF_ECLIPSE_VERSION plus command line - development tools are included in this Enea NFV Access release. - - - - - - Below is one big section with title "Supported Targets with - Parameters". The entire section is included completely in the book via ID - "eltf-target-tables-section" and shall be LAST in the template. The - template contains ONE target subsection. COPY/APPEND it, if multiple - targets exist in the release and optionally add rows with additional - target parameters in each target subsection table. -
- -
- Supported Targets with Parameters - - The tables below describes the target(s) supported in this Enea - NFV Access release. - -
- MACHINE ELTF_T_MANIFEST_DIR - Information - - - - - - - - - - Target official name - - ELTF_T_NAME - - - - Architecture and Description - - ELTF_T_ARC_DESC - - - - Link to target datasheet - - See ELTF_T_DS_TXTURL - - - - Poky version - - ELTF_T_POKY_VER - - - - GCC version - - ELTF_T_GCC_VER - - - - Linux Kernel Version - - ELTF_T_KERN_VER - - - - Supported Drivers - - ELTF_T_DRIVERS - - - - Enea rpm folder for downloading RPM packages for this - target - - ELTF_T_EL_RPM_TXTURL - - - - -
- - -
-
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated.xml index bb969c6..1a640a3 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated.xml @@ -44,12 +44,12 @@ export PATH=~/bin:$PATH 2.2.1 - 2.1 + 2.4 - krogoth + rocko http://www.yoctoproject.org/downloads/core/krogoth/21 + url="http://www.yoctoproject.org/downloads">http://www.yoctoproject.org/downloads https://linux.enea.com/6 @@ -80,7 +80,7 @@ repo sync - Below is one big section with title "Supported Targets with + Below is one big section with title "Supported Processor with Parameters". The entire section is included completely in the book via ID "eltf-target-tables-section" and shall be LAST in the template. The template contains ONE target subsection. COPY/APPEND it, if multiple @@ -89,13 +89,13 @@ repo sync
- Supported Reference Boards with Parameters + Supported Reference Processor with Parameters - The table(s) below describes the target(s) supported in this Enea + The table(s) below describes the processors supported in this Enea NFV Access release. - MACHINE Information Intel Xeon D + Processor Information Intel Xeon D-1500 @@ -110,9 +110,9 @@ repo sync - Target official name + Processor official name - Intel Xeon D + Intel Xeon D-1500 @@ -122,20 +122,13 @@ repo sync - Link to target datasheet + Link to processor datasheet Intel's datasheet - - Poky version - - Git-commit-id: - 7e7ee662f5dea4d090293045f7498093322802cc - - GCC version @@ -158,7 +151,7 @@ repo sync
- MACHINE Information Intel Atom C3000 + Processor Information Intel Atom C3000 @@ -173,7 +166,7 @@ repo sync - Target official name + Processor official name Intel Atom C3000 @@ -185,20 +178,13 @@ repo sync - Link to target datasheet + Link to the processor datasheet Intel's datasheet - - Poky version - - Git-commit-id: - 7e7ee662f5dea4d090293045f7498093322802cc - - GCC version @@ -219,68 +205,5 @@ repo sync
- - - MACHINE Information - - - - - - - Component - - Description - - - - - - Target official name - - OCTEON TX™ cn8304 - - - - Architecture and Description - - arm64 - - - - Link to target datasheet - - OCTEON - TX™ cn8304 datasheet - - - - Poky version - - Git-commit-id: - f01b909a266498853e6b3f10e6b39f2d95148129 - - - - GCC version - - 5.3FIXME - - - - Linux Kernel Version - - 3.12FIXME - - - - Supported Drivers - - Ethernet, RTC, UART - - - -
- \ No newline at end of file + diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt deleted file mode 100755 index 62e5d02..0000000 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt +++ /dev/null @@ -1,320 +0,0 @@ -eltf_params_template_updated_howto_use.txt - -This is a way to collect all parameters for an Enea NFV Access release -in one parameter file, easy to automatically update by ELTF regularly. - -NOTE: Both the release info AND the open source books use parameters from - here, but the XML file is inside the release info book directory. - -NOTE: The manifest_conf.mk, or overridden by the environment variable - MANIFESTHASH, contains the full tag (or hashvalue) for downloading - the manifest when the books are built. The list of target - directories are fetched from the manifest into the book. - The eltf_params_updates.xml can all the time contain - the final next complete tag e.g. refs/tags/EL6 or similar - in the ELTF_PL_CLONE_W_REPO parameter command lines. - -The ordinary book XML files use xi:include statements to include elements -from this parameter file. The book XML files can thus be manually edited. -Before editing, you must run "make init". -Any other text in the template or updated.xml file, outside the parts that -are included in the book, are not used but still all must be correct -DocBook XML files. - -ELTF work: - template => ELTF replaces ALL ELTF_xxx variables => updated XML file - => push to git only if changed - - -eltf_params_template.xml (in git) - File used by ELTF to autocreate/update the real parameter - file eltf_params_updated.xml. - -eltf_params_updated.xml (in git) - Real parameter file where ELTF has replaced all ELTF_xx variables with - strings, in several cases with multiline strings. - No spaces or linefeed allowed in beginning or end of the variable values! - - -xi:include: Each parameter is xi:include'ed in various book files, using - the IDs existing in the parameter files. - In most cases the 1:st element inside an element with an ID is included - using a format like eltf-prereq-apt-get-commands-host/1. - In very few cases the element with the ID is included in the book, one - example is the target section which has an ID, but which contains - multiple subsections, one per target. - All IDs in a book must be unique. - -DocBook XML: All XML files must be correct DocBook XML files. - -Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes - not done by ELTF. But it is OK to open the real file in XMLmind to - check that the format is correct. - -ELTF should autocreate a temporary "real" file but only replace - and push the eltf_params_updated.xml if it is changed. - - -make eltf - This lists all ELTF_xxx variables and some rules how to treat them - -DocBook Format: All elements - rules: - Several strict generic XML rules apply for all strings: - 1. No TABs allowed or any other control chr than "linefeed" - 2. Only 7-bit ASCII - 3. Any < > & must be converted to < > and & - Similar for any other non-7-bit-ASCII but avoid those! - 4. No leading spaces or linefeeds when replacing the ELTF_* variable - 5. No trailing spaces or linefeeds when replacing the ELTF_* variable - 6. Note: Keep existing spaces before/efter ELTF_* in a few cases. - -DocBook Format: - rules: ELTF*PL* variables - Several strict rules apply for the multiline string in programlisting - in addition to the general XML rules above: - 7. Max line length < 80 char - 8. Use backslash (\) to break longer lines - 9. Use spaces (e.g. 4) to indent continuation lines in programlistings - 10. No trailing spaces on any line - 11. No spaces or linefeed immediately after leading - 12. No spaces or linefeed before trailing - -DocBook Format: - rules: ELTF_*URL* variables - 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings - 14. Only if the URL is extremely long, the TXTURL can be a separate string - -Each target has one section with target parameters: -
- MACHINE ELTF_T_MANIFEST_DIR - Information - ..... with many ELTF_ variables .... -
- - 15. If there is only one target. ELTF just replaces ELTF parameters - - 16. It there are multiple targets. ELTF copies the section and appends the - section the required number of times. - Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR - Each section title will become unique - -Tables with target parameters in each target section: - 17. It is possible for ELTF to append more rows with one parameter each - to these tables, because the entire tables are included in the book - -Special - NOT YET READY DEFINED how to handle the optionally included - Eclipse and its version, but this is a first suggestion: - 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string - with both version number and name, - 19. MANUALLY if Eclipse is NOT included in the release, - the release manager should manually set condition="hidden" on - the entire section in the book XML about Eclipse - - - -BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf -if there are more new variables, missing in this description file. - -_____________________________________________________________________________ -ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands - like sudo apt-get install xxxx or similar. - First line = comment with the complete host name! - It is possible to include multiple hosts by just - adding an empty line, comment with host name, etc. - xi:include eltf-prereq-apt-get-commands-host/1 - This is a ... - Example: -# Host Ubuntu 14.04.5 LTS 64bit -sudo apt-get update -sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \ - texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ - make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ - libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ - libxml-parser-perl - -_____________________________________________________________________________ -ELTF_PL_GET_REPO Multiline commands to download the repo tool - xi:include eltf-getting-repo-install-command/1 - This is a ... - Example: -mkdir -p ~/bin -curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo -chmod a+x ~/bin/repo -export PATH=~/bin:$PATH - -_____________________________________________________________________________ -ELTF_EL_REL_VER General parameter string: The version of this Enea - NFV Access release. Major version and optional .Minor - Typically created from MAJOR and MINOR in enea.conf - MINOR in enea.conf is empty or contains a dot+minor - xi_include EneaLinux_REL_VER/1 - This is a X.x used in many places. - Examples: -6 - or -6.1 - -_____________________________________________________________________________ -ELTF_YOCTO_VER General parameter string: Yocto version, created - from DISTRO in poky.ent - xi:include Yocto_VER/1 - This is a X.x used in many places. - Example: -2.1 - -_____________________________________________________________________________ -ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created - from DISTRO_NAME_NO_CAP in poky.ent - xi:include Yocto_NAME/1 - This is a X.x used in many places. - Example: -krogoth - -_____________________________________________________________________________ -ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL -ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string - at the end, typically without "dot". - xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1 - This is an ... - Example: -http://www.yoctoproject.org/downloads/core/krogoth/21 - -_____________________________________________________________________________ -ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings -ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where - Enea NFV Access can be downloaded - Often containing same version as in ELTF_EL_REL_VER - xi:include ULINK_ENEA_LINUX_URL/1 - This is an ... - Example: -http://linux.enea.com/6 - -_____________________________________________________________________________ -ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything. - Use the variable $MACHINE/default.xml (the text in - the book will list the avaiable values of MACHINE, - taken from the manifest repository) - xi:include eltf-repo-cloning-enea-linux/1 - This is a ... - Example: -mkdir enea-linux -cd enea-linux -repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ - -b refs/tags/EL6 -m $MACHINE/default.xml -repo sync - -_____________________________________________________________________________ -ELTF_ECLIPSE_VERSION Optional general parameter string. - NOT YET READY DEFINED - Just now a release manage must manually set - condition="hidden" on the Eclipse section, - if Eclipse is not included in the release. - ELTF just replaces ELTF_ECLIPSE_VERSION with a full - string with "X.Y (name)" - It includes the ID and can only be ONCE in the book. - xi:include eltf-eclipse-version-row - Example. -4.5 (Mars) - - -_____________________________________________________________________________ -ELTF_T_* All these are in each target (MACHINE) and ELTF - must separately replace them with strings for - each target - NOTE: All (except the MANIFEST_DIR) are in rows - in a table and ELTF can select to append - more parameters by adding more rows - -_____________________________________________________________________________ -ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly -ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same - as the MACHINE names in $MACHINE/default.xml. - In book: a) Part of section ID - b) Part of section title - Examples: -p2041rgb - or -ls1021aiot - or -qemuarm - -_____________________________________________________________________________ -ELTF_T_NAME Target specific: "Target Official Name" - NOT same as the target directory name in most cases. - In book: An element in a row - Examples: -P2041RGB - or -LS1021a-IoT - or -qemuarm - -_____________________________________________________________________________ -ELTF_T_ARC_DESC Target specific: "Architecture and Description" - It can be a short identification string or - it can be a longer descriptive sentence. - In book: An element in a row - Examples: -Power, e500mc - or -ARM Cortex-A7 - -_____________________________________________________________________________ -ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These -ELTF_T_DS_URL two usually are IDENTICAL strings with correct - hyperlink to the target's official datasheet. - In book: an ... - Only if the link is VERY LONG, the text part shall - instead be a descriptive string (see 2:nd example). - NOTE: Also here no spaces or line-feeds! - Examples: -url="http://wiki.qemu.org">http://wiki.qemu.org -or -url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet - -_____________________________________________________________________________ -ELTF_T_POKY_VER Target specific: "Poky version" created either - from POKYVERSION in poky.ent - or using a hashvalue with a leading string, in - which case it may be different per target. - In book: An in a row - Examples: -15.0.0 -or -Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 - -_____________________________________________________________________________ -ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky - but not easy to find among various parameters. - ELTF would extract it from build logs building SDK - and it is possibly different per target. - In book: An in a row - Example: -5.3 - -_____________________________________________________________________________ -ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often - different per target. - In book: An in a row - Example: -3.12 - -_____________________________________________________________________________ -ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a - comma-separated list of driver names. - ELTF should create the list in same order for each - target, e.g. alphabetic migth be OK. - In book: An in a row - Example: -Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC - - -_____________________________________________________________________________ -ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading -ELTF_T_EL_RPM_URL RPM packages for this target". These two are - INDENTICAL strings with hyperlink to the web site - at Enea where the customer can download RPMs - Note: Often the ELFT_EL_REL_VER value and - the ELTF_T_MANIFEST_DIR are used in the link. - In book: an ... - Example: -url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm - -_____________________________________________________________________________ diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_overview.png b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_overview.png old mode 100755 new mode 100644 diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_setup.png b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_setup.png old mode 100755 new mode 100644 diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml index 4702cb0..7b92bcf 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml @@ -34,10 +34,10 @@ flexiWAN and pfSense VNFs service chained together on a uCPE device. This document will present all information required to replicate the - use cases described therein in the user's environment. The first part of - this manual uses the GUI mode of the uCPE Manager to detail the steps in - order to reproduce the use cases, while the chapters thereafter use the - automation framework. + use case described in the user's environment. The first part of this manual + uses the GUI mode of the uCPE Manager to detail the steps in order to + reproduce the use cases, while the chapters thereafter use the automation + framework. All VNF configurations should be seen as example configurations @@ -45,7 +45,7 @@ configuration data needed according to his network setup. Particularities are described in Appendix A. - This is document assumes the user is familiar with ENFV Access and + This document assumes the user is familiar with Enea NFV Access and has read the Enea NFV Access Getting Started manual before continuing with the following. @@ -56,11 +56,9 @@
uCPE Manager - The Enea uCPE Manager is an EMS/NMS platform that provides the VNF + The Enea uCPE Manager is an EMS/NMS platform providing VNF Management capabilities for NFV Access devices. The uCPE Manager can be - deployed on a Linux (CentOS) based physical or virtual server. - Co-resident with the uCPE Manager is additional functionality, which - includes the Automation Framework. + deployed on a Linux (CentOS) based physical or virtual server.
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml index 02a29df..725e4e0 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml @@ -6,32 +6,33 @@ offline configurations need to be added for both uCPE devices and for the VNFs to be onboarded. + + All tests are just examples. In order to run on user specific + devices they need to be updated accordingly. Please check the Enea NFV + Access System Test Specification manual for more details. + + > python unittestSuite.py -u admin -p admin -H 172.24.3.109 \ --o ucpem -s test_EvalKit_addOfflineConfig_and_onBoardVNFs.json -d \ +-o ucpem -s EvalKit_addOfflineConfig_and_onBoardVNFs.json -d \ "Set - offline config for uCPE1 and uCPE2" #add device1 > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n fwa_1012vc-1 \ --s test_EvalKit_Deploy1.json -d "Add taget1 and instantiate VNFs" +-s EvalKit_Deploy1.json -d "Add taget1 and instantiate VNFs" #add device2 > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n intelc3850-1 \ --s test_EvalKit_Deploy2.json -d "Add taget2 and instantiate VNFs" +-s EvalKit_Deploy2.json -d "Add taget2 and instantiate VNFs" Once done, the device configurations need to be cleaned up: > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n fwa_1012vc-1 \ --s test_EvalKit_Cleanup1.json -d "Cleanup config on taget1" +-s EvalKit_Cleanup1.json -d "Cleanup config on taget1" > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n intelc3850-1 \ --s test_EvalKit_Cleanup2.json -d "Cleanup config on taget2" +-s EvalKit_Cleanup2.json -d "Cleanup config on taget2" > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -o ucpem -s \ -test_EvalKit_CleanupZTP_and_offboardVNFs.json -d \ +EvalKit_CleanupZTP_and_offboardVNFs.json -d \ "Cleanup offline configuration and OffBoard VNFs" - - - Replace the <uCPE_Manager_IP> with the IP address of uCPE - Manager machine. - \ No newline at end of file diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml index c5da1bc..4fcb6df 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml @@ -1,6 +1,6 @@ - SD-WAN architecture + SD-WAN Branch to Branch Connection Software-Defined Wide Area Networking (SD-WAN), provides the benefits of software-defined networking (SDN) technology to traditionally @@ -11,20 +11,16 @@ abstracts software from hardware, enabling network virtualization and making the network more elastic. - The setup detailed in this chapter looks to cover all the steps - required to create a connection between two branch offices. On each site a - uCPE device is installed and connected to a WAN network. NFV Access should - already be installed on each uCPE device, and with it the flexiWAN and - pfSense VNFs will be instantiated on each site. + The setup detailed in this chapter covers all the steps required to + create a connection between two branch offices. On each site a uCPE device + is installed and connected to a WAN network. NFV Access should be installed + on each uCPE device, and flexiWAN and pfSense VNFs will be instantiated on + each site. The flexiWAN VNF will create the tunnel between the two branches while the pfSense VNF (connected in the service chain), will cover the communication with LAN on each branch. The setup will be configured from the - uCPE Manager GUI, accessible from any web browser if connected to the IP - address of uCPE Manager machine. - - The default login credentials for both username and password are - admin/admin. + uCPE Manager GUI.
Branch to Branch Connection Overview @@ -83,7 +79,8 @@ Install NFV Access on the uCPE devices. See the make this into an olink Enea NFV Access Getting Started manual, - chapter Installing Enea NFV Access, for more details. + chapter Getting Started with the Enea NFV Access, for more + details. @@ -94,7 +91,7 @@ The uCPE Manager host machine must be connected to the network - so all uCPE devices can access the internet. + so all uCPE devices can access it. @@ -108,18 +105,17 @@
The uCPE Manager - Log into the uCPE manager with the username and password - "admin". + Log into the uCPE Manager using the default credentials, + username:admin and password: admin. - In this setup Zero Touch Provisioning (ZTP) will be used to - preconfigure the infrastructure in the uCPE Manager for each device. The - interface and bridge configurations are pushed onto each uCPE device when + Zero Touch Provisioning (ZTP) will be used to preconfigure the + infrastructure in the uCPE Manager for each device. The interface and + bridge configurations are pushed onto each uCPE device when connected. Onboarding is the process of registering VNFs into the uCPE Manager - after devices are configured for the VNF(s) they will host and added into - the Manager. The flexiWAN and pfSense VNFs are used along with example - configuration data. + after devices are configured. The flexiWAN and pfSense VNFs are used along + with example configuration data.
Onboarding the FlexiWAN VNF @@ -369,7 +365,7 @@ Name - Device1 + device1 @@ -407,8 +403,9 @@ - Prepare the infrastructure configuration for device1 in the - data store: Applications -> Offline + Prepare the infrastructure configuration for + device1 in the data store: + Applications -> Offline Config -> <select "device1" data store> -> Config App.... This window layout is very similar to the Configuration window of a device. @@ -422,10 +419,9 @@ Configure the host - interface(s): select the device -> - Configuration -> - OpenVSwitch -> Host - Interfaces -> Add. + interface(s): OpenVSwitch -> + Host Interfaces -> + Add. Use the following values to fill the required fields: @@ -459,8 +455,7 @@ - Configure the bridges: select - the device -> Configuration -> + Configure the bridges: OpenVSwitch -> Bridges -> Add. @@ -594,7 +589,7 @@ Name - Device2 + device2 @@ -632,8 +627,9 @@ - Prepare the infrastructure configuration for device2 in the - data store: Applications -> Offline + Prepare the infrastructure configuration for + device2 in the data store: + Applications -> Offline Config -> <select "device2" data store> -> Config App.... This window layout is very similar to the Configuration window of a device. @@ -647,10 +643,9 @@ Configure the host - interface(s): select the device -> - Configuration -> - OpenVSwitch -> Host - Interfaces -> Add. + interface(s): OpenVSwitch -> + Host Interfaces -> + Add. Use the following values to fill the required fields: @@ -684,8 +679,7 @@ - Configure the bridges: select - the device -> Configuration -> + Configure the bridges: OpenVSwitch -> Bridges -> Add. @@ -798,10 +792,9 @@
Uploading the offline Configuration - In this context and example setup, which uses ZTP, the offline - configuration can be uploaded and applied on a uCPE device only once. If - the setup needs to be rerun on a device where ZTP was already used, - please do the following: + The offline configuration can be uploaded and applied on a uCPE + device only once. If the setup needs to be rerun on a device where ZTP + was already used, please do the following: @@ -1045,12 +1038,11 @@ flexiWAN_cloudinit.iso. - Example image provided. Please see the Appendix for details on - how to change the configuration and create a new cloud-init iso - image. + Example cloud-init image provided. Please see the Appendix for + details on how to generate a new cloud-init image with a different + token. Please contact flexiWAN in order to get a valid token and + access to the flexiWAN manager. - - Click Domain Update Script. @@ -1074,8 +1066,8 @@ ID: lan. - Type: dpdk - tap. + Type: + tap. IF Name: Bridge: sfc_br. @@ -1120,8 +1112,6 @@ Cloud Init File: pfsense_192_168_1_1.iso. - - Click Domain Update Script. @@ -1208,12 +1198,11 @@ flexiWAN_cloudinit.iso. - Example image provided. Please see the Appendix for details on - how to change the configuration and create a new cloud-init iso - image. + Example cloud-init image provided. Please see the Appendix for + details on how to generate a new cloud-init image with a different + token. Please contact flexiWAN in order to get a valid token and + access to the flexiWAN manager. - - Click Domain Update Script. @@ -1283,8 +1272,6 @@ Cloud Init File: pfsense_192_168_2_1.iso. - - Click Domain Update Script. diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml index 78bf5ed..6a129e8 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml @@ -2,8 +2,8 @@ Setup Clean-up - In order to remove the setup created in the previous chapter all - components need to be deleted in reverse order: + In order to remove the setup all components need to be deleted in + reverse order: diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml index 85ea1f4..02d71d2 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml @@ -13,11 +13,7 @@ Connect to: https://<publicIP>:60002 with - the username: admin and the password: pfsense. - - Please make sure the WAN interface of each device has access - to the internet. - + the username: admin and the password: pfsense. @@ -30,9 +26,10 @@ - Check for a dynamic IP. The pfSense LAN interface is configured with a DHCP server and should provide an IP 192.168.1/2.XXX: - - > dhclient eth1 + Check for a dynamic IP. The pfSense LAN interface is configured + with a DHCP server and should receive an IP from the corresponding + subnet (uCPE device1 has 192.168.1.XXX, while uCPE device2 has + 192.168.2.XXX).> dhclient eth1 > ping 192.168.2.1 -- cgit v1.2.3-54-g00ecf