From db876bb0af8e7bf5f3a7a2ee9cea5d2f57af8678 Mon Sep 17 00:00:00 2001 From: Miruna Paun Date: Fri, 10 May 2019 12:39:56 +0200 Subject: Added AF TH User Guide Outline + ch1&2 proofed. Change-Id: Ie6ae43e02f30dd6bba6532b84d41c8d4a5e0bbf9 --- doc/Makefile | 2 +- .../doc/automation_framework_test_harness.xml | 107 +++++++ .../doc/book.xml | 33 +++ .../doc/components.xml | 34 +++ .../doc/eltf_params_template.xml | 151 ++++++++++ .../doc/eltf_params_updated.xml | 286 ++++++++++++++++++ .../eltf_params_updated_template_how_to_use.txt | 320 +++++++++++++++++++++ .../doc/getting_started.xml | 223 ++++++++++++++ .../doc/getting_started.xml~ | 223 ++++++++++++++ .../doc/images/ChainedVNFsService_setup.png | Bin 0 -> 117103 bytes .../doc/images/autofw_testh_overview.png | Bin 0 -> 87813 bytes .../doc/images/environment_basicsetup.png | Bin 0 -> 103831 bytes .../doc/overview.xml | 196 +++++++++++++ .../doc/troubleshooting_guide.xml | 6 + .../swcomp.mk | 10 + 15 files changed, 1590 insertions(+), 1 deletion(-) create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_template.xml create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml create mode 100755 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated_template_how_to_use.txt create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml create mode 100755 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml~ create mode 100755 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/ChainedVNFsService_setup.png create mode 100755 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/autofw_testh_overview.png create mode 100755 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/environment_basicsetup.png create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml create mode 100644 doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml create mode 100755 doc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk diff --git a/doc/Makefile b/doc/Makefile index fbc898e..2cf6e28 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -50,7 +50,7 @@ DOCBOOK_TO_BOOKDIR ?= yes DOCBOOK_CLEANTMP ?= yes #Components (books) in this subsystem. Now use all books found here -COMPONENTS := book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-open-source book-enea-nfv-access-release-info book-enea-nfv-access-vnf-onboarding-guide book-enea-nfv-access-reference-guide-intel +COMPONENTS := book-enea-nfv-access-example-usecases book-enea-nfv-access-getting-started book-enea-nfv-access-open-source book-enea-nfv-access-release-info book-enea-nfv-access-vnf-onboarding-guide book-enea-nfv-access-reference-guide-intel book-enea-nfv-access-auto-fw-th-user-guide # COMPONENTS += #book-enea-linux-eclipse-open-source #book-enea-nfv-access-dev-hardening-guide 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 new file mode 100644 index 0000000..53940eb --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml @@ -0,0 +1,107 @@ + + + Automation Framework and Test Harness + +
+ Automation Framework + + + +
+ Python Unit-Test Suite + + +
+ +
+ Adding a uCPE Device + + +
+ +
+ Removing a uCPE Device + + +
+ +
+ Waiting a uCPE Device + + +
+ +
+ Bind a uCPE Device + + +
+ +
+ Unbind a uCPE Device + + +
+ +
+ Create an OVS Network Bridge + + +
+ +
+ Delete an OVS Network Bridge + + +
+ +
+ Onboard a VNF Bundle + + +
+ +
+ Onboard a VNF Image + + +
+ +
+ Offboard a VNF + + +
+ +
+ Instantiate a VNF + + +
+ +
+ Control a VNF Instance + + +
+ +
+ Destroy a VNF Instance + + +
+
+ +
+ Test Harness + + + +
+ Extending functionality - Test Suites + + +
+ +
+
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml new file mode 100644 index 0000000..c2b86f4 --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml @@ -0,0 +1,33 @@ + + +]> + + <trademark class="registered">Enea</trademark> NFV Access Automation Framework and Test Harness User Guide + + Release Version + + + + + + + + + + + + + + + + diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml new file mode 100644 index 0000000..0f72709 --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml @@ -0,0 +1,34 @@ + + + Components + +
+ Enea NFV Access Solution + + + +
+ Enea uCPE Manager + + +
+ +
+ Enea NFV Access + + +
+
+ +
+ Automation Framework + + +
+ +
+ Test Harness + + +
+
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_template.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_template.xml new file mode 100644 index 0000000..eaa7ebd --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_template.xml @@ -0,0 +1,151 @@ + + +
+ 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-auto-fw-th-user-guide/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml new file mode 100644 index 0000000..feabc9f --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml @@ -0,0 +1,286 @@ + + +
+ 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" + + # Host Ubuntu 16.04 LTS 64bit +sudo apt-get -y update +sudo apt-get -y 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 + + A programlisting, ID + "eltf-getting-repo-install-command" + + mkdir -p ~/bin +curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo +chmod a+x ~/bin/repo +export PATH=~/bin:$PATH + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + 2.2.1 + + 2.4 + + rocko + + http://www.yoctoproject.org/downloads + + https://linux.enea.com/6 + + 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. + + 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 + + A table with ONE row, only the row with ID + "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set + condition hidden if eclipse is not in the release. Do this both in + template.xml and updated.xml. + + + + + + Eclipse version 4.3 (Mars) 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 Reference Boards with Parameters + + The table(s) below describes the target(s) supported in this Enea + NFV Access release. + + + MACHINE Information Intel Xeon D + + + + + + + Component + + Description + + + + + + Target official name + + Intel Xeon D + + + + Architecture and Description + + x86-64 + + + + Link to target datasheet + + Intel's + datasheet + + + + Poky version + + Git-commit-id: + 7e7ee662f5dea4d090293045f7498093322802cc + + + + GCC version + + 7.3 + + + + Linux Kernel Version + + 4.14 + + + + Supported Drivers + + Ethernet, RTC, UART + + + +
+ + + MACHINE Information Intel Atom C3000 + + + + + + + Component + + Description + + + + + + Target official name + + Intel Atom C3000 + + + + Architecture and Description + + x86-64 + + + + Link to target datasheet + + Intel's + datasheet + + + + Poky version + + Git-commit-id: + 7e7ee662f5dea4d090293045f7498093322802cc + + + + GCC version + + 7.3 + + + + Linux Kernel Version + + 4.14 + + + + Supported Drivers + + Ethernet, RTC, UART + + + +
+ + + 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-auto-fw-th-user-guide/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated_template_how_to_use.txt new file mode 100755 index 0000000..62e5d02 --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated_template_how_to_use.txt @@ -0,0 +1,320 @@ +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-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml new file mode 100644 index 0000000..b7ff8f4 --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml @@ -0,0 +1,223 @@ + + + Getting Started with the Automation Framework and Test + Harness + +
+ Prerequisites + + For installation of the Automation Framework and Test Harness a + CentOS 7 host machine is needed with support for: + + + + Python 2.7 + + + + EPEL Repository installed:sudo yum install epel-release + + + + PIP package manager installed: sudo yum -y install python-pip + + + + Virtualenv tool installed: sudo pip install virtualenv + + + + + The Automation Framework and Test Harness installation may be done + on the same machine used for uCPE Manager installation, although this is + not encouraged. For more details see chapter + 3.2. + +
+ +
+ Environment + +
+ Lab setup overview for Basic Setup + + + + + + +
The following enviroment setup is needed for running all the + tests defined in the Enea NFV Access System Test Specification + document:
+ + Lab Network + + DHCP enabled. + + + + Internet Connectivity. + + + + uCPE Manager host + + + + Running CentOS 7. + + + + Connected to Lab Network. + + + + uCPE Manager installed. + + + For details on how to install the uCPE Manager, see "Getting + Started with Enea uCPE Manager" from the Enea NFV Access Getting + Started manual. + + + + + 1st Intel Whitebox + target device + + Minimum 4 Physical Network Devices. + + + + 4GB RAM and 4 cores (Intel C3000 or Xeon D). + + + + 2 Physical connections to Lab Network. + + + + Enea NFV Access installed. + + + For information on how to install Enea NFV Accessthe + solution or the platform?, refer to "Getting Started with + Enea NFV Access" from the Enea NFV Access Getting Started + manual. + + +
+ Lab setup overview for ChainedVNFsService Setup + + + + + + +
+ + Changes to 1st Intel Whitebox target + device + + + + 16GB RAM and 8 cores (Intel C3000 or Xeon D). + + + + 1 Physical connection back to back with the 2nd Intel Whitebox + target device. + + + + 2nd Intel Whitebox + target device + + Minimum 4 Physical Network Devices. + + + + 16GB RAM and 8 cores (Intel C3000 or Xeon D). + + + + 2 Physical connections to Lab Network. + + + + 1 Physical connection back to back with the + 1st Intel Whitebox target device. + + + + Enea NFV Access installed. + + + For information on how to install Enea NFV Accessthe + solution or the platform?, refer to "Getting Started with + Enea NFV Access" from the Enea NFV Access Getting Started + manual. + + + +
+ +
+ Installation and Initial Setup + + Download nfvaccess22_af-th.zip from the Enea + Portal and unzip it on the a supported host machine. Henceforth, the + directory in which the ZIP archive has been unpacked will be denoted as + <AF-TH-installdir>. + + Enter the <AF-TH-install-dir> directory and + run the setup_env.sh script to do the initial setup + of the Test Harness environment: source + setup_env.sh. + + Setup the uCPE Manager which will be used by the TH: + + + + Create the uCPE Manager JSON config file in the + <AF-TH-install-dir>/uCPEM_config/ + directory:{ +"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" +}See the + <AF-TH-install-dir>/uCPEM_config/ucpem01.json + file as an example. + + + + Run the setupuCPEManager.yml Ansible + Playbook with the JSON config path as parameter: ansible-playbook playbooks/setupuCPEManager.yml -e\ +"@uCPEM_config/<config_name>.json" + + Example ansible-playbook playbooks/setupuCPEManager.yml -e\ +"@uCPEM_config/ucpem01.json" + + + + Note that the steps presented in this sub-chapter are to be executed + only once, for the initial setup of the TH environment. Afterwards, each + session ends by closing the Python virtual environment (source + <AF-THinstall-dir>/testHarness/bin/deactivate) and + subsequent use of the installation requires activating the Python virtual + enviroment before using the Automation Framework and Test Harness + (source + <AF-THinstall-dir>/testHarness/bin/activate). + + Furthermore, if a user wants to use a new uCPE Manager instance for + a new session, the user also has to re-run the + setupuCPEManager.yml playbook with the corresponding + JSON config for the new uCPE Manager instance. +
+
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml~ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml~ new file mode 100755 index 0000000..a52f99b --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml~ @@ -0,0 +1,223 @@ + + + Getting Started with the Automation Framework and Test + Harness + +
+ Prerequisites + + For installation of the Automation Framework and Test Harness a + CentOS 7 host machine is needed with support for: + + + + Python 2.7 + + + + EPEL Repository installed:sudo yum install epel-release + + + + PIP package manager installed: sudo yum -y install python-pip + + + + Virtualenv tool installed: sudo pip install virtualenv + + + + + The Automation Framework and Test Harness installation may be done + on the same machine used for uCPE Manager installation, although this is + not encouraged. For more details see chapter + 3.2. + +
+ +
+ Environment + +
+ Lab setup overview for Basic Setup + + + + + + +
The following enviroment setup is needed for running all the + tests defined in the Enea NFV Access System Test Specification + document:
+ + Lab Network + + DHCP enabled. + + + + Internet Connectivity. + + + + uCPE Manager host + + + + Running CentOS 7. + + + + Connected to Lab Network. + + + + uCPE Manager installed. + + + For details on how to install the uCPE Manager, see "Getting + Started with Enea uCPE Manager" from the Enea NFV Access Getting + Started manual. + + + + + 1st Intel Whitebox + target device + + Minimum 4 Physical Network Devices. + + + + 4GB RAM and 4 cores (Intel C3000 or Xeon D). + + + + 2 Physical connections to Lab Network. + + + + Enea NFV Access installed. + + + For information on how to install Enea NFV Accessthe + solution or the platform?, refer to "Getting Started with + Enea NFV Access" from the Enea NFV Access Getting Started + manual. + + +
+ Lab setup overview for ChainedVNFsService Setup + + + + + + +
+ + Changes to 1st Intel Whitebox target + device + + + + 16GB RAM and 8 cores (Intel C3000 or Xeon D). + + + + 1 Physical connection back to back with the 2nd Intel Whitebox + target device. + + + + 2nd Intel Whitebox + target device + + Minimum 4 Physical Network Devices. + + + + 16GB RAM and 8 cores (Intel C3000 or Xeon D). + + + + 2 Physical connections to Lab Network. + + + + 1 Physical connection back to back with the + 1st Intel Whitebox target device. + + + + Enea NFV Access installed. + + + For information on how to install Enea NFV Accessthe + solution or the platform?, refer to "Getting Started with + Enea NFV Access" from the Enea NFV Access Getting Started + manual. + + + +
+ +
+ Installation and Initial Setup + + Download nfvaccess22_af-th.zip from the Enea + Portal and unzip it on the a supported host machine. Henceforth, the + directory in which the ZIP archive has been unpacked will be denoted as + <AF-TH-installdir>. + + Enter the <AF-TH-install-dir> directory and + run the setup_env.sh script to do the initial setup + of the Test Harness environment: source + setup_env.sh. + + Setup the uCPE Manager which will be used by the TH: + + + + Create the uCPE Manager JSON config file in the + <AF-TH-install-dir>/uCPEM_config/ + directory:{ +"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" +}See the + <AF-TH-install-dir>/uCPEM_config/ucpem01.json + file as an example. + + + + Run the setupuCPEManager.yml Ansible + Playbook with the JSON config path as parameter: ansible-playbook playbooks/setupuCPEManager.yml –e\ +"@uCPEM_config/<config_name>.json" + + Example ansible-playbook playbooks/setupuCPEManager.yml –e\ +"@uCPEM_config/ucpem01.json" + + + + Note that the steps presented in this sub-chapter are to be executed + only once, for the initial setup of the TH environment. Afterwards, each + session ends by closing the Python virtual environment (source + <AF-THinstall-dir>/testHarness/bin/deactivate) and + subsequent use of the installation requires activating the Python virtual + enviroment before using the Automation Framework and Test Harness + (source + <AF-THinstall-dir>/testHarness/bin/activate). + + Furthermore, if a user wants to use a new uCPE Manager instance for + a new session, the user also has to re-run the + setupuCPEManager.yml playbook with the corresponding + JSON config for the new uCPE Manager instance. +
+
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/ChainedVNFsService_setup.png b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/ChainedVNFsService_setup.png new file mode 100755 index 0000000..fad8009 Binary files /dev/null and b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/ChainedVNFsService_setup.png differ diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/autofw_testh_overview.png b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/autofw_testh_overview.png new file mode 100755 index 0000000..7599ead Binary files /dev/null and b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/autofw_testh_overview.png differ diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/environment_basicsetup.png b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/environment_basicsetup.png new file mode 100755 index 0000000..0b92f7a Binary files /dev/null and b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/environment_basicsetup.png differ diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml new file mode 100644 index 0000000..9b9eaaa --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml @@ -0,0 +1,196 @@ + + + Overview + + This document describes the Automation Framework and Test Harness for + the Enea NFV Access Solution, a long with providing instructions regarding + the necessary steps to run these software tools. + +
+ Description + + The Automation Framework provides a way for driving configuration + with Python scripting. It complements the Enea uCPE Manager GUI and uses + the northbound REST APIs, given for full availability of the Enea uCPE + Manager features. + + The Test Harness is based on running Ansible Playbooks to complete + different test cases, which make use of the Automation Framework Python + modules and/or direct commands on the boards running Enea NFV + Access. +
+ +
+ Definitions and Acronyms + + + Definitions + + + + + + + Component + + Description + + + + + + Enea NFV Access Solution + + Enea NFV Access (with ODM) Runtime Platform and Enea uCPE + Manager. + + + + Enea Portal + + https://portal.enea.com + + + +
+ + + Acronyms + + + + + + + Component + + Description + + + + + + AF + + Automation Framework for Enea NFV Access. + + + + API + + Application Programming Interface. + + + + DHCP + + Dynamic Host Configuration Protocol. + + + + DPDK + + Data Plane Development Kit. + + + + FTP + + File Transfer Protocol. + + + + GUI + + Graphical User Interface. + + + + IP + + Internet Protocol. + + + + JSON + + JavaScript Object Notation. + + + + NIC + + Network Interface Card. + + + + NETCONF + + Network Configuration Protocol. + + + + NFV + + Network Functions Virtualization. + + + + ODM + + Enea Element On Device Management. + + + + OVS + + Open vSwitch. + + + + REST + + Representational State Transfer. + + + + SR-IOV + + Single Root Input/Output Virtualization. + + + + SSH + + Secure Shell. + + + + TH + + Test Harness for Enea NFV Access. + + + + uCPE Manager + + Enea Universal Customer Premises Equipment Manager. + + + + VCPE + + Virtual Customer Premises Equipment + + + + VNF + + Virtualized Network Function + + + +
+
+
\ No newline at end of file diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml new file mode 100644 index 0000000..f9d4381 --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml @@ -0,0 +1,6 @@ + + + Troubleshooting Guide + + + \ No newline at end of file diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk b/doc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk new file mode 100755 index 0000000..9f0a075 --- /dev/null +++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk @@ -0,0 +1,10 @@ +# Component build specification + +# Version of THIS book +BOOK_VER ?= $(REL_VER)-dev + +DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) + +BOOKPACKAGES := book-enea-nfv-access-auto-fw-th-user-guide +BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Automation Framework and Test Harness User Guide" +BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) -- cgit v1.2.3-54-g00ecf