diff options
author | Daniel <Daniel.Petrica@enea.com> | 2019-12-20 12:22:15 +0100 |
---|---|---|
committer | Daniel <Daniel.Petrica@enea.com> | 2019-12-20 12:23:52 +0100 |
commit | 07bcd42e5e0115a93858e94dbc897ab07fa938e9 (patch) | |
tree | 36c15b2b8a4e8b954c54bf143893c0f7030ef7e8 | |
parent | c8b47f29ba734f9dc1e5d87a9cff819329380ede (diff) | |
download | el_releases-nfv-access-07bcd42e5e0115a93858e94dbc897ab07fa938e9.tar.gz |
Minor updates for EvalKit book.
Change-Id: Id46a2f3467d6e09d8272ac1f93310e178f95f6d9
-rw-r--r-- | doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml | 28 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_template.xml | 151 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated.xml | 105 | ||||
-rwxr-xr-x | doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt | 320 | ||||
-rw-r--r--[-rwxr-xr-x] | doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_overview.png | bin | 95022 -> 95022 bytes | |||
-rw-r--r--[-rwxr-xr-x] | doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_setup.png | bin | 79858 -> 79858 bytes | |||
-rw-r--r-- | doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml | 16 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml | 23 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml | 105 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml | 4 | ||||
-rw-r--r-- | doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml | 13 |
11 files changed, 100 insertions, 665 deletions
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml index f89372a..0895bcb 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml | |||
@@ -3,7 +3,7 @@ | |||
3 | <title>How to create a flexiwan cloud-init iso image (day-0 | 3 | <title>How to create a flexiwan cloud-init iso image (day-0 |
4 | configuration)</title> | 4 | configuration)</title> |
5 | 5 | ||
6 | <para>Prerequisites: </para> | 6 | <para>Prerequisites:</para> |
7 | 7 | ||
8 | <itemizedlist> | 8 | <itemizedlist> |
9 | <listitem> | 9 | <listitem> |
@@ -15,21 +15,21 @@ | |||
15 | </listitem> | 15 | </listitem> |
16 | </itemizedlist> | 16 | </itemizedlist> |
17 | 17 | ||
18 | <note><para>Contact the flexiWAN VNF provider to get access to their controller and a valid token.</para></note> | 18 | <note> |
19 | <para>Contact the flexiWAN VNF provider to get access to their controller | ||
20 | and a valid token.</para> | ||
21 | </note> | ||
19 | 22 | ||
20 | <para>Unpack the <filename>flexiwan/flexiwan-cloud-init-example.tar.gz</filename> and check | 23 | <para>Unpack the |
21 | the README file for more details: | 24 | <filename>flexiwan/flexiwan-cloud-init-example.tar.gz</filename> and check |
22 | 25 | the README file for more details: <programlisting>tar -zxf flexiwant-cloud-init-example.tar.gz | |
23 | <programlisting>tar -zxf flexiwant-cloud-init-example.tar.gz | ||
24 | cd flexiwan/cloud-init-example/</programlisting></para> | 26 | cd flexiwan/cloud-init-example/</programlisting></para> |
25 | 27 | ||
26 | <para>To generate the cloud-init iso image:</para> | 28 | <para>To generate the cloud-init iso image:</para> |
27 | 29 | ||
28 | <programlisting> | 30 | <programlisting>> create_flexiwan_cloudinit.sh <token> |
29 | > create_flexiwan_cloudinit.sh <token> | 31 | > create_flexiwan_cloudinit.sh $cat token.txt</programlisting> |
30 | > create_flexiwan_cloudinit.sh | 32 | |
31 | > $cat token.txt | 33 | <para>The <filename>flexiWAN_cloudinit.iso</filename> file can be used to |
32 | </programlisting> | 34 | instantiate the flexiWAN VNF on NFV Access.</para> |
33 | |||
34 | <para>The <filename>flexiWAN_cloudinit.iso</filename> file can be used to instantiate the flexiWAN VNF on NFV Access.</para> | ||
35 | </appendix> \ No newline at end of file | 35 | </appendix> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_template.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_template.xml deleted file mode 100644 index eaa7ebd..0000000 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_template.xml +++ /dev/null | |||
@@ -1,151 +0,0 @@ | |||
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 | <row>, 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-evalkit-2.2.1/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated.xml index bb969c6..1a640a3 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated.xml | |||
@@ -44,12 +44,12 @@ export PATH=~/bin:$PATH</programlisting></para> | |||
44 | 44 | ||
45 | <para id="EneaLinux_REL_VER"><phrase>2.2.1</phrase></para> | 45 | <para id="EneaLinux_REL_VER"><phrase>2.2.1</phrase></para> |
46 | 46 | ||
47 | <para id="Yocto_VER"><phrase>2.1</phrase></para> | 47 | <para id="Yocto_VER"><phrase>2.4</phrase></para> |
48 | 48 | ||
49 | <para id="Yocto_NAME"><phrase>krogoth</phrase></para> | 49 | <para id="Yocto_NAME"><phrase>rocko</phrase></para> |
50 | 50 | ||
51 | <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink | 51 | <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink |
52 | url="http://www.yoctoproject.org/downloads/core/krogoth/21">http://www.yoctoproject.org/downloads/core/krogoth/21</ulink></para> | 52 | url="http://www.yoctoproject.org/downloads">http://www.yoctoproject.org/downloads</ulink></para> |
53 | 53 | ||
54 | <para id="ULINK_ENEA_LINUX_URL"><ulink | 54 | <para id="ULINK_ENEA_LINUX_URL"><ulink |
55 | url="https://linux.enea.com/6">https://linux.enea.com/6</ulink></para> | 55 | url="https://linux.enea.com/6">https://linux.enea.com/6</ulink></para> |
@@ -80,7 +80,7 @@ repo sync</programlisting></para> | |||
80 | </tgroup> | 80 | </tgroup> |
81 | </informaltable> | 81 | </informaltable> |
82 | 82 | ||
83 | <bridgehead>Below is one big section with title "Supported Targets with | 83 | <bridgehead>Below is one big section with title "Supported Processor with |
84 | Parameters". The entire section is included completely in the book via ID | 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 | 85 | "eltf-target-tables-section" and shall be LAST in the template. The |
86 | template contains ONE target subsection. COPY/APPEND it, if multiple | 86 | template contains ONE target subsection. COPY/APPEND it, if multiple |
@@ -89,13 +89,13 @@ repo sync</programlisting></para> | |||
89 | </section> | 89 | </section> |
90 | 90 | ||
91 | <section id="eltf-target-tables-section"> | 91 | <section id="eltf-target-tables-section"> |
92 | <title>Supported Reference Boards with Parameters</title> | 92 | <title>Supported Reference Processor with Parameters</title> |
93 | 93 | ||
94 | <para>The table(s) below describes the target(s) supported in this Enea | 94 | <para>The table(s) below describes the processors supported in this Enea |
95 | NFV Access release.</para> | 95 | NFV Access release.</para> |
96 | 96 | ||
97 | <table> | 97 | <table> |
98 | <title>MACHINE Information Intel Xeon D</title> | 98 | <title>Processor Information Intel Xeon D-1500</title> |
99 | 99 | ||
100 | <tgroup cols="2"> | 100 | <tgroup cols="2"> |
101 | <colspec align="center" /> | 101 | <colspec align="center" /> |
@@ -110,9 +110,9 @@ repo sync</programlisting></para> | |||
110 | 110 | ||
111 | <tbody> | 111 | <tbody> |
112 | <row> | 112 | <row> |
113 | <entry align="left">Target official name</entry> | 113 | <entry align="left">Processor official name</entry> |
114 | 114 | ||
115 | <entry>Intel Xeon D</entry> | 115 | <entry>Intel Xeon D-1500</entry> |
116 | </row> | 116 | </row> |
117 | 117 | ||
118 | <row> | 118 | <row> |
@@ -122,7 +122,7 @@ repo sync</programlisting></para> | |||
122 | </row> | 122 | </row> |
123 | 123 | ||
124 | <row> | 124 | <row> |
125 | <entry align="left">Link to target datasheet</entry> | 125 | <entry align="left">Link to processor datasheet</entry> |
126 | 126 | ||
127 | <entry><ulink | 127 | <entry><ulink |
128 | url="https://www.intel.com/content/www/us/en/processors/xeon/xeon-d-1500-datasheet-vol-1.html">Intel's | 128 | url="https://www.intel.com/content/www/us/en/processors/xeon/xeon-d-1500-datasheet-vol-1.html">Intel's |
@@ -130,13 +130,6 @@ repo sync</programlisting></para> | |||
130 | </row> | 130 | </row> |
131 | 131 | ||
132 | <row> | 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> | 133 | <entry align="left">GCC version</entry> |
141 | 134 | ||
142 | <entry>7.3</entry> | 135 | <entry>7.3</entry> |
@@ -158,7 +151,7 @@ repo sync</programlisting></para> | |||
158 | </table> | 151 | </table> |
159 | 152 | ||
160 | <table> | 153 | <table> |
161 | <title>MACHINE Information Intel Atom C3000</title> | 154 | <title>Processor Information Intel Atom C3000</title> |
162 | 155 | ||
163 | <tgroup cols="2"> | 156 | <tgroup cols="2"> |
164 | <colspec align="center" /> | 157 | <colspec align="center" /> |
@@ -173,7 +166,7 @@ repo sync</programlisting></para> | |||
173 | 166 | ||
174 | <tbody> | 167 | <tbody> |
175 | <row> | 168 | <row> |
176 | <entry align="left">Target official name</entry> | 169 | <entry align="left">Processor official name</entry> |
177 | 170 | ||
178 | <entry>Intel Atom C3000</entry> | 171 | <entry>Intel Atom C3000</entry> |
179 | </row> | 172 | </row> |
@@ -185,7 +178,7 @@ repo sync</programlisting></para> | |||
185 | </row> | 178 | </row> |
186 | 179 | ||
187 | <row> | 180 | <row> |
188 | <entry align="left">Link to target datasheet</entry> | 181 | <entry align="left">Link to the processor datasheet</entry> |
189 | 182 | ||
190 | <entry><ulink | 183 | <entry><ulink |
191 | url="https://www.intel.com/content/www/us/en/products/docs/processors/atom/c-series/c3000-family-datasheet.html">Intel's | 184 | url="https://www.intel.com/content/www/us/en/products/docs/processors/atom/c-series/c3000-family-datasheet.html">Intel's |
@@ -193,13 +186,6 @@ repo sync</programlisting></para> | |||
193 | </row> | 186 | </row> |
194 | 187 | ||
195 | <row> | 188 | <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> | 189 | <entry align="left">GCC version</entry> |
204 | 190 | ||
205 | <entry>7.3</entry> | 191 | <entry>7.3</entry> |
@@ -219,68 +205,5 @@ repo sync</programlisting></para> | |||
219 | </tbody> | 205 | </tbody> |
220 | </tgroup> | 206 | </tgroup> |
221 | </table> | 207 | </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> | 208 | </section> |
286 | </section> \ No newline at end of file | 209 | </section> |
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt deleted file mode 100755 index 62e5d02..0000000 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt +++ /dev/null | |||
@@ -1,320 +0,0 @@ | |||
1 | eltf_params_template_updated_howto_use.txt | ||
2 | |||
3 | This is a way to collect all parameters for an Enea NFV Access release | ||
4 | in one parameter file, easy to automatically update by ELTF regularly. | ||
5 | |||
6 | NOTE: 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 | |||
9 | NOTE: 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 | |||
17 | The ordinary book XML files use xi:include statements to include elements | ||
18 | from this parameter file. The book XML files can thus be manually edited. | ||
19 | Before editing, you must run "make init". | ||
20 | Any other text in the template or updated.xml file, outside the parts that | ||
21 | are included in the book, are not used but still all must be correct | ||
22 | DocBook XML files. | ||
23 | |||
24 | ELTF work: | ||
25 | template => ELTF replaces ALL ELTF_xxx variables => updated XML file | ||
26 | => push to git only if changed | ||
27 | |||
28 | |||
29 | eltf_params_template.xml (in git) | ||
30 | File used by ELTF to autocreate/update the real parameter | ||
31 | file eltf_params_updated.xml. | ||
32 | |||
33 | eltf_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 | |||
39 | xi: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 | |||
48 | DocBook XML: All XML files must be correct DocBook XML files. | ||
49 | |||
50 | Do 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 | |||
54 | ELTF should autocreate a temporary "real" file but only replace | ||
55 | and push the eltf_params_updated.xml if it is changed. | ||
56 | |||
57 | |||
58 | make eltf | ||
59 | This lists all ELTF_xxx variables and some rules how to treat them | ||
60 | |||
61 | DocBook 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 < > and & | ||
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 | |||
71 | DocBook 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 | |||
81 | DocBook 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 | |||
85 | Each 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 | |||
98 | Tables 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 | |||
102 | Special - 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 | |||
112 | BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf | ||
113 | if there are more new variables, missing in this description file. | ||
114 | |||
115 | _____________________________________________________________________________ | ||
116 | ELTF_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 | ||
125 | sudo apt-get update | ||
126 | sudo 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 | _____________________________________________________________________________ | ||
133 | ELTF_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: | ||
137 | mkdir -p ~/bin | ||
138 | curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
139 | chmod a+x ~/bin/repo | ||
140 | export PATH=~/bin:$PATH | ||
141 | |||
142 | _____________________________________________________________________________ | ||
143 | ELTF_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: | ||
150 | 6 | ||
151 | or | ||
152 | 6.1 | ||
153 | |||
154 | _____________________________________________________________________________ | ||
155 | ELTF_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: | ||
160 | 2.1 | ||
161 | |||
162 | _____________________________________________________________________________ | ||
163 | ELTF_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: | ||
168 | krogoth | ||
169 | |||
170 | _____________________________________________________________________________ | ||
171 | ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL | ||
172 | ELTF_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: | ||
177 | http://www.yoctoproject.org/downloads/core/krogoth/21 | ||
178 | |||
179 | _____________________________________________________________________________ | ||
180 | ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings | ||
181 | ELTF_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: | ||
187 | http://linux.enea.com/6 | ||
188 | |||
189 | _____________________________________________________________________________ | ||
190 | ELTF_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: | ||
197 | mkdir enea-linux | ||
198 | cd enea-linux | ||
199 | repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ | ||
200 | -b refs/tags/EL6 -m $MACHINE/default.xml | ||
201 | repo sync | ||
202 | |||
203 | _____________________________________________________________________________ | ||
204 | ELTF_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. | ||
214 | 4.5 (Mars) | ||
215 | |||
216 | |||
217 | _____________________________________________________________________________ | ||
218 | ELTF_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 | _____________________________________________________________________________ | ||
226 | ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly | ||
227 | ELTF_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: | ||
232 | p2041rgb | ||
233 | or | ||
234 | ls1021aiot | ||
235 | or | ||
236 | qemuarm | ||
237 | |||
238 | _____________________________________________________________________________ | ||
239 | ELTF_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: | ||
243 | P2041RGB | ||
244 | or | ||
245 | LS1021a-IoT | ||
246 | or | ||
247 | qemuarm | ||
248 | |||
249 | _____________________________________________________________________________ | ||
250 | ELTF_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: | ||
255 | Power, e500mc | ||
256 | or | ||
257 | ARM Cortex-A7 | ||
258 | |||
259 | _____________________________________________________________________________ | ||
260 | ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These | ||
261 | ELTF_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: | ||
268 | url="http://wiki.qemu.org">http://wiki.qemu.org | ||
269 | or | ||
270 | 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 | ||
271 | |||
272 | _____________________________________________________________________________ | ||
273 | ELTF_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: | ||
279 | 15.0.0 | ||
280 | or | ||
281 | Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 | ||
282 | |||
283 | _____________________________________________________________________________ | ||
284 | ELTF_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: | ||
290 | 5.3 | ||
291 | |||
292 | _____________________________________________________________________________ | ||
293 | ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often | ||
294 | different per target. | ||
295 | In book: An <entry> in a row | ||
296 | Example: | ||
297 | 3.12 | ||
298 | |||
299 | _____________________________________________________________________________ | ||
300 | ELTF_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: | ||
306 | Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC | ||
307 | |||
308 | |||
309 | _____________________________________________________________________________ | ||
310 | ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading | ||
311 | ELTF_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: | ||
318 | url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm | ||
319 | |||
320 | _____________________________________________________________________________ | ||
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_overview.png b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_overview.png index 977de0f..977de0f 100755..100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_overview.png +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_overview.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_setup.png b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_setup.png index feb18a3..feb18a3 100755..100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_setup.png +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/images/br_to_br_conn_setup.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml index 4702cb0..7b92bcf 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml | |||
@@ -34,10 +34,10 @@ | |||
34 | flexiWAN and pfSense VNFs service chained together on a uCPE device.</para> | 34 | flexiWAN and pfSense VNFs service chained together on a uCPE device.</para> |
35 | 35 | ||
36 | <para>This document will present all information required to replicate the | 36 | <para>This document will present all information required to replicate the |
37 | use cases described therein in the user's environment. The first part of | 37 | use case described in the user's environment. The first part of this manual |
38 | this manual uses the GUI mode of the uCPE Manager to detail the steps in | 38 | uses the GUI mode of the uCPE Manager to detail the steps in order to |
39 | order to reproduce the use cases, while the chapters thereafter use the | 39 | reproduce the use cases, while the chapters thereafter use the automation |
40 | automation framework.</para> | 40 | framework.</para> |
41 | 41 | ||
42 | <note> | 42 | <note> |
43 | <para>All VNF configurations should be seen as example configurations | 43 | <para>All VNF configurations should be seen as example configurations |
@@ -45,7 +45,7 @@ | |||
45 | configuration data needed according to his network setup. Particularities | 45 | configuration data needed according to his network setup. Particularities |
46 | are described in Appendix A.</para> | 46 | are described in Appendix A.</para> |
47 | 47 | ||
48 | <para>This is document assumes the user is familiar with ENFV Access and | 48 | <para>This document assumes the user is familiar with Enea NFV Access and |
49 | has read the Enea NFV Access Getting Started manual before continuing with | 49 | has read the Enea NFV Access Getting Started manual before continuing with |
50 | the following.</para> | 50 | the following.</para> |
51 | </note> | 51 | </note> |
@@ -56,11 +56,9 @@ | |||
56 | <section> | 56 | <section> |
57 | <title>uCPE Manager</title> | 57 | <title>uCPE Manager</title> |
58 | 58 | ||
59 | <para>The Enea uCPE Manager is an EMS/NMS platform that provides the VNF | 59 | <para>The Enea uCPE Manager is an EMS/NMS platform providing VNF |
60 | Management capabilities for NFV Access devices. The uCPE Manager can be | 60 | Management capabilities for NFV Access devices. The uCPE Manager can be |
61 | deployed on a Linux (CentOS) based physical or virtual server. | 61 | deployed on a Linux (CentOS) based physical or virtual server.</para> |
62 | Co-resident with the uCPE Manager is additional functionality, which | ||
63 | includes the Automation Framework.</para> | ||
64 | </section> | 62 | </section> |
65 | 63 | ||
66 | <section> | 64 | <section> |
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml index 02a29df..725e4e0 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml | |||
@@ -6,32 +6,33 @@ | |||
6 | offline configurations need to be added for both uCPE devices and for the | 6 | offline configurations need to be added for both uCPE devices and for the |
7 | VNFs to be onboarded.</para> | 7 | VNFs to be onboarded.</para> |
8 | 8 | ||
9 | <note> | ||
10 | <para>All tests are just examples. In order to run on user specific | ||
11 | devices they need to be updated accordingly. Please check the Enea NFV | ||
12 | Access System Test Specification manual for more details.</para> | ||
13 | </note> | ||
14 | |||
9 | <programlisting>> python unittestSuite.py -u admin -p admin -H 172.24.3.109 \ | 15 | <programlisting>> python unittestSuite.py -u admin -p admin -H 172.24.3.109 \ |
10 | -o ucpem -s test_EvalKit_addOfflineConfig_and_onBoardVNFs.json -d \ | 16 | -o ucpem -s EvalKit_addOfflineConfig_and_onBoardVNFs.json -d \ |
11 | "Set - offline config for uCPE1 and uCPE2" | 17 | "Set - offline config for uCPE1 and uCPE2" |
12 | 18 | ||
13 | #add device1 | 19 | #add device1 |
14 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n fwa_1012vc-1 \ | 20 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n fwa_1012vc-1 \ |
15 | -s test_EvalKit_Deploy1.json -d "Add taget1 and instantiate VNFs" | 21 | -s EvalKit_Deploy1.json -d "Add taget1 and instantiate VNFs" |
16 | 22 | ||
17 | #add device2 | 23 | #add device2 |
18 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n intelc3850-1 \ | 24 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n intelc3850-1 \ |
19 | -s test_EvalKit_Deploy2.json -d "Add taget2 and instantiate VNFs"</programlisting> | 25 | -s EvalKit_Deploy2.json -d "Add taget2 and instantiate VNFs"</programlisting> |
20 | 26 | ||
21 | <para>Once done, the device configurations need to be cleaned up:</para> | 27 | <para>Once done, the device configurations need to be cleaned up:</para> |
22 | 28 | ||
23 | <programlisting>> python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n fwa_1012vc-1 \ | 29 | <programlisting>> python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n fwa_1012vc-1 \ |
24 | -s test_EvalKit_Cleanup1.json -d "Cleanup config on taget1" | 30 | -s EvalKit_Cleanup1.json -d "Cleanup config on taget1" |
25 | 31 | ||
26 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n intelc3850-1 \ | 32 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -n intelc3850-1 \ |
27 | -s test_EvalKit_Cleanup2.json -d "Cleanup config on taget2" | 33 | -s EvalKit_Cleanup2.json -d "Cleanup config on taget2" |
28 | 34 | ||
29 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -o ucpem -s \ | 35 | > python unittestSuite.py -u admin -p admin -H 172.24.3.109 -o ucpem -s \ |
30 | test_EvalKit_CleanupZTP_and_offboardVNFs.json -d \ | 36 | EvalKit_CleanupZTP_and_offboardVNFs.json -d \ |
31 | "Cleanup offline configuration and OffBoard VNFs"</programlisting> | 37 | "Cleanup offline configuration and OffBoard VNFs"</programlisting> |
32 | |||
33 | <note> | ||
34 | <para>Replace the <uCPE_Manager_IP> with the IP address of uCPE | ||
35 | Manager machine.</para> | ||
36 | </note> | ||
37 | </chapter> \ No newline at end of file | 38 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml index c5da1bc..4fcb6df 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/sdwan_arch.xml | |||
@@ -1,6 +1,6 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="ISO-8859-1"?> |
2 | <chapter id="sdwan_arch_evalkit"> | 2 | <chapter id="sdwan_arch_evalkit"> |
3 | <title>SD-WAN architecture</title> | 3 | <title>SD-WAN Branch to Branch Connection</title> |
4 | 4 | ||
5 | <para>Software-Defined Wide Area Networking (SD-WAN), provides the benefits | 5 | <para>Software-Defined Wide Area Networking (SD-WAN), provides the benefits |
6 | of software-defined networking (SDN) technology to traditionally | 6 | of software-defined networking (SDN) technology to traditionally |
@@ -11,20 +11,16 @@ | |||
11 | abstracts software from hardware, enabling network virtualization and making | 11 | abstracts software from hardware, enabling network virtualization and making |
12 | the network more elastic.</para> | 12 | the network more elastic.</para> |
13 | 13 | ||
14 | <para>The setup detailed in this chapter looks to cover all the steps | 14 | <para>The setup detailed in this chapter covers all the steps required to |
15 | required to create a connection between two branch offices. On each site a | 15 | create a connection between two branch offices. On each site a uCPE device |
16 | uCPE device is installed and connected to a WAN network. NFV Access should | 16 | is installed and connected to a WAN network. NFV Access should be installed |
17 | already be installed on each uCPE device, and with it the flexiWAN and | 17 | on each uCPE device, and flexiWAN and pfSense VNFs will be instantiated on |
18 | pfSense VNFs will be instantiated on each site.</para> | 18 | each site.</para> |
19 | 19 | ||
20 | <para>The flexiWAN VNF will create the tunnel between the two branches while | 20 | <para>The flexiWAN VNF will create the tunnel between the two branches while |
21 | the pfSense VNF (connected in the service chain), will cover the | 21 | the pfSense VNF (connected in the service chain), will cover the |
22 | communication with LAN on each branch. The setup will be configured from the | 22 | communication with LAN on each branch. The setup will be configured from the |
23 | uCPE Manager GUI, accessible from any web browser if connected to the IP | 23 | uCPE Manager GUI.</para> |
24 | address of uCPE Manager machine.</para> | ||
25 | |||
26 | <para>The default login credentials for both username and password are | ||
27 | admin/admin.</para> | ||
28 | 24 | ||
29 | <figure> | 25 | <figure> |
30 | <title>Branch to Branch Connection Overview</title> | 26 | <title>Branch to Branch Connection Overview</title> |
@@ -83,7 +79,8 @@ | |||
83 | <listitem> | 79 | <listitem> |
84 | <para>Install NFV Access on the uCPE devices. See the <remark>make | 80 | <para>Install NFV Access on the uCPE devices. See the <remark>make |
85 | this into an olink</remark> Enea NFV Access Getting Started manual, | 81 | this into an olink</remark> Enea NFV Access Getting Started manual, |
86 | chapter Installing Enea NFV Access, for more details.</para> | 82 | chapter Getting Started with the Enea NFV Access, for more |
83 | details.</para> | ||
87 | </listitem> | 84 | </listitem> |
88 | 85 | ||
89 | <listitem> | 86 | <listitem> |
@@ -94,7 +91,7 @@ | |||
94 | 91 | ||
95 | <note> | 92 | <note> |
96 | <para>The uCPE Manager host machine must be connected to the network | 93 | <para>The uCPE Manager host machine must be connected to the network |
97 | so all uCPE devices can access the internet.</para> | 94 | so all uCPE devices can access it.</para> |
98 | </note> | 95 | </note> |
99 | </listitem> | 96 | </listitem> |
100 | 97 | ||
@@ -108,18 +105,17 @@ | |||
108 | <section id="ucpe_mg_evalkit221"> | 105 | <section id="ucpe_mg_evalkit221"> |
109 | <title>The uCPE Manager</title> | 106 | <title>The uCPE Manager</title> |
110 | 107 | ||
111 | <para>Log into the uCPE manager with the username and password | 108 | <para>Log into the uCPE Manager using the default credentials, |
112 | "admin".</para> | 109 | username:admin and password: admin.</para> |
113 | 110 | ||
114 | <para>In this setup Zero Touch Provisioning (ZTP) will be used to | 111 | <para>Zero Touch Provisioning (ZTP) will be used to preconfigure the |
115 | preconfigure the infrastructure in the uCPE Manager for each device. The | 112 | infrastructure in the uCPE Manager for each device. The interface and |
116 | interface and bridge configurations are pushed onto each uCPE device when | 113 | bridge configurations are pushed onto each uCPE device when |
117 | connected.</para> | 114 | connected.</para> |
118 | 115 | ||
119 | <para>Onboarding is the process of registering VNFs into the uCPE Manager | 116 | <para>Onboarding is the process of registering VNFs into the uCPE Manager |
120 | after devices are configured for the VNF(s) they will host and added into | 117 | after devices are configured. The flexiWAN and pfSense VNFs are used along |
121 | the Manager. The flexiWAN and pfSense VNFs are used along with example | 118 | with example configuration data.</para> |
122 | configuration data.</para> | ||
123 | 119 | ||
124 | <section id="onboard_flexiwan_vnf"> | 120 | <section id="onboard_flexiwan_vnf"> |
125 | <title>Onboarding the FlexiWAN VNF</title> | 121 | <title>Onboarding the FlexiWAN VNF</title> |
@@ -369,7 +365,7 @@ | |||
369 | <entry>Name</entry> | 365 | <entry>Name</entry> |
370 | 366 | ||
371 | <entry> | 367 | <entry> |
372 | <literal>Device1</literal> | 368 | <literal>device1</literal> |
373 | </entry> | 369 | </entry> |
374 | </row> | 370 | </row> |
375 | 371 | ||
@@ -407,8 +403,9 @@ | |||
407 | </listitem> | 403 | </listitem> |
408 | 404 | ||
409 | <listitem> | 405 | <listitem> |
410 | <para>Prepare the infrastructure configuration for device1 in the | 406 | <para>Prepare the infrastructure configuration for |
411 | data store: <literal>Applications</literal> -> <literal>Offline | 407 | <literal>device1</literal> in the data store: |
408 | <literal>Applications</literal> -> <literal>Offline | ||
412 | Config</literal> -> <select "device1" data store> -> | 409 | Config</literal> -> <select "device1" data store> -> |
413 | <literal>Config App...</literal>. This window layout is very similar | 410 | <literal>Config App...</literal>. This window layout is very similar |
414 | to the Configuration window of a device.</para> | 411 | to the Configuration window of a device.</para> |
@@ -422,10 +419,9 @@ | |||
422 | 419 | ||
423 | <listitem> | 420 | <listitem> |
424 | <para><emphasis role="bold">Configure the host | 421 | <para><emphasis role="bold">Configure the host |
425 | interface(s):</emphasis> select the device -> | 422 | interface(s):</emphasis> <literal>OpenVSwitch</literal> -> |
426 | <literal>Configuration</literal> -> | 423 | <literal>Host Interfaces</literal> -> |
427 | <literal>OpenVSwitch</literal> -> <literal>Host | 424 | <literal>Add</literal>.</para> |
428 | Interfaces</literal> -> <literal>Add</literal>.</para> | ||
429 | 425 | ||
430 | <para>Use the following values to fill the required fields:</para> | 426 | <para>Use the following values to fill the required fields:</para> |
431 | 427 | ||
@@ -459,8 +455,7 @@ | |||
459 | </listitem> | 455 | </listitem> |
460 | 456 | ||
461 | <listitem> | 457 | <listitem> |
462 | <para><emphasis role="bold">Configure the bridges</emphasis>: select | 458 | <para><emphasis role="bold">Configure the bridges</emphasis>: |
463 | the device -> <literal>Configuration</literal> -> | ||
464 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> | 459 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> |
465 | -> <literal>Add</literal>.</para> | 460 | -> <literal>Add</literal>.</para> |
466 | 461 | ||
@@ -594,7 +589,7 @@ | |||
594 | <entry>Name</entry> | 589 | <entry>Name</entry> |
595 | 590 | ||
596 | <entry> | 591 | <entry> |
597 | <literal>Device2</literal> | 592 | <literal>device2</literal> |
598 | </entry> | 593 | </entry> |
599 | </row> | 594 | </row> |
600 | 595 | ||
@@ -632,8 +627,9 @@ | |||
632 | </listitem> | 627 | </listitem> |
633 | 628 | ||
634 | <listitem> | 629 | <listitem> |
635 | <para>Prepare the infrastructure configuration for device2 in the | 630 | <para>Prepare the infrastructure configuration for |
636 | data store: <literal>Applications</literal> -> <literal>Offline | 631 | <literal>device2</literal> in the data store: |
632 | <literal>Applications</literal> -> <literal>Offline | ||
637 | Config</literal> -> <select "device2" data store> -> | 633 | Config</literal> -> <select "device2" data store> -> |
638 | <literal>Config App...</literal>. This window layout is very similar | 634 | <literal>Config App...</literal>. This window layout is very similar |
639 | to the Configuration window of a device.</para> | 635 | to the Configuration window of a device.</para> |
@@ -647,10 +643,9 @@ | |||
647 | 643 | ||
648 | <listitem> | 644 | <listitem> |
649 | <para><emphasis role="bold">Configure the host | 645 | <para><emphasis role="bold">Configure the host |
650 | interface(s):</emphasis> select the device -> | 646 | interface(s):</emphasis><literal> OpenVSwitch</literal> -> |
651 | <literal>Configuration</literal> -> | 647 | <literal>Host Interfaces</literal> -> |
652 | <literal>OpenVSwitch</literal> -> <literal>Host | 648 | <literal>Add</literal>.</para> |
653 | Interfaces</literal> -> <literal>Add</literal>.</para> | ||
654 | 649 | ||
655 | <para>Use the following values to fill the required fields:</para> | 650 | <para>Use the following values to fill the required fields:</para> |
656 | 651 | ||
@@ -684,8 +679,7 @@ | |||
684 | </listitem> | 679 | </listitem> |
685 | 680 | ||
686 | <listitem> | 681 | <listitem> |
687 | <para><emphasis role="bold">Configure the bridges</emphasis>: select | 682 | <para><emphasis role="bold">Configure the bridges</emphasis>: |
688 | the device -> <literal>Configuration</literal> -> | ||
689 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> | 683 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal> |
690 | -> <literal>Add</literal>.</para> | 684 | -> <literal>Add</literal>.</para> |
691 | 685 | ||
@@ -798,10 +792,9 @@ | |||
798 | <section id="upload_offline_config"> | 792 | <section id="upload_offline_config"> |
799 | <title>Uploading the offline Configuration</title> | 793 | <title>Uploading the offline Configuration</title> |
800 | 794 | ||
801 | <para>In this context and example setup, which uses ZTP, the offline | 795 | <para>The offline configuration can be uploaded and applied on a uCPE |
802 | configuration can be uploaded and applied on a uCPE device only once. If | 796 | device only once. If the setup needs to be rerun on a device where ZTP |
803 | the setup needs to be rerun on a device where ZTP was already used, | 797 | was already used, please do the following:</para> |
804 | please do the following:</para> | ||
805 | 798 | ||
806 | <orderedlist spacing="compact"> | 799 | <orderedlist spacing="compact"> |
807 | <listitem> | 800 | <listitem> |
@@ -1045,12 +1038,11 @@ | |||
1045 | <filename>flexiWAN_cloudinit.iso</filename>.</para> | 1038 | <filename>flexiWAN_cloudinit.iso</filename>.</para> |
1046 | 1039 | ||
1047 | <note> | 1040 | <note> |
1048 | <para>Example image provided. Please see the Appendix for details on | 1041 | <para>Example cloud-init image provided. Please see the Appendix for |
1049 | how to change the configuration and create a new cloud-init iso | 1042 | details on how to generate a new cloud-init image with a different |
1050 | image.</para> | 1043 | token. Please contact flexiWAN in order to get a valid token and |
1044 | access to the flexiWAN manager.</para> | ||
1051 | </note> | 1045 | </note> |
1052 | |||
1053 | <para>Click <literal>Domain Update Script</literal>.</para> | ||
1054 | </listitem> | 1046 | </listitem> |
1055 | 1047 | ||
1056 | <listitem> | 1048 | <listitem> |
@@ -1074,8 +1066,8 @@ | |||
1074 | <para><emphasis role="bold">ID:</emphasis> | 1066 | <para><emphasis role="bold">ID:</emphasis> |
1075 | <literal>lan</literal>.</para> | 1067 | <literal>lan</literal>.</para> |
1076 | 1068 | ||
1077 | <para><emphasis role="bold">Type:</emphasis> <literal>dpdk</literal> | 1069 | <para><emphasis role="bold">Type:</emphasis> |
1078 | tap.</para> | 1070 | <literal>tap</literal>.</para> |
1079 | 1071 | ||
1080 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | 1072 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: |
1081 | <literal>sfc_br</literal>.</para> | 1073 | <literal>sfc_br</literal>.</para> |
@@ -1120,8 +1112,6 @@ | |||
1120 | <listitem> | 1112 | <listitem> |
1121 | <para><emphasis role="bold">Cloud Init File:</emphasis> | 1113 | <para><emphasis role="bold">Cloud Init File:</emphasis> |
1122 | <filename>pfsense_192_168_1_1.iso</filename>.</para> | 1114 | <filename>pfsense_192_168_1_1.iso</filename>.</para> |
1123 | |||
1124 | <para>Click <literal>Domain Update Script</literal>.</para> | ||
1125 | </listitem> | 1115 | </listitem> |
1126 | 1116 | ||
1127 | <listitem> | 1117 | <listitem> |
@@ -1208,12 +1198,11 @@ | |||
1208 | <filename>flexiWAN_cloudinit.iso</filename>.</para> | 1198 | <filename>flexiWAN_cloudinit.iso</filename>.</para> |
1209 | 1199 | ||
1210 | <note> | 1200 | <note> |
1211 | <para>Example image provided. Please see the Appendix for details on | 1201 | <para>Example cloud-init image provided. Please see the Appendix for |
1212 | how to change the configuration and create a new cloud-init iso | 1202 | details on how to generate a new cloud-init image with a different |
1213 | image.</para> | 1203 | token. Please contact flexiWAN in order to get a valid token and |
1204 | access to the flexiWAN manager.</para> | ||
1214 | </note> | 1205 | </note> |
1215 | |||
1216 | <para>Click <literal>Domain Update Script</literal>.</para> | ||
1217 | </listitem> | 1206 | </listitem> |
1218 | 1207 | ||
1219 | <listitem> | 1208 | <listitem> |
@@ -1283,8 +1272,6 @@ | |||
1283 | <listitem> | 1272 | <listitem> |
1284 | <para><emphasis role="bold">Cloud Init File:</emphasis> | 1273 | <para><emphasis role="bold">Cloud Init File:</emphasis> |
1285 | <filename>pfsense_192_168_2_1.iso</filename>.</para> | 1274 | <filename>pfsense_192_168_2_1.iso</filename>.</para> |
1286 | |||
1287 | <para>Click <literal>Domain Update Script</literal>.</para> | ||
1288 | </listitem> | 1275 | </listitem> |
1289 | 1276 | ||
1290 | <listitem> | 1277 | <listitem> |
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml index 78bf5ed..6a129e8 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml | |||
@@ -2,8 +2,8 @@ | |||
2 | <chapter id="setup_cleanup"> | 2 | <chapter id="setup_cleanup"> |
3 | <title>Setup Clean-up</title> | 3 | <title>Setup Clean-up</title> |
4 | 4 | ||
5 | <para>In order to remove the setup created in the previous chapter all | 5 | <para>In order to remove the setup all components need to be deleted in |
6 | components need to be deleted in reverse order:</para> | 6 | reverse order:</para> |
7 | 7 | ||
8 | <orderedlist spacing="compact"> | 8 | <orderedlist spacing="compact"> |
9 | <listitem> | 9 | <listitem> |
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml index 85ea1f4..02d71d2 100644 --- a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml | |||
@@ -13,11 +13,7 @@ | |||
13 | 13 | ||
14 | <listitem> | 14 | <listitem> |
15 | <para>Connect to: <literal>https://<publicIP>:60002</literal> with | 15 | <para>Connect to: <literal>https://<publicIP>:60002</literal> with |
16 | the username: admin and the password: pfsense. | 16 | the username: admin and the password: pfsense.</para> |
17 | <note> | ||
18 | <para>Please make sure the WAN interface of each device has access | ||
19 | to the internet.</para> | ||
20 | </note></para> | ||
21 | </listitem> | 17 | </listitem> |
22 | </orderedlist> | 18 | </orderedlist> |
23 | 19 | ||
@@ -30,9 +26,10 @@ | |||
30 | </listitem> | 26 | </listitem> |
31 | 27 | ||
32 | <listitem> | 28 | <listitem> |
33 | <para>Check for a dynamic IP. The pfSense LAN interface is configured with a DHCP server and should provide an IP 192.168.1/2.XXX: | 29 | <para>Check for a dynamic IP. The pfSense LAN interface is configured |
34 | 30 | with a DHCP server and should receive an IP from the corresponding | |
35 | <programlisting>> dhclient eth1 | 31 | subnet (uCPE device1 has 192.168.1.XXX, while uCPE device2 has |
32 | 192.168.2.XXX).<programlisting>> dhclient eth1 | ||
36 | > ping 192.168.2.1</programlisting></para> | 33 | > ping 192.168.2.1</programlisting></para> |
37 | </listitem> | 34 | </listitem> |
38 | </orderedlist> | 35 | </orderedlist> |