summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2019-05-10 12:39:56 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2019-05-10 12:54:03 +0200
commitdb876bb0af8e7bf5f3a7a2ee9cea5d2f57af8678 (patch)
tree0d70b550db50183987c3cef5d01b3791f59e86c8
parentdf2c610bfad4cb36453b1f689dc561e43f95cce8 (diff)
downloadnfv-access-documentation-db876bb0af8e7bf5f3a7a2ee9cea5d2f57af8678.tar.gz
Added AF TH User Guide Outline + ch1&2 proofed.
Change-Id: Ie6ae43e02f30dd6bba6532b84d41c8d4a5e0bbf9
-rw-r--r--doc/Makefile2
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml107
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/book.xml33
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml34
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_template.xml151
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated.xml286
-rwxr-xr-xdoc/book-enea-nfv-access-auto-fw-th-user-guide/doc/eltf_params_updated_template_how_to_use.txt320
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml223
-rwxr-xr-xdoc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml~223
-rwxr-xr-xdoc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/ChainedVNFsService_setup.pngbin0 -> 117103 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/autofw_testh_overview.pngbin0 -> 87813 bytes
-rwxr-xr-xdoc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/environment_basicsetup.pngbin0 -> 103831 bytes
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/overview.xml196
-rw-r--r--doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/troubleshooting_guide.xml6
-rwxr-xr-xdoc/book-enea-nfv-access-auto-fw-th-user-guide/swcomp.mk10
15 files changed, 1590 insertions, 1 deletions
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
50DOCBOOK_CLEANTMP ?= yes 50DOCBOOK_CLEANTMP ?= yes
51 51
52#Components (books) in this subsystem. Now use all books found here 52#Components (books) in this subsystem. Now use all books found here
53COMPONENTS := 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 53COMPONENTS := 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
54# COMPONENTS += 54# COMPONENTS +=
55#book-enea-linux-eclipse-open-source 55#book-enea-linux-eclipse-open-source
56#book-enea-nfv-access-dev-hardening-guide 56#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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="auto_fw_test_harness">
3 <title>Automation Framework and Test Harness</title>
4
5 <section id="auto_fw">
6 <title>Automation Framework</title>
7
8 <para></para>
9
10 <section id="python_testsuite">
11 <title>Python Unit-Test Suite</title>
12
13 <para></para>
14 </section>
15
16 <section id="add_ucpe_device">
17 <title>Adding a uCPE Device</title>
18
19 <para></para>
20 </section>
21
22 <section id="remove_ucpe_device">
23 <title>Removing a uCPE Device</title>
24
25 <para></para>
26 </section>
27
28 <section id="wait_ucpe_device">
29 <title>Waiting a uCPE Device</title>
30
31 <para></para>
32 </section>
33
34 <section id="bind_ucpe_device">
35 <title>Bind a uCPE Device</title>
36
37 <para></para>
38 </section>
39
40 <section id="unbind_ucpe_device">
41 <title>Unbind a uCPE Device</title>
42
43 <para></para>
44 </section>
45
46 <section id="create_ovs_net_bridge">
47 <title>Create an OVS Network Bridge</title>
48
49 <para></para>
50 </section>
51
52 <section id="delete_ovs_net_bridge">
53 <title>Delete an OVS Network Bridge</title>
54
55 <para></para>
56 </section>
57
58 <section id="onboard_vnf_bundle">
59 <title>Onboard a VNF Bundle</title>
60
61 <para></para>
62 </section>
63
64 <section id="onboard_vnf_image">
65 <title>Onboard a VNF Image</title>
66
67 <para></para>
68 </section>
69
70 <section id="offboard_vnf">
71 <title>Offboard a VNF</title>
72
73 <para></para>
74 </section>
75
76 <section id="instantiate_vnf">
77 <title>Instantiate a VNF</title>
78
79 <para></para>
80 </section>
81
82 <section id="control_vnf_inst">
83 <title>Control a VNF Instance</title>
84
85 <para></para>
86 </section>
87
88 <section id="destroy_vnf_inst">
89 <title>Destroy a VNF Instance</title>
90
91 <para></para>
92 </section>
93 </section>
94
95 <section id="test_harness">
96 <title>Test Harness</title>
97
98 <para></para>
99
100 <section id="test_suites">
101 <title>Extending functionality - Test Suites</title>
102
103 <para></para>
104 </section>
105
106 </section>
107</chapter> \ 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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED">
5]>
6<book id="book_enea_nfv_access_auto_fw_th_user_guide">
7 <title><trademark class="registered">Enea</trademark> NFV Access Automation Framework and Test Harness User Guide</title>
8
9 <subtitle>Release Version <xi:include href="eltf_params_updated.xml"
10 xmlns:xi="http://www.w3.org/2001/XInclude"
11 xpointer="element(EneaLinux_REL_VER/1)" /></subtitle>
12
13 <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb -->
14
15 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml"
16 xmlns:xi="http://www.w3.org/2001/XInclude" />
17
18 <xi:include href="overview.xml"
19 xmlns:xi="http://www.w3.org/2001/XInclude" />
20
21 <xi:include href="getting_started.xml"
22 xmlns:xi="http://www.w3.org/2001/XInclude" />
23
24 <xi:include href="components.xml"
25 xmlns:xi="http://www.w3.org/2001/XInclude" />
26
27 <xi:include href="automation_framework_test_harness.xml"
28 xmlns:xi="http://www.w3.org/2001/XInclude" />
29
30 <xi:include href="troubleshooting_guide.xml"
31 xmlns:xi="http://www.w3.org/2001/XInclude" />
32
33</book>
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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="components">
3 <title>Components</title>
4
5 <section id="enfva_solution">
6 <title>Enea NFV Access Solution</title>
7
8 <para></para>
9
10 <section id="eucpe_manager">
11 <title>Enea uCPE Manager</title>
12
13 <para></para>
14 </section>
15
16 <section id="ena_plat">
17 <title>Enea NFV Access</title>
18
19 <para></para>
20 </section>
21 </section>
22
23 <section id="automation">
24 <title>Automation Framework</title>
25
26 <para></para>
27 </section>
28
29 <section id="harness">
30 <title>Test Harness</title>
31
32 <para></para>
33 </section>
34</chapter> \ 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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="eltf_created_params">
5 <title>File with Parameters in the Book Auto-updated by ELFT</title>
6
7 <note>
8 <para>See the <emphasis
9 role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text
10 file for description of how to create the final <emphasis
11 role="bold">eltf_params_updated.xml</emphasis> from this template and for
12 all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command
13 "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all
14 ELTF variables, which always begins with ELTF_ and don't only rely on the
15 howto text file list! The plan is that ELTF will auto-update this when
16 needed.</para>
17 </note>
18
19 <section id="host_prereq">
20 <title>Common Parameters</title>
21
22 <bridgehead>A programlisting, ID
23 "eltf-prereq-apt-get-commands-host"</bridgehead>
24
25 <para id="eltf-prereq-apt-get-commands-host"><programlisting>ELTF_PL_HOST_PREREQ</programlisting></para>
26
27 <bridgehead>A programlisting, ID
28 "eltf-getting-repo-install-command"</bridgehead>
29
30 <para id="eltf-getting-repo-install-command"><programlisting>ELTF_PL_GET_REPO</programlisting></para>
31
32 <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is
33 correct also compared to the "previous" REL VER in pardoc-distro.xml
34 "prev_baseline".</bridgehead>
35
36 <para id="EneaLinux_REL_VER"><phrase>ELTF_EL_REL_VER</phrase></para>
37
38 <para id="Yocto_VER"><phrase>ELTF_YOCTO_VER</phrase></para>
39
40 <para id="Yocto_NAME"><phrase>ELTF_YOCTO_NAME</phrase></para>
41
42 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
43 url="ELTF_YOCTO_PROJ_DOWNLOAD_URL">ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL</ulink></para>
44
45 <para id="ULINK_ENEA_LINUX_URL"><ulink
46 url="ELTF_EL_DOWNLOAD_URL">ELTF_EL_DOWNLOAD_TXTURL</ulink></para>
47
48 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
49 $MACHINE/default.xml as parameter, where MACHINE is one of the target
50 directory names in the manifest.</bridgehead>
51
52 <para id="eltf-repo-cloning-enea-linux"><programlisting>ELTF_PL_CLONE_W_REPO</programlisting></para>
53
54 <bridgehead>A table with ONE row, only the row with ID
55 "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the
56 template.xml and in the updated.xml, set condition hidden on the
57 &lt;row&gt;, if eclipse is not in the release.</bridgehead>
58
59 <informaltable>
60 <tgroup cols="1">
61 <tbody>
62 <row id="eltf-eclipse-version-row">
63 <entry>Eclipse version ELTF_ECLIPSE_VERSION plus command line
64 development tools are included in this Enea NFV Access release.</entry>
65 </row>
66 </tbody>
67 </tgroup>
68 </informaltable>
69
70 <bridgehead>Below is one big section with title "Supported Targets with
71 Parameters". The entire section is included completely in the book via ID
72 "eltf-target-tables-section" and shall be LAST in the template. The
73 template contains ONE target subsection. COPY/APPEND it, if multiple
74 targets exist in the release and optionally add rows with additional
75 target parameters in each target subsection table.</bridgehead>
76 </section>
77
78 <section id="eltf-target-tables-section">
79 <title>Supported Targets with Parameters</title>
80
81 <para>The tables below describes the target(s) supported in this Enea
82 NFV Access release.</para>
83
84 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
85 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
86
87 <para><informaltable>
88 <tgroup cols="2">
89 <colspec colwidth="6*" />
90
91 <colspec colwidth="9*" />
92
93 <tbody>
94 <row>
95 <entry>Target official name</entry>
96
97 <entry>ELTF_T_NAME</entry>
98 </row>
99
100 <row>
101 <entry>Architecture and Description</entry>
102
103 <entry>ELTF_T_ARC_DESC</entry>
104 </row>
105
106 <row>
107 <entry>Link to target datasheet</entry>
108
109 <entry>See <ulink
110 url="ELTF_T_DS_URL">ELTF_T_DS_TXTURL</ulink></entry>
111 </row>
112
113 <row>
114 <entry>Poky version</entry>
115
116 <entry>ELTF_T_POKY_VER</entry>
117 </row>
118
119 <row>
120 <entry>GCC version</entry>
121
122 <entry>ELTF_T_GCC_VER</entry>
123 </row>
124
125 <row>
126 <entry>Linux Kernel Version</entry>
127
128 <entry>ELTF_T_KERN_VER</entry>
129 </row>
130
131 <row>
132 <entry>Supported Drivers</entry>
133
134 <entry>ELTF_T_DRIVERS</entry>
135 </row>
136
137 <row>
138 <entry>Enea rpm folder for downloading RPM packages for this
139 target</entry>
140
141 <entry><ulink
142 url="ELTF_T_EL_RPM_URL">ELTF_T_EL_RPM_TXTURL</ulink></entry>
143 </row>
144 </tbody>
145 </tgroup>
146 </informaltable></para>
147 </section>
148
149 <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED -->
150 </section>
151</section> \ 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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="eltf_created_params">
5 <title>File with Parameters in the Book Auto-updated by ELFT</title>
6
7 <note>
8 <para>See the <emphasis
9 role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text
10 file for description of how to create the final <emphasis
11 role="bold">eltf_params_updated.xml</emphasis> from this template and for
12 all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command
13 "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all
14 ELTF variables, which always begins with ELTF_ and don't only rely on the
15 howto text file list! The plan is that ELTF will auto-update this when
16 needed.</para>
17 </note>
18
19 <section id="host_prereq">
20 <title>Common Parameters</title>
21
22 <bridgehead>A programlisting, ID
23 "eltf-prereq-apt-get-commands-host"</bridgehead>
24
25 <para id="eltf-prereq-apt-get-commands-host"><programlisting># Host Ubuntu 16.04 LTS 64bit
26sudo apt-get -y update
27sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \
28 texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
29 make gcc build-essential xsltproc g++ desktop-file-utils chrpath \
30 libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
31 libxml-parser-perl</programlisting></para>
32
33 <bridgehead>A programlisting, ID
34 "eltf-getting-repo-install-command"</bridgehead>
35
36 <para id="eltf-getting-repo-install-command"><programlisting>mkdir -p ~/bin
37curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo
38chmod a+x ~/bin/repo
39export PATH=~/bin:$PATH</programlisting></para>
40
41 <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is
42 correct also compared to the "previous" REL VER in pardoc-distro.xml
43 "prev_baseline".</bridgehead>
44
45 <para id="EneaLinux_REL_VER"><phrase>2.2.1</phrase></para>
46
47 <para id="Yocto_VER"><phrase>2.4</phrase></para>
48
49 <para id="Yocto_NAME"><phrase>rocko</phrase></para>
50
51 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
52 url="http://www.yoctoproject.org/downloads">http://www.yoctoproject.org/downloads</ulink></para>
53
54 <para id="ULINK_ENEA_LINUX_URL"><ulink
55 url="https://linux.enea.com/6">https://linux.enea.com/6</ulink></para>
56
57 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
58 $MACHINE/default.xml as parameter, where MACHINE is one of the target
59 directory names in the manifest.</bridgehead>
60
61 <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux
62cd enea-linux
63repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \
64 -b refs/tags/EL6 -m $MACHINE/default.xml
65repo sync</programlisting></para>
66
67 <bridgehead>A table with ONE row, only the row with ID
68 "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set
69 condition hidden if eclipse is not in the release. Do this both in
70 template.xml and updated.xml.</bridgehead>
71
72 <informaltable>
73 <tgroup cols="1">
74 <tbody>
75 <row condition="hidden" id="eltf-eclipse-version-row">
76 <entry>Eclipse version 4.3 (Mars) plus command line development
77 tools are included in this Enea NFV Access release.</entry>
78 </row>
79 </tbody>
80 </tgroup>
81 </informaltable>
82
83 <bridgehead>Below is one big section with title "Supported Targets with
84 Parameters". The entire section is included completely in the book via ID
85 "eltf-target-tables-section" and shall be LAST in the template. The
86 template contains ONE target subsection. COPY/APPEND it, if multiple
87 targets exist in the release and optionally add rows with additional
88 target parameters in each target subsection table.</bridgehead>
89 </section>
90
91 <section id="eltf-target-tables-section">
92 <title>Supported Reference Boards with Parameters</title>
93
94 <para>The table(s) below describes the target(s) supported in this Enea
95 NFV Access release.</para>
96
97 <table>
98 <title>MACHINE Information Intel Xeon D</title>
99
100 <tgroup cols="2">
101 <colspec align="center" />
102
103 <thead>
104 <row>
105 <entry align="center">Component</entry>
106
107 <entry align="center">Description</entry>
108 </row>
109 </thead>
110
111 <tbody>
112 <row>
113 <entry align="left">Target official name</entry>
114
115 <entry>Intel Xeon D</entry>
116 </row>
117
118 <row>
119 <entry align="left">Architecture and Description</entry>
120
121 <entry>x86-64</entry>
122 </row>
123
124 <row>
125 <entry align="left">Link to target datasheet</entry>
126
127 <entry><ulink
128 url="https://www.intel.com/content/www/us/en/processors/xeon/xeon-d-1500-datasheet-vol-1.html">Intel's
129 datasheet</ulink></entry>
130 </row>
131
132 <row>
133 <entry align="left">Poky version</entry>
134
135 <entry>Git-commit-id:
136 7e7ee662f5dea4d090293045f7498093322802cc</entry>
137 </row>
138
139 <row>
140 <entry align="left">GCC version</entry>
141
142 <entry>7.3</entry>
143 </row>
144
145 <row>
146 <entry align="left">Linux Kernel Version</entry>
147
148 <entry>4.14</entry>
149 </row>
150
151 <row condition="hidden">
152 <entry align="left">Supported Drivers</entry>
153
154 <entry>Ethernet, RTC, UART</entry>
155 </row>
156 </tbody>
157 </tgroup>
158 </table>
159
160 <table>
161 <title>MACHINE Information Intel Atom C3000</title>
162
163 <tgroup cols="2">
164 <colspec align="center" />
165
166 <thead>
167 <row>
168 <entry align="center">Component</entry>
169
170 <entry align="center">Description</entry>
171 </row>
172 </thead>
173
174 <tbody>
175 <row>
176 <entry align="left">Target official name</entry>
177
178 <entry>Intel Atom C3000</entry>
179 </row>
180
181 <row>
182 <entry align="left">Architecture and Description</entry>
183
184 <entry>x86-64</entry>
185 </row>
186
187 <row>
188 <entry align="left">Link to target datasheet</entry>
189
190 <entry><ulink
191 url="https://www.intel.com/content/www/us/en/products/docs/processors/atom/c-series/c3000-family-datasheet.html">Intel's
192 datasheet</ulink></entry>
193 </row>
194
195 <row>
196 <entry align="left">Poky version</entry>
197
198 <entry>Git-commit-id:
199 7e7ee662f5dea4d090293045f7498093322802cc</entry>
200 </row>
201
202 <row>
203 <entry align="left">GCC version</entry>
204
205 <entry>7.3</entry>
206 </row>
207
208 <row>
209 <entry align="left">Linux Kernel Version</entry>
210
211 <entry>4.14</entry>
212 </row>
213
214 <row condition="hidden">
215 <entry align="left">Supported Drivers</entry>
216
217 <entry>Ethernet, RTC, UART</entry>
218 </row>
219 </tbody>
220 </tgroup>
221 </table>
222
223 <table condition="arm">
224 <title>MACHINE Information</title>
225
226 <tgroup cols="2">
227 <colspec align="center" />
228
229 <thead>
230 <row>
231 <entry align="center">Component</entry>
232
233 <entry align="center">Description</entry>
234 </row>
235 </thead>
236
237 <tbody>
238 <row>
239 <entry align="left">Target official name</entry>
240
241 <entry>OCTEON TXâ„¢ cn8304</entry>
242 </row>
243
244 <row>
245 <entry align="left">Architecture and Description</entry>
246
247 <entry>arm64</entry>
248 </row>
249
250 <row>
251 <entry align="left">Link to target datasheet</entry>
252
253 <entry><ulink
254 url="http://www.cavium.com/OCTEON-TX-CN82XX-83XX.html">OCTEON
255 TXâ„¢ cn8304 datasheet</ulink></entry>
256 </row>
257
258 <row>
259 <entry align="left">Poky version</entry>
260
261 <entry>Git-commit-id:
262 f01b909a266498853e6b3f10e6b39f2d95148129</entry>
263 </row>
264
265 <row>
266 <entry align="left">GCC version</entry>
267
268 <entry>5.3<remark>FIXME</remark></entry>
269 </row>
270
271 <row>
272 <entry align="left">Linux Kernel Version</entry>
273
274 <entry>3.12<remark>FIXME</remark></entry>
275 </row>
276
277 <row condition="hidden">
278 <entry align="left">Supported Drivers</entry>
279
280 <entry>Ethernet, RTC, UART</entry>
281 </row>
282 </tbody>
283 </tgroup>
284 </table>
285 </section>
286</section> \ 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 @@
1eltf_params_template_updated_howto_use.txt
2
3This is a way to collect all parameters for an Enea NFV Access release
4in one parameter file, easy to automatically update by ELTF regularly.
5
6NOTE: Both the release info AND the open source books use parameters from
7 here, but the XML file is inside the release info book directory.
8
9NOTE: The manifest_conf.mk, or overridden by the environment variable
10 MANIFESTHASH, contains the full tag (or hashvalue) for downloading
11 the manifest when the books are built. The list of target
12 directories are fetched from the manifest into the book.
13 The eltf_params_updates.xml can all the time contain
14 the final next complete tag e.g. refs/tags/EL6 or similar
15 in the ELTF_PL_CLONE_W_REPO parameter command lines.
16
17The ordinary book XML files use xi:include statements to include elements
18from this parameter file. The book XML files can thus be manually edited.
19Before editing, you must run "make init".
20Any other text in the template or updated.xml file, outside the parts that
21are included in the book, are not used but still all must be correct
22DocBook XML files.
23
24ELTF work:
25 template => ELTF replaces ALL ELTF_xxx variables => updated XML file
26 => push to git only if changed
27
28
29eltf_params_template.xml (in git)
30 File used by ELTF to autocreate/update the real parameter
31 file eltf_params_updated.xml.
32
33eltf_params_updated.xml (in git)
34 Real parameter file where ELTF has replaced all ELTF_xx variables with
35 strings, in several cases with multiline strings.
36 No spaces or linefeed allowed in beginning or end of the variable values!
37
38
39xi:include: Each parameter is xi:include'ed in various book files, using
40 the IDs existing in the parameter files.
41 In most cases the 1:st element inside an element with an ID is included
42 using a format like eltf-prereq-apt-get-commands-host/1.
43 In very few cases the element with the ID is included in the book, one
44 example is the target section which has an ID, but which contains
45 multiple subsections, one per target.
46 All IDs in a book must be unique.
47
48DocBook XML: All XML files must be correct DocBook XML files.
49
50Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes
51 not done by ELTF. But it is OK to open the real file in XMLmind to
52 check that the format is correct.
53
54ELTF should autocreate a temporary "real" file but only replace
55 and push the eltf_params_updated.xml if it is changed.
56
57
58make eltf
59 This lists all ELTF_xxx variables and some rules how to treat them
60
61DocBook Format: All elements - rules:
62 Several strict generic XML rules apply for all strings:
63 1. No TABs allowed or any other control chr than "linefeed"
64 2. Only 7-bit ASCII
65 3. Any < > & must be converted to &lt; &gt; and &amp;
66 Similar for any other non-7-bit-ASCII but avoid those!
67 4. No leading spaces or linefeeds when replacing the ELTF_* variable
68 5. No trailing spaces or linefeeds when replacing the ELTF_* variable
69 6. Note: Keep existing spaces before/efter ELTF_* in a few cases.
70
71DocBook Format: <programlisting> - rules: ELTF*PL* variables
72 Several strict rules apply for the multiline string in programlisting
73 in addition to the general XML rules above:
74 7. Max line length < 80 char
75 8. Use backslash (\) to break longer lines
76 9. Use spaces (e.g. 4) to indent continuation lines in programlistings
77 10. No trailing spaces on any line
78 11. No spaces or linefeed immediately after leading <programlisting>
79 12. No spaces or linefeed before trailing </programlisting>
80
81DocBook Format: <ulink> - rules: ELTF_*URL* variables
82 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings
83 14. Only if the URL is extremely long, the TXTURL can be a separate string
84
85Each target has one section with target parameters:
86 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
87 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
88 ..... with many ELTF_ variables ....
89 </section>
90
91 15. If there is only one target. ELTF just replaces ELTF parameters
92
93 16. It there are multiple targets. ELTF copies the section and appends the
94 section the required number of times.
95 Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR
96 Each section title will become unique
97
98Tables with target parameters in each target section:
99 17. It is possible for ELTF to append more rows with one parameter each
100 to these tables, because the entire tables are included in the book
101
102Special - NOT YET READY DEFINED how to handle the optionally included
103 Eclipse and its version, but this is a first suggestion:
104 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string
105 with both version number and name,
106 19. MANUALLY if Eclipse is NOT included in the release,
107 the release manager should manually set condition="hidden" on
108 the entire section in the book XML about Eclipse
109
110
111
112BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf
113if there are more new variables, missing in this description file.
114
115_____________________________________________________________________________
116ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands
117 like sudo apt-get install xxxx or similar.
118 First line = comment with the complete host name!
119 It is possible to include multiple hosts by just
120 adding an empty line, comment with host name, etc.
121 xi:include eltf-prereq-apt-get-commands-host/1
122 This is a <programlisting>...</programlisting>
123 Example:
124# Host Ubuntu 14.04.5 LTS 64bit
125sudo apt-get update
126sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \
127 texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
128 make gcc build-essential xsltproc g++ desktop-file-utils chrpath \
129 libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
130 libxml-parser-perl
131
132_____________________________________________________________________________
133ELTF_PL_GET_REPO Multiline commands to download the repo tool
134 xi:include eltf-getting-repo-install-command/1
135 This is a <programlisting>...</programlisting>
136 Example:
137mkdir -p ~/bin
138curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
139chmod a+x ~/bin/repo
140export PATH=~/bin:$PATH
141
142_____________________________________________________________________________
143ELTF_EL_REL_VER General parameter string: The version of this Enea
144 NFV Access release. Major version and optional .Minor
145 Typically created from MAJOR and MINOR in enea.conf
146 MINOR in enea.conf is empty or contains a dot+minor
147 xi_include EneaLinux_REL_VER/1
148 This is a <phrase>X.x</phrase> used in many places.
149 Examples:
1506
151 or
1526.1
153
154_____________________________________________________________________________
155ELTF_YOCTO_VER General parameter string: Yocto version, created
156 from DISTRO in poky.ent
157 xi:include Yocto_VER/1
158 This is a <phrase>X.x</phrase> used in many places.
159 Example:
1602.1
161
162_____________________________________________________________________________
163ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created
164 from DISTRO_NAME_NO_CAP in poky.ent
165 xi:include Yocto_NAME/1
166 This is a <phrase>X.x</phrase> used in many places.
167 Example:
168krogoth
169
170_____________________________________________________________________________
171ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL
172ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string
173 at the end, typically without "dot".
174 xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1
175 This is an <ulink url="...">...</ulink>
176 Example:
177http://www.yoctoproject.org/downloads/core/krogoth/21
178
179_____________________________________________________________________________
180ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings
181ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where
182 Enea NFV Access can be downloaded
183 Often containing same version as in ELTF_EL_REL_VER
184 xi:include ULINK_ENEA_LINUX_URL/1
185 This is an <ulink url="...">...</ulink>
186 Example:
187http://linux.enea.com/6
188
189_____________________________________________________________________________
190ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything.
191 Use the variable $MACHINE/default.xml (the text in
192 the book will list the avaiable values of MACHINE,
193 taken from the manifest repository)
194 xi:include eltf-repo-cloning-enea-linux/1
195 This is a <programlisting>...</programlisting>
196 Example:
197mkdir enea-linux
198cd enea-linux
199repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \
200 -b refs/tags/EL6 -m $MACHINE/default.xml
201repo sync
202
203_____________________________________________________________________________
204ELTF_ECLIPSE_VERSION Optional general parameter string.
205 NOT YET READY DEFINED
206 Just now a release manage must manually set
207 condition="hidden" on the Eclipse section,
208 if Eclipse is not included in the release.
209 ELTF just replaces ELTF_ECLIPSE_VERSION with a full
210 string with "X.Y (name)"
211 It includes the ID and can only be ONCE in the book.
212 xi:include eltf-eclipse-version-row
213 Example.
2144.5 (Mars)
215
216
217_____________________________________________________________________________
218ELTF_T_* All these are in each target (MACHINE) and ELTF
219 must separately replace them with strings for
220 each target
221 NOTE: All (except the MANIFEST_DIR) are in rows
222 in a table and ELTF can select to append
223 more parameters by adding more rows
224
225_____________________________________________________________________________
226ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly
227ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same
228 as the MACHINE names in $MACHINE/default.xml.
229 In book: a) Part of section ID
230 b) Part of section title
231 Examples:
232p2041rgb
233 or
234ls1021aiot
235 or
236qemuarm
237
238_____________________________________________________________________________
239ELTF_T_NAME Target specific: "Target Official Name"
240 NOT same as the target directory name in most cases.
241 In book: An <entry> element in a row
242 Examples:
243P2041RGB
244 or
245LS1021a-IoT
246 or
247qemuarm
248
249_____________________________________________________________________________
250ELTF_T_ARC_DESC Target specific: "Architecture and Description"
251 It can be a short identification string or
252 it can be a longer descriptive sentence.
253 In book: An <entry> element in a row
254 Examples:
255Power, e500mc
256 or
257ARM Cortex-A7
258
259_____________________________________________________________________________
260ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These
261ELTF_T_DS_URL two usually are IDENTICAL strings with correct
262 hyperlink to the target's official datasheet.
263 In book: an <ulink url="...">...</ulink>
264 Only if the link is VERY LONG, the text part shall
265 instead be a descriptive string (see 2:nd example).
266 NOTE: Also here no spaces or line-feeds!
267 Examples:
268url="http://wiki.qemu.org">http://wiki.qemu.org
269or
270url="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
271
272_____________________________________________________________________________
273ELTF_T_POKY_VER Target specific: "Poky version" created either
274 from POKYVERSION in poky.ent
275 or using a hashvalue with a leading string, in
276 which case it may be different per target.
277 In book: An <entry> in a row
278 Examples:
27915.0.0
280or
281Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2
282
283_____________________________________________________________________________
284ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky
285 but not easy to find among various parameters.
286 ELTF would extract it from build logs building SDK
287 and it is possibly different per target.
288 In book: An <entry> in a row
289 Example:
2905.3
291
292_____________________________________________________________________________
293ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often
294 different per target.
295 In book: An <entry> in a row
296 Example:
2973.12
298
299_____________________________________________________________________________
300ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a
301 comma-separated list of driver names.
302 ELTF should create the list in same order for each
303 target, e.g. alphabetic migth be OK.
304 In book: An <entry> in a row
305 Example:
306Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC
307
308
309_____________________________________________________________________________
310ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading
311ELTF_T_EL_RPM_URL RPM packages for this target". These two are
312 INDENTICAL strings with hyperlink to the web site
313 at Enea where the customer can download RPMs
314 Note: Often the ELFT_EL_REL_VER value and
315 the ELTF_T_MANIFEST_DIR are used in the link.
316 In book: an <ulink url="...">...</ulink>
317 Example:
318url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm
319
320_____________________________________________________________________________
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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="getting_started">
3 <title>Getting Started with the Automation Framework and Test
4 Harness</title>
5
6 <section id="prerequisites">
7 <title>Prerequisites</title>
8
9 <para>For installation of the Automation Framework and Test Harness a
10 CentOS 7 host machine is needed with support for:</para>
11
12 <itemizedlist>
13 <listitem>
14 <para>Python 2.7</para>
15 </listitem>
16
17 <listitem>
18 <para>EPEL Repository installed:<programlisting>sudo yum install epel-release</programlisting></para>
19 </listitem>
20
21 <listitem>
22 <para>PIP package manager installed: <programlisting>sudo yum -y install python-pip</programlisting></para>
23 </listitem>
24
25 <listitem>
26 <para>Virtualenv tool installed: <programlisting>sudo pip install virtualenv</programlisting></para>
27 </listitem>
28 </itemizedlist>
29
30 <note>
31 <para>The Automation Framework and Test Harness installation may be done
32 on the same machine used for uCPE Manager installation, although this is
33 not encouraged. For more details see <link linkend="automation">chapter
34 3.2</link>.</para>
35 </note>
36 </section>
37
38 <section id="envrion">
39 <title>Environment</title>
40
41 <para><figure>
42 <title>Lab setup overview for Basic Setup</title>
43
44 <mediaobject>
45 <imageobject>
46 <imagedata align="center"
47 fileref="images/environment_basicsetup.png" scale="35" />
48 </imageobject>
49 </mediaobject>
50 </figure>The following enviroment setup is needed for running all the
51 tests defined in the Enea NFV Access System Test Specification
52 document:</para>
53
54 <para><emphasis role="bold">Lab Network</emphasis><itemizedlist>
55 <listitem>
56 <para>DHCP enabled.</para>
57 </listitem>
58
59 <listitem>
60 <para>Internet Connectivity.</para>
61 </listitem>
62 </itemizedlist></para>
63
64 <para><emphasis role="bold">uCPE Manager host</emphasis></para>
65
66 <itemizedlist>
67 <listitem>
68 <para>Running CentOS 7.</para>
69 </listitem>
70
71 <listitem>
72 <para>Connected to Lab Network.</para>
73 </listitem>
74
75 <listitem>
76 <para>uCPE Manager installed.</para>
77
78 <note>
79 <para>For details on how to install the uCPE Manager, see "Getting
80 Started with Enea uCPE Manager" from the Enea NFV Access Getting
81 Started manual.</para>
82 </note>
83 </listitem>
84 </itemizedlist>
85
86 <para><emphasis role="bold">1<superscript>st</superscript> Intel Whitebox
87 target device</emphasis><itemizedlist>
88 <listitem>
89 <para>Minimum 4 Physical Network Devices.</para>
90 </listitem>
91
92 <listitem>
93 <para>4GB RAM and 4 cores (Intel C3000 or Xeon D).</para>
94 </listitem>
95
96 <listitem>
97 <para>2 Physical connections to Lab Network.</para>
98 </listitem>
99
100 <listitem>
101 <para>Enea NFV Access installed.</para>
102
103 <note>
104 <para>For information on how to install Enea NFV Access<remark>the
105 solution or the platform?</remark>, refer to "Getting Started with
106 Enea NFV Access" from the Enea NFV Access Getting Started
107 manual.</para>
108 </note>
109 </listitem>
110 </itemizedlist><figure>
111 <title>Lab setup overview for ChainedVNFsService Setup</title>
112
113 <mediaobject>
114 <imageobject>
115 <imagedata align="center"
116 fileref="images/ChainedVNFsService_setup.png"
117 scale="40" />
118 </imageobject>
119 </mediaobject>
120 </figure></para>
121
122 <para><emphasis role="bold">Changes to 1st Intel Whitebox target
123 device</emphasis></para>
124
125 <itemizedlist>
126 <listitem>
127 <para>16GB RAM and 8 cores (Intel C3000 or Xeon D).</para>
128 </listitem>
129
130 <listitem>
131 <para>1 Physical connection back to back with the 2nd Intel Whitebox
132 target device.</para>
133 </listitem>
134 </itemizedlist>
135
136 <para><emphasis role="bold">2<superscript>nd</superscript> Intel Whitebox
137 target device</emphasis><itemizedlist>
138 <listitem>
139 <para>Minimum 4 Physical Network Devices.</para>
140 </listitem>
141
142 <listitem>
143 <para>16GB RAM and 8 cores (Intel C3000 or Xeon D).</para>
144 </listitem>
145
146 <listitem>
147 <para>2 Physical connections to Lab Network.</para>
148 </listitem>
149
150 <listitem>
151 <para>1 Physical connection back to back with the
152 1<superscript>st</superscript> Intel Whitebox target device.</para>
153 </listitem>
154
155 <listitem>
156 <para>Enea NFV Access installed.</para>
157
158 <note>
159 <para>For information on how to install Enea NFV Access<remark>the
160 solution or the platform?</remark>, refer to "Getting Started with
161 Enea NFV Access" from the Enea NFV Access Getting Started
162 manual.</para>
163 </note>
164 </listitem>
165 </itemizedlist></para>
166 </section>
167
168 <section id="initial_setup">
169 <title>Installation and Initial Setup</title>
170
171 <para>Download <filename>nfvaccess22_af-th.zip</filename> from the Enea
172 Portal and unzip it on the a supported host machine. Henceforth, the
173 directory in which the ZIP archive has been unpacked will be denoted as
174 <literal>&lt;AF-TH-installdir&gt;</literal>.</para>
175
176 <para>Enter the <literal>&lt;AF-TH-install-dir&gt;</literal> directory and
177 run the <filename>setup_env.sh</filename> script to do the initial setup
178 of the Test Harness environment: <filename>source
179 setup_env.sh</filename>.</para>
180
181 <para>Setup the uCPE Manager which will be used by the TH:</para>
182
183 <orderedlist>
184 <listitem>
185 <para>Create the uCPE Manager JSON config file in the
186 <literal>&lt;AF-TH-install-dir&gt;/uCPEM_config/</literal>
187 directory:<programlisting>{
188"ucpe_usr":"uCPE Manager Username",
189"ucpe_pass":"uCPE Manager Password",
190"ucpe_host":"uCPE Manager IP/Hostname",
191"ftp_usr":"FTP Username",
192"ftp_pass":"FTP Password",
193"ftp_port":"FTP Port"
194}</programlisting>See the
195 <filename>&lt;AF-TH-install-dir&gt;/uCPEM_config/ucpem01.json</filename>
196 file as an example.</para>
197 </listitem>
198
199 <listitem>
200 <para>Run the <filename>setupuCPEManager.yml</filename> Ansible
201 Playbook with the JSON config path as parameter: <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\
202"@uCPEM_config/&lt;config_name&gt;.json"</programlisting></para>
203
204 <para><emphasis role="bold">Example</emphasis> <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\
205"@uCPEM_config/ucpem01.json"</programlisting></para>
206 </listitem>
207 </orderedlist>
208
209 <para>Note that the steps presented in this sub-chapter are to be executed
210 only once, for the initial setup of the TH environment. Afterwards, each
211 session ends by closing the Python virtual environment (<literal>source
212 &lt;AF-THinstall-dir&gt;/testHarness/bin/deactivate</literal>) and
213 subsequent use of the installation requires activating the Python virtual
214 enviroment before using the Automation Framework and Test Harness
215 (<literal>source
216 &lt;AF-THinstall-dir&gt;/testHarness/bin/activate</literal>).</para>
217
218 <para>Furthermore, if a user wants to use a new uCPE Manager instance for
219 a new session, the user also has to re-run the
220 <filename>setupuCPEManager.yml</filename> playbook with the corresponding
221 JSON config for the new uCPE Manager instance.</para>
222 </section>
223</chapter> \ 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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="getting_started">
3 <title>Getting Started with the Automation Framework and Test
4 Harness</title>
5
6 <section id="prerequisites">
7 <title>Prerequisites</title>
8
9 <para>For installation of the Automation Framework and Test Harness a
10 CentOS 7 host machine is needed with support for:</para>
11
12 <itemizedlist>
13 <listitem>
14 <para>Python 2.7</para>
15 </listitem>
16
17 <listitem>
18 <para>EPEL Repository installed:<programlisting>sudo yum install epel-release</programlisting></para>
19 </listitem>
20
21 <listitem>
22 <para>PIP package manager installed: <programlisting>sudo yum -y install python-pip</programlisting></para>
23 </listitem>
24
25 <listitem>
26 <para>Virtualenv tool installed: <programlisting>sudo pip install virtualenv</programlisting></para>
27 </listitem>
28 </itemizedlist>
29
30 <note>
31 <para>The Automation Framework and Test Harness installation may be done
32 on the same machine used for uCPE Manager installation, although this is
33 not encouraged. For more details see <link linkend="automation">chapter
34 3.2</link>.</para>
35 </note>
36 </section>
37
38 <section id="envrion">
39 <title>Environment</title>
40
41 <para><figure>
42 <title>Lab setup overview for Basic Setup</title>
43
44 <mediaobject>
45 <imageobject>
46 <imagedata align="center"
47 fileref="images/environment_basicsetup.png" scale="35" />
48 </imageobject>
49 </mediaobject>
50 </figure>The following enviroment setup is needed for running all the
51 tests defined in the Enea NFV Access System Test Specification
52 document:</para>
53
54 <para><emphasis role="bold">Lab Network</emphasis><itemizedlist>
55 <listitem>
56 <para>DHCP enabled.</para>
57 </listitem>
58
59 <listitem>
60 <para>Internet Connectivity.</para>
61 </listitem>
62 </itemizedlist></para>
63
64 <para><emphasis role="bold">uCPE Manager host</emphasis></para>
65
66 <itemizedlist>
67 <listitem>
68 <para>Running CentOS 7.</para>
69 </listitem>
70
71 <listitem>
72 <para>Connected to Lab Network.</para>
73 </listitem>
74
75 <listitem>
76 <para>uCPE Manager installed.</para>
77
78 <note>
79 <para>For details on how to install the uCPE Manager, see "Getting
80 Started with Enea uCPE Manager" from the Enea NFV Access Getting
81 Started manual.</para>
82 </note>
83 </listitem>
84 </itemizedlist>
85
86 <para><emphasis role="bold">1<superscript>st</superscript> Intel Whitebox
87 target device</emphasis><itemizedlist>
88 <listitem>
89 <para>Minimum 4 Physical Network Devices.</para>
90 </listitem>
91
92 <listitem>
93 <para>4GB RAM and 4 cores (Intel C3000 or Xeon D).</para>
94 </listitem>
95
96 <listitem>
97 <para>2 Physical connections to Lab Network.</para>
98 </listitem>
99
100 <listitem>
101 <para>Enea NFV Access installed.</para>
102
103 <note>
104 <para>For information on how to install Enea NFV Access<remark>the
105 solution or the platform?</remark>, refer to "Getting Started with
106 Enea NFV Access" from the Enea NFV Access Getting Started
107 manual.</para>
108 </note>
109 </listitem>
110 </itemizedlist><figure>
111 <title>Lab setup overview for ChainedVNFsService Setup</title>
112
113 <mediaobject>
114 <imageobject>
115 <imagedata align="center"
116 fileref="images/ChainedVNFsService_setup.png"
117 scale="40" />
118 </imageobject>
119 </mediaobject>
120 </figure></para>
121
122 <para><emphasis role="bold">Changes to 1st Intel Whitebox target
123 device</emphasis></para>
124
125 <itemizedlist>
126 <listitem>
127 <para>16GB RAM and 8 cores (Intel C3000 or Xeon D).</para>
128 </listitem>
129
130 <listitem>
131 <para>1 Physical connection back to back with the 2nd Intel Whitebox
132 target device.</para>
133 </listitem>
134 </itemizedlist>
135
136 <para><emphasis role="bold">2<superscript>nd</superscript> Intel Whitebox
137 target device</emphasis><itemizedlist>
138 <listitem>
139 <para>Minimum 4 Physical Network Devices.</para>
140 </listitem>
141
142 <listitem>
143 <para>16GB RAM and 8 cores (Intel C3000 or Xeon D).</para>
144 </listitem>
145
146 <listitem>
147 <para>2 Physical connections to Lab Network.</para>
148 </listitem>
149
150 <listitem>
151 <para>1 Physical connection back to back with the
152 1<superscript>st</superscript> Intel Whitebox target device.</para>
153 </listitem>
154
155 <listitem>
156 <para>Enea NFV Access installed.</para>
157
158 <note>
159 <para>For information on how to install Enea NFV Access<remark>the
160 solution or the platform?</remark>, refer to "Getting Started with
161 Enea NFV Access" from the Enea NFV Access Getting Started
162 manual.</para>
163 </note>
164 </listitem>
165 </itemizedlist></para>
166 </section>
167
168 <section id="initial_setup">
169 <title>Installation and Initial Setup</title>
170
171 <para>Download <filename>nfvaccess22_af-th.zip</filename> from the Enea
172 Portal and unzip it on the a supported host machine. Henceforth, the
173 directory in which the ZIP archive has been unpacked will be denoted as
174 <literal>&lt;AF-TH-installdir&gt;</literal>.</para>
175
176 <para>Enter the <literal>&lt;AF-TH-install-dir&gt;</literal> directory and
177 run the <filename>setup_env.sh</filename> script to do the initial setup
178 of the Test Harness environment: <filename>source
179 setup_env.sh</filename>.</para>
180
181 <para>Setup the uCPE Manager which will be used by the TH:</para>
182
183 <orderedlist>
184 <listitem>
185 <para>Create the uCPE Manager JSON config file in the
186 <literal>&lt;AF-TH-install-dir&gt;/uCPEM_config/</literal>
187 directory:<programlisting>{
188"ucpe_usr":"uCPE Manager Username",
189"ucpe_pass":"uCPE Manager Password",
190"ucpe_host":"uCPE Manager IP/Hostname",
191"ftp_usr":"FTP Username",
192"ftp_pass":"FTP Password",
193"ftp_port":"FTP Port"
194}</programlisting>See the
195 <filename>&lt;AF-TH-install-dir&gt;/uCPEM_config/ucpem01.json</filename>
196 file as an example.</para>
197 </listitem>
198
199 <listitem>
200 <para>Run the <filename>setupuCPEManager.yml</filename> Ansible
201 Playbook with the JSON config path as parameter: <programlisting>ansible-playbook playbooks/setupuCPEManager.yml &ndash;e\
202"@uCPEM_config/&lt;config_name&gt;.json"</programlisting></para>
203
204 <para><emphasis role="bold">Example</emphasis> <programlisting>ansible-playbook playbooks/setupuCPEManager.yml &ndash;e\
205"@uCPEM_config/ucpem01.json"</programlisting></para>
206 </listitem>
207 </orderedlist>
208
209 <para>Note that the steps presented in this sub-chapter are to be executed
210 only once, for the initial setup of the TH environment. Afterwards, each
211 session ends by closing the Python virtual environment (<literal>source
212 &lt;AF-THinstall-dir&gt;/testHarness/bin/deactivate</literal>) and
213 subsequent use of the installation requires activating the Python virtual
214 enviroment before using the Automation Framework and Test Harness
215 (<literal>source
216 &lt;AF-THinstall-dir&gt;/testHarness/bin/activate</literal>). </para>
217
218 <para>Furthermore, if a user wants to use a new uCPE Manager instance for
219 a new session, the user also has to re-run the
220 <filename>setupuCPEManager.yml</filename> playbook with the corresponding
221 JSON config for the new uCPE Manager instance.</para>
222 </section>
223</chapter> \ 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
--- /dev/null
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/ChainedVNFsService_setup.png
Binary files 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
--- /dev/null
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/autofw_testh_overview.png
Binary files 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
--- /dev/null
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/images/environment_basicsetup.png
Binary files 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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="overview">
3 <title>Overview</title>
4
5 <para>This document describes the Automation Framework and Test Harness for
6 the Enea NFV Access Solution, a long with providing instructions regarding
7 the necessary steps to run these software tools.</para>
8
9 <section id="descrip">
10 <title>Description</title>
11
12 <para>The Automation Framework provides a way for driving configuration
13 with Python scripting. It complements the Enea uCPE Manager GUI and uses
14 the northbound REST APIs, given for full availability of the Enea uCPE
15 Manager features.</para>
16
17 <para>The Test Harness is based on running Ansible Playbooks to complete
18 different test cases, which make use of the Automation Framework Python
19 modules and/or direct commands on the boards running Enea NFV
20 Access.</para>
21 </section>
22
23 <section id="def_acro">
24 <title>Definitions and Acronyms</title>
25
26 <table>
27 <title>Definitions</title>
28
29 <tgroup cols="2">
30 <colspec align="center" />
31
32 <thead>
33 <row>
34 <entry align="center">Component</entry>
35
36 <entry align="center">Description</entry>
37 </row>
38 </thead>
39
40 <tbody>
41 <row>
42 <entry>Enea NFV Access Solution</entry>
43
44 <entry>Enea NFV Access (with ODM) Runtime Platform and Enea uCPE
45 Manager.</entry>
46 </row>
47
48 <row>
49 <entry>Enea Portal</entry>
50
51 <entry><ulink
52 url="https://portal.enea.com">https://portal.enea.com</ulink></entry>
53 </row>
54 </tbody>
55 </tgroup>
56 </table>
57
58 <table>
59 <title>Acronyms</title>
60
61 <tgroup cols="2">
62 <colspec align="center" />
63
64 <thead>
65 <row>
66 <entry align="center">Component</entry>
67
68 <entry align="center">Description</entry>
69 </row>
70 </thead>
71
72 <tbody>
73 <row>
74 <entry>AF</entry>
75
76 <entry>Automation Framework for Enea NFV Access.</entry>
77 </row>
78
79 <row>
80 <entry>API</entry>
81
82 <entry>Application Programming Interface.</entry>
83 </row>
84
85 <row>
86 <entry>DHCP</entry>
87
88 <entry>Dynamic Host Configuration Protocol.</entry>
89 </row>
90
91 <row>
92 <entry>DPDK</entry>
93
94 <entry>Data Plane Development Kit.</entry>
95 </row>
96
97 <row>
98 <entry>FTP</entry>
99
100 <entry>File Transfer Protocol.</entry>
101 </row>
102
103 <row>
104 <entry>GUI</entry>
105
106 <entry>Graphical User Interface.</entry>
107 </row>
108
109 <row>
110 <entry>IP</entry>
111
112 <entry>Internet Protocol.</entry>
113 </row>
114
115 <row>
116 <entry>JSON</entry>
117
118 <entry>JavaScript Object Notation.</entry>
119 </row>
120
121 <row>
122 <entry>NIC</entry>
123
124 <entry>Network Interface Card.</entry>
125 </row>
126
127 <row>
128 <entry>NETCONF</entry>
129
130 <entry>Network Configuration Protocol.</entry>
131 </row>
132
133 <row>
134 <entry>NFV</entry>
135
136 <entry>Network Functions Virtualization.</entry>
137 </row>
138
139 <row>
140 <entry>ODM</entry>
141
142 <entry>Enea Element On Device Management.</entry>
143 </row>
144
145 <row>
146 <entry>OVS</entry>
147
148 <entry>Open vSwitch.</entry>
149 </row>
150
151 <row>
152 <entry>REST</entry>
153
154 <entry>Representational State Transfer.</entry>
155 </row>
156
157 <row>
158 <entry>SR-IOV</entry>
159
160 <entry>Single Root Input/Output Virtualization.</entry>
161 </row>
162
163 <row>
164 <entry>SSH</entry>
165
166 <entry>Secure Shell.</entry>
167 </row>
168
169 <row>
170 <entry>TH</entry>
171
172 <entry>Test Harness for Enea NFV Access.</entry>
173 </row>
174
175 <row>
176 <entry>uCPE Manager</entry>
177
178 <entry>Enea Universal Customer Premises Equipment Manager.</entry>
179 </row>
180
181 <row>
182 <entry>VCPE</entry>
183
184 <entry>Virtual Customer Premises Equipment</entry>
185 </row>
186
187 <row>
188 <entry>VNF</entry>
189
190 <entry>Virtualized Network Function</entry>
191 </row>
192 </tbody>
193 </tgroup>
194 </table>
195 </section>
196</chapter> \ 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 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="troubleshooting_guide">
3 <title>Troubleshooting Guide</title>
4
5 <para></para>
6</chapter> \ 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 @@
1# Component build specification
2
3# Version of THIS book
4BOOK_VER ?= $(REL_VER)-dev
5
6DOCBOOK_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)
7
8BOOKPACKAGES := book-enea-nfv-access-auto-fw-th-user-guide
9BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) Automation Framework and Test Harness User Guide"
10BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS)