diff options
author | mrpa <mrpa@enea.se> | 2019-12-16 19:40:47 +0100 |
---|---|---|
committer | Miruna Paun <mrpa@enea.se> | 2019-12-18 12:36:03 +0100 |
commit | 8e4e38a49c7fade81ed4b388ef8a03d1f08bb758 (patch) | |
tree | 77c92b6cd40c5921baca5beb9f0921cf21831399 | |
parent | 4055355e13b2e64d2b9319261794e963e556418a (diff) | |
download | el_releases-nfv-access-8e4e38a49c7fade81ed4b388ef8a03d1f08bb758.tar.gz |
Created the Evalkit 2.2.1 manual.
Change-Id: I55d787020fa4e073efb5452cfe0523aa81d7882e
15 files changed, 2245 insertions, 1 deletions
diff --git a/doc/Makefile b/doc/Makefile index dc5b36b..33ade18 100644 --- a/doc/Makefile +++ b/doc/Makefile | |||
@@ -50,7 +50,7 @@ DOCBOOK_TO_BOOKDIR ?= yes | |||
50 | DOCBOOK_CLEANTMP ?= yes | 50 | DOCBOOK_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 |
53 | COMPONENTS := book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-cmc-example-usecases 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-system-test-specification | 53 | COMPONENTS := book-enea-nfv-access-auto-fw-th-user-guide book-enea-nfv-access-cmc-example-usecases 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-system-test-specification book-enea-nfv-access-evalkit-2.2.1 |
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-evalkit-2.2.1/doc/appendix_1.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml new file mode 100644 index 0000000..a952493 --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/appendix_1.xml | |||
@@ -0,0 +1,25 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <appendix id="appendix_1"> | ||
3 | <title>How to create a flexiwan cloud-init iso image (day-0 | ||
4 | configuration)</title> | ||
5 | |||
6 | <para>Prerequisites: </para> | ||
7 | |||
8 | <itemizedlist> | ||
9 | <listitem> | ||
10 | <para>Development host with Linux shell.</para> | ||
11 | </listitem> | ||
12 | |||
13 | <listitem> | ||
14 | <para>The <literal>genisoimage</literal> tool installed.</para> | ||
15 | </listitem> | ||
16 | </itemizedlist> | ||
17 | |||
18 | <para>Please unpack the | ||
19 | <filename>flexiwan/flexiwan-cloud-init-example.tar.gz</filename> and check | ||
20 | the README file for more details:<programlisting>tar -zxf flexiwant-cloud-init-example.tar.gz | ||
21 | cd flexiwan/cloud-init-example/ </programlisting></para> | ||
22 | |||
23 | <para>To generate the cloud-init iso image run the following script: | ||
24 | <programlisting>create_cloudinit.sh</programlisting></para> | ||
25 | </appendix> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/book.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/book.xml new file mode 100644 index 0000000..cebae0c --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/book.xml | |||
@@ -0,0 +1,38 @@ | |||
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_evalkit_2.2.1"> | ||
7 | <title><trademark class="registered">Enea</trademark> NFV Access EvalKit Manual</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="introduction.xml" | ||
19 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
20 | |||
21 | <xi:include href="prerequisites.xml" | ||
22 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
23 | |||
24 | <xi:include href="branch_to_branch_connection.xml" | ||
25 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
26 | |||
27 | <xi:include href="validating_setup.xml" | ||
28 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
29 | |||
30 | <xi:include href="setup_cleanup.xml" | ||
31 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
32 | |||
33 | <xi:include href="run_example_uc_auto_fm.xml" | ||
34 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
35 | |||
36 | <xi:include href="appendix_1.xml" | ||
37 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
38 | </book> | ||
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/branch_to_branch_connection.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/branch_to_branch_connection.xml new file mode 100644 index 0000000..3dec671 --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/branch_to_branch_connection.xml | |||
@@ -0,0 +1,1107 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="branch_to_branch_conn"> | ||
3 | <title>Branch to Branch Connection</title> | ||
4 | |||
5 | <para>The setup detailed in this chapter covers the onboarding and | ||
6 | instantiation of two VNFs on a uCPE device and connecting the networks | ||
7 | between them<remark>Is this accurate?</remark>. The FlexiWAN and pfSense | ||
8 | VNFs are connected through a service chain in this case.</para> | ||
9 | |||
10 | <para>The FlexiWAN SD-WAN and the pfSense virtual router service chain | ||
11 | connection setup is shown graphically below.<figure> | ||
12 | <title>Branch to Branch Connection Overview</title> | ||
13 | |||
14 | <mediaobject> | ||
15 | <imageobject> | ||
16 | <imagedata align="center" contentwidth="600" | ||
17 | fileref="images/br_to_br_conn_setup.png" /> | ||
18 | </imageobject> | ||
19 | </mediaobject> | ||
20 | </figure>This overview contains representations the | ||
21 | following:<itemizedlist> | ||
22 | <listitem> | ||
23 | <para>1 in-band mgmt port for device management.</para> | ||
24 | </listitem> | ||
25 | |||
26 | <listitem> | ||
27 | <para>1 in-band mgmt port for pfSense.</para> | ||
28 | </listitem> | ||
29 | |||
30 | <listitem> | ||
31 | <para>1 WAN interface for FlexiWAN.</para> | ||
32 | </listitem> | ||
33 | |||
34 | <listitem> | ||
35 | <para>1 LAN facing interface for pfSense.</para> | ||
36 | </listitem> | ||
37 | |||
38 | <listitem> | ||
39 | <para>1 WAN facing interface for pfSense.</para> | ||
40 | </listitem> | ||
41 | |||
42 | <listitem> | ||
43 | <para>1 service chain (SFC Bridged interface) to sit between the | ||
44 | FlexiWAN and pfSense VNFs.</para> | ||
45 | </listitem> | ||
46 | </itemizedlist></para> | ||
47 | |||
48 | <section id="ucpe_mg_evalkit221"> | ||
49 | <title>The uCPE Manager</title> | ||
50 | |||
51 | <para>To begin, a device must be added within the uCPE Manager:</para> | ||
52 | |||
53 | <orderedlist> | ||
54 | <listitem> | ||
55 | <para>Log into the uCPE manager with the username and password | ||
56 | "admin".</para> | ||
57 | </listitem> | ||
58 | |||
59 | <listitem> | ||
60 | <para>Add a uCPE device into uCPE Manager: <literal>Devices -> | ||
61 | Manage -> Add</literal>.</para> | ||
62 | |||
63 | <para>Use the following values to fill the required fields:</para> | ||
64 | |||
65 | <table> | ||
66 | <title></title> | ||
67 | |||
68 | <tgroup cols="2"> | ||
69 | <tbody> | ||
70 | <row> | ||
71 | <entry>Type</entry> | ||
72 | |||
73 | <entry>Enea universal CPE</entry> | ||
74 | </row> | ||
75 | |||
76 | <row> | ||
77 | <entry>Release</entry> | ||
78 | |||
79 | <entry>1.0</entry> | ||
80 | </row> | ||
81 | |||
82 | <row> | ||
83 | <entry>Name</entry> | ||
84 | |||
85 | <entry>Ucpe1</entry> | ||
86 | </row> | ||
87 | |||
88 | <row> | ||
89 | <entry>IP/DNS Address</entry> | ||
90 | |||
91 | <entry>Dynamic IP received by the device from the DHCP server | ||
92 | (E.g.: 172.24.12.74).</entry> | ||
93 | </row> | ||
94 | |||
95 | <row> | ||
96 | <entry>Description</entry> | ||
97 | |||
98 | <entry>ucpe device site 1</entry> | ||
99 | </row> | ||
100 | |||
101 | <row> | ||
102 | <entry>SSH</entry> | ||
103 | |||
104 | <entry>Port 830</entry> | ||
105 | </row> | ||
106 | |||
107 | <row> | ||
108 | <entry>SSH User Name</entry> | ||
109 | |||
110 | <entry>root</entry> | ||
111 | </row> | ||
112 | |||
113 | <row> | ||
114 | <entry>Password</entry> | ||
115 | |||
116 | <entry></entry> | ||
117 | </row> | ||
118 | |||
119 | <row> | ||
120 | <entry>OK</entry> | ||
121 | |||
122 | <entry><itemizedlist> | ||
123 | <listitem> | ||
124 | <para>Green status indicates connection with target was | ||
125 | established.</para> | ||
126 | </listitem> | ||
127 | |||
128 | <listitem> | ||
129 | <para>In order to add a device on the map: Right-Click | ||
130 | on the <literal>Map -> Place Device -> | ||
131 | ucpe1</literal></para> | ||
132 | </listitem> | ||
133 | </itemizedlist></entry> | ||
134 | </row> | ||
135 | </tbody> | ||
136 | </tgroup> | ||
137 | </table> | ||
138 | </listitem> | ||
139 | </orderedlist> | ||
140 | </section> | ||
141 | |||
142 | <section id="flexiwan_vnf"> | ||
143 | <title>Onboarding the FlexiWAN VNF</title> | ||
144 | |||
145 | <para>After adding a device in the uCPE Manager, a VNF must be onboarded: | ||
146 | <literal>VNF -> Descriptors -> On-board -> VM | ||
147 | Image</literal>.</para> | ||
148 | |||
149 | <para>Use the following values to fill the required fields:</para> | ||
150 | |||
151 | <table> | ||
152 | <tgroup cols="2"> | ||
153 | <tbody> | ||
154 | <row> | ||
155 | <entry>VM image file</entry> | ||
156 | |||
157 | <entry> | ||
158 | <literal>flexiwan.qcow2</literal> | ||
159 | </entry> | ||
160 | </row> | ||
161 | |||
162 | <row> | ||
163 | <entry>Image format</entry> | ||
164 | |||
165 | <entry>QCOW2</entry> | ||
166 | </row> | ||
167 | |||
168 | <row> | ||
169 | <entry>VNF Type Name</entry> | ||
170 | |||
171 | <entry>flexiWAN</entry> | ||
172 | </row> | ||
173 | |||
174 | <row> | ||
175 | <entry>Description</entry> | ||
176 | |||
177 | <entry>Flexiwan VNF</entry> | ||
178 | </row> | ||
179 | |||
180 | <row> | ||
181 | <entry>Version</entry> | ||
182 | |||
183 | <entry>1.0</entry> | ||
184 | </row> | ||
185 | |||
186 | <row> | ||
187 | <entry>Memory in MB</entry> | ||
188 | |||
189 | <entry>4096 - More memory can be allocated if required.</entry> | ||
190 | </row> | ||
191 | |||
192 | <row> | ||
193 | <entry>Num of CPUs</entry> | ||
194 | |||
195 | <entry>2. More CPUs can be reserved if required and | ||
196 | available.</entry> | ||
197 | </row> | ||
198 | |||
199 | <row> | ||
200 | <entry>Interfaces to add:</entry> | ||
201 | |||
202 | <entry>wan and lan</entry> | ||
203 | </row> | ||
204 | |||
205 | <row> | ||
206 | <entry>Cloud Init -> Cloud-Init Datasource</entry> | ||
207 | |||
208 | <entry>ISO</entry> | ||
209 | </row> | ||
210 | |||
211 | <row> | ||
212 | <entry>Cloud Init -> Cloud-Init Disk Type</entry> | ||
213 | |||
214 | <entry>cdrom</entry> | ||
215 | </row> | ||
216 | |||
217 | <row> | ||
218 | <entry>Onboard</entry> | ||
219 | |||
220 | <entry>Wait for the message: "VNF package onboarded successfully" | ||
221 | then close the pop-up.</entry> | ||
222 | </row> | ||
223 | </tbody> | ||
224 | </tgroup> | ||
225 | </table> | ||
226 | </section> | ||
227 | |||
228 | <section id="pfsense_vnf"> | ||
229 | <title>Onboarding the pfSense VNF</title> | ||
230 | |||
231 | <para>After onboarding the first VNF, follow the same steps to add the | ||
232 | second: <literal>VNF -> Descriptors -> On-board -> VM | ||
233 | Image</literal>.</para> | ||
234 | |||
235 | <para>Use the following values to fill the required fields:</para> | ||
236 | |||
237 | <table> | ||
238 | <tgroup cols="2"> | ||
239 | <tbody> | ||
240 | <row> | ||
241 | <entry>VM image file</entry> | ||
242 | |||
243 | <entry> | ||
244 | <literal>pfSense.qcow2</literal> | ||
245 | </entry> | ||
246 | </row> | ||
247 | |||
248 | <row> | ||
249 | <entry>Image format</entry> | ||
250 | |||
251 | <entry>QCOW2</entry> | ||
252 | </row> | ||
253 | |||
254 | <row> | ||
255 | <entry>VNF Type Name</entry> | ||
256 | |||
257 | <entry>pfSense</entry> | ||
258 | </row> | ||
259 | |||
260 | <row> | ||
261 | <entry>Description</entry> | ||
262 | |||
263 | <entry>pfSense VNF</entry> | ||
264 | </row> | ||
265 | |||
266 | <row> | ||
267 | <entry>Version</entry> | ||
268 | |||
269 | <entry>1.0</entry> | ||
270 | </row> | ||
271 | |||
272 | <row> | ||
273 | <entry>Memory in MB</entry> | ||
274 | |||
275 | <entry>1024</entry> | ||
276 | </row> | ||
277 | |||
278 | <row> | ||
279 | <entry>Num of CPUs</entry> | ||
280 | |||
281 | <entry>1</entry> | ||
282 | </row> | ||
283 | |||
284 | <row> | ||
285 | <entry>Interfaces to add:</entry> | ||
286 | |||
287 | <entry>wan, lan and mgmt.</entry> | ||
288 | </row> | ||
289 | |||
290 | <row> | ||
291 | <entry>Cloud Init -> Cloud-Init Datasource</entry> | ||
292 | |||
293 | <entry>ISO</entry> | ||
294 | </row> | ||
295 | |||
296 | <row> | ||
297 | <entry>Cloud Init -> Cloud-Init Disk Type</entry> | ||
298 | |||
299 | <entry>cdrom</entry> | ||
300 | </row> | ||
301 | |||
302 | <row> | ||
303 | <entry>Properties to add:</entry> | ||
304 | |||
305 | <entry> | ||
306 | <itemizedlist> | ||
307 | <listitem> | ||
308 | <para>Name: <literal>vnfMgmtIpAddress</literal>. Value: | ||
309 | 10.0.0.3<superscript>1</superscript></para> | ||
310 | </listitem> | ||
311 | |||
312 | <listitem> | ||
313 | <para>Name: <literal>internalMgmtPort</literal>. Value: | ||
314 | 443<superscript>2</superscript></para> | ||
315 | </listitem> | ||
316 | |||
317 | <listitem> | ||
318 | <para>Name: <literal>externalMgmtPort</literal>. Value: | ||
319 | 60002<superscript>3</superscript></para> | ||
320 | </listitem> | ||
321 | </itemizedlist> | ||
322 | </entry> | ||
323 | </row> | ||
324 | |||
325 | <row> | ||
326 | <entry>Onboard</entry> | ||
327 | |||
328 | <entry>Wait for the message: "VNF package onboarded successfully" | ||
329 | then close the pop-up.</entry> | ||
330 | </row> | ||
331 | </tbody> | ||
332 | </tgroup> | ||
333 | </table> | ||
334 | |||
335 | <para>Please note the following:</para> | ||
336 | |||
337 | <itemizedlist> | ||
338 | <listitem> | ||
339 | <para><superscript>1</superscript>vnfMgmtIpAddress (10.0.0.3) | ||
340 | represents the IP address of the management interface of the Fortigate | ||
341 | VNF. Changing this value requires an update of the Fortigate | ||
342 | configuration to match with new IP address.</para> | ||
343 | </listitem> | ||
344 | |||
345 | <listitem> | ||
346 | <para><superscript>2</superscript>HTTPS access (443) can be changed to | ||
347 | another type of access. Please consult the official Fortigate | ||
348 | documentation for more details and make sure the Fortigate VNF is | ||
349 | configured to accept another type of connection before changing the | ||
350 | port number.</para> | ||
351 | </listitem> | ||
352 | |||
353 | <listitem> | ||
354 | <para><superscript>3</superscript>externalMgmtPort (60002) represents | ||
355 | the external port on which a user can access the VNF management | ||
356 | interface from a web browser. The user can select another port if | ||
357 | needed. There are no other changes required or components affected by | ||
358 | this change.</para> | ||
359 | </listitem> | ||
360 | </itemizedlist> | ||
361 | </section> | ||
362 | |||
363 | <section id="config_infrastruc_site1"> | ||
364 | <title>Configuring the infrastructure for the uCPE device installed on | ||
365 | site1</title> | ||
366 | |||
367 | <orderedlist> | ||
368 | <listitem> | ||
369 | <para>Select the ucpe1 device: <literal>Configuration -> | ||
370 | OpenVSwitch -> Host Interfaces -> Add</literal>.</para> | ||
371 | |||
372 | <para>Use the following values to fill the required fields:</para> | ||
373 | |||
374 | <itemizedlist> | ||
375 | <listitem> | ||
376 | <para><emphasis role="bold">Source</emphasis>: | ||
377 | <literal>enp4s0f1</literal>. <note> | ||
378 | <para>This is just an example interface. The user must select | ||
379 | the interface needed for use with the LAN connection.</para> | ||
380 | </note></para> | ||
381 | </listitem> | ||
382 | |||
383 | <listitem> | ||
384 | <para><emphasis role="bold">Type</emphasis>: dpdk | ||
385 | (standard).</para> | ||
386 | </listitem> | ||
387 | |||
388 | <listitem> | ||
389 | <para><emphasis role="bold">networking-type</emphasis>: | ||
390 | dpdk.</para> | ||
391 | </listitem> | ||
392 | |||
393 | <listitem> | ||
394 | <para><emphasis role="bold">dpdk-type</emphasis>: vfio-pci.</para> | ||
395 | </listitem> | ||
396 | </itemizedlist> | ||
397 | |||
398 | <para>Click <literal>Create</literal>, and the | ||
399 | <literal>enp4s0f1</literal> interface will be ready to use in a bridge | ||
400 | (LAN).</para> | ||
401 | </listitem> | ||
402 | |||
403 | <listitem> | ||
404 | <para>Select the ucpe1 device: <literal>Configuration -> | ||
405 | OpenVSwitch -> Bridges -> Add</literal>.</para> | ||
406 | |||
407 | <para>Use the following values to fill the required fields for the | ||
408 | four bridges that need to be created:<itemizedlist> | ||
409 | <listitem> | ||
410 | <para><literal>ibm_br</literal>:</para> | ||
411 | |||
412 | <itemizedlist> | ||
413 | <listitem> | ||
414 | <para><emphasis role="bold">id</emphasis>: <autogenerated | ||
415 | - do not change>.</para> | ||
416 | </listitem> | ||
417 | |||
418 | <listitem> | ||
419 | <para><emphasis role="bold">Name</emphasis>: | ||
420 | <literal>ibm_br</literal>.</para> | ||
421 | </listitem> | ||
422 | |||
423 | <listitem> | ||
424 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: | ||
425 | <literal>inbandMgmt</literal>.</para> | ||
426 | </listitem> | ||
427 | |||
428 | <listitem> | ||
429 | <para><emphasis role="bold">mgmt-address</emphasis>: Provide | ||
430 | the IPv4 address of the uCPE Manager machine (E.g. | ||
431 | 172.24.3.109).</para> | ||
432 | </listitem> | ||
433 | |||
434 | <listitem> | ||
435 | <para><emphasis role="bold">mgmt-port</emphasis>: | ||
436 | 830.</para> | ||
437 | </listitem> | ||
438 | </itemizedlist> | ||
439 | |||
440 | <para>Click <literal>Create</literal>.</para> | ||
441 | </listitem> | ||
442 | |||
443 | <listitem> | ||
444 | <para><literal>vnf_mgmt_br</literal>:</para> | ||
445 | |||
446 | <itemizedlist> | ||
447 | <listitem> | ||
448 | <para><emphasis role="bold">id</emphasis>: <autogenerated | ||
449 | - do not change>.</para> | ||
450 | </listitem> | ||
451 | |||
452 | <listitem> | ||
453 | <para><emphasis role="bold">Name</emphasis>: | ||
454 | <literal>vnf_mgmt_br</literal>.</para> | ||
455 | </listitem> | ||
456 | |||
457 | <listitem> | ||
458 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: | ||
459 | <literal>vnfMgmt</literal>.</para> | ||
460 | </listitem> | ||
461 | |||
462 | <listitem> | ||
463 | <para><emphasis role="bold">vnf-mgmt-address</emphasis>: | ||
464 | 10.0.0.1</para> | ||
465 | </listitem> | ||
466 | </itemizedlist> | ||
467 | |||
468 | <para>Click <literal>Create</literal>.</para> | ||
469 | </listitem> | ||
470 | |||
471 | <listitem> | ||
472 | <para><literal>sfc_br</literal>:</para> | ||
473 | |||
474 | <itemizedlist> | ||
475 | <listitem> | ||
476 | <para><emphasis role="bold">id</emphasis>: <autogenerated | ||
477 | - do not change>.</para> | ||
478 | </listitem> | ||
479 | |||
480 | <listitem> | ||
481 | <para><emphasis role="bold">Name</emphasis>: | ||
482 | <literal>sfc_br</literal>.</para> | ||
483 | </listitem> | ||
484 | |||
485 | <listitem> | ||
486 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: | ||
487 | <literal>dataPlane</literal>.</para> | ||
488 | </listitem> | ||
489 | |||
490 | <listitem> | ||
491 | <para><emphasis role="bold">Sub-type</emphasis>: | ||
492 | integration.</para> | ||
493 | </listitem> | ||
494 | </itemizedlist> | ||
495 | |||
496 | <para>Click <literal>Create</literal>.</para> | ||
497 | </listitem> | ||
498 | |||
499 | <listitem> | ||
500 | <para><literal>lan_br</literal>:</para> | ||
501 | |||
502 | <itemizedlist> | ||
503 | <listitem> | ||
504 | <para><emphasis role="bold">id</emphasis>: <autogenerated | ||
505 | - do not change>.</para> | ||
506 | </listitem> | ||
507 | |||
508 | <listitem> | ||
509 | <para><emphasis role="bold">Name</emphasis>: | ||
510 | <literal>lan_br</literal>.</para> | ||
511 | </listitem> | ||
512 | |||
513 | <listitem> | ||
514 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: | ||
515 | <literal>dataPlane</literal>.</para> | ||
516 | </listitem> | ||
517 | |||
518 | <listitem> | ||
519 | <para><emphasis role="bold">Sub-type</emphasis>: | ||
520 | communication. Name: <literal>enp4s0f1</literal></para> | ||
521 | </listitem> | ||
522 | </itemizedlist> | ||
523 | |||
524 | <para>Click <literal>Create</literal>.</para> | ||
525 | </listitem> | ||
526 | </itemizedlist></para> | ||
527 | </listitem> | ||
528 | |||
529 | <listitem> | ||
530 | <para>Instantiate the FlexiWAN VNF by selecting the ucpe1 device, then | ||
531 | the VNF menu -> <literal>Instances</literal> -> | ||
532 | <literal>Add</literal>. </para> | ||
533 | |||
534 | <para>Use the following values to fill the required fields:</para> | ||
535 | |||
536 | <itemizedlist> | ||
537 | <listitem> | ||
538 | <para><emphasis role="bold">Name:</emphasis> | ||
539 | <literal>Flexiwan_ucpe1</literal>.</para> | ||
540 | </listitem> | ||
541 | |||
542 | <listitem> | ||
543 | <para><emphasis role="bold">VNF Type:</emphasis> | ||
544 | <literal>flexiWAN</literal>.</para> | ||
545 | </listitem> | ||
546 | |||
547 | <listitem> | ||
548 | <para><emphasis role="bold">VNFD Version:</emphasis> 1.0.</para> | ||
549 | </listitem> | ||
550 | |||
551 | <listitem> | ||
552 | <para><emphasis role="bold">Flavour:</emphasis> Canonical.</para> | ||
553 | </listitem> | ||
554 | |||
555 | <listitem> | ||
556 | <para><emphasis role="bold">uCPE Device:</emphasis> Ucpe1.</para> | ||
557 | </listitem> | ||
558 | |||
559 | <listitem> | ||
560 | <para><emphasis role="bold">Cloud Init File:</emphasis> | ||
561 | <filename>flexiWAN1_cloudinit.iso</filename>.</para> | ||
562 | |||
563 | <note> | ||
564 | <para>Example image provided. Please see the Appendix for | ||
565 | details on how to change the configuration and create a new | ||
566 | cloud-init iso image.</para> | ||
567 | </note> | ||
568 | |||
569 | <para>Click <literal>Domain Update Script</literal>.</para> | ||
570 | </listitem> | ||
571 | |||
572 | <listitem> | ||
573 | <para>Create the <literal>wan</literal> Interface: </para> | ||
574 | |||
575 | <para><emphasis role="bold">ID:</emphasis> | ||
576 | <literal>wan</literal>.</para> | ||
577 | |||
578 | <para><emphasis role="bold">Type:</emphasis> | ||
579 | <literal>dpdk</literal> tap.</para> | ||
580 | |||
581 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
582 | <literal>ibm_br</literal>.</para> | ||
583 | |||
584 | <para>Click <literal>Create</literal>.</para> | ||
585 | </listitem> | ||
586 | |||
587 | <listitem> | ||
588 | <para>Create the <literal>lan</literal> Interface: </para> | ||
589 | |||
590 | <para><emphasis role="bold">ID:</emphasis> | ||
591 | <literal>lan</literal>.</para> | ||
592 | |||
593 | <para><emphasis role="bold">Type:</emphasis> | ||
594 | <literal>dpdk</literal> tap.</para> | ||
595 | |||
596 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
597 | <literal>sfc_br</literal>.</para> | ||
598 | |||
599 | <para>Click <literal>Create</literal>.</para> | ||
600 | </listitem> | ||
601 | </itemizedlist> | ||
602 | </listitem> | ||
603 | |||
604 | <listitem> | ||
605 | <para>Instantiate the pfSense VNF by selecting the | ||
606 | <literal>me1100</literal> device, then the VNF menu -> | ||
607 | <literal>Instances</literal> -> <literal>Add</literal>.</para> | ||
608 | |||
609 | <para>Use the following values to fill the required fields:</para> | ||
610 | |||
611 | <itemizedlist> | ||
612 | <listitem> | ||
613 | <para><emphasis role="bold">Name:</emphasis> | ||
614 | <literal>Pfsense_ucpe1</literal>.</para> | ||
615 | </listitem> | ||
616 | |||
617 | <listitem> | ||
618 | <para><emphasis role="bold">VNF Type:</emphasis> | ||
619 | <literal>pfSense</literal>.</para> | ||
620 | </listitem> | ||
621 | |||
622 | <listitem> | ||
623 | <para><emphasis role="bold">VNFD Version:</emphasis> 1.0.</para> | ||
624 | </listitem> | ||
625 | |||
626 | <listitem> | ||
627 | <para><emphasis role="bold">Flavour:</emphasis> Canonical.</para> | ||
628 | </listitem> | ||
629 | |||
630 | <listitem> | ||
631 | <para><emphasis role="bold">uCPE Device:</emphasis> Ucpe1.</para> | ||
632 | </listitem> | ||
633 | |||
634 | <listitem> | ||
635 | <para><emphasis role="bold">Cloud Init File:</emphasis> | ||
636 | <filename>pfsense_192_168_1_1.iso</filename>.</para> | ||
637 | |||
638 | <para>Click <literal>Domain Update Script</literal>.</para> | ||
639 | </listitem> | ||
640 | |||
641 | <listitem> | ||
642 | <para>Create the <literal>wan</literal> Interface:</para> | ||
643 | |||
644 | <para><emphasis role="bold">ID:</emphasis> | ||
645 | <literal>wan</literal>.</para> | ||
646 | |||
647 | <para><emphasis role="bold">Type:</emphasis> | ||
648 | <literal>dpdk</literal> tap.</para> | ||
649 | |||
650 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
651 | <literal>sfc_br</literal>.</para> | ||
652 | |||
653 | <para>Click <literal>Create</literal>.</para> | ||
654 | </listitem> | ||
655 | |||
656 | <listitem> | ||
657 | <para>Create the <literal>lan</literal> Interface:</para> | ||
658 | |||
659 | <para><emphasis role="bold">ID:</emphasis> | ||
660 | <literal>lan</literal>.</para> | ||
661 | |||
662 | <para><emphasis role="bold">Type:</emphasis> | ||
663 | <literal>dpdk</literal> tap.</para> | ||
664 | |||
665 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
666 | <literal>lan_br</literal>.</para> | ||
667 | |||
668 | <para>Click <literal>Create</literal>.</para> | ||
669 | </listitem> | ||
670 | |||
671 | <listitem> | ||
672 | <para>Create the <literal>mgmt</literal> Interface:</para> | ||
673 | |||
674 | <para><emphasis role="bold">ID:</emphasis> | ||
675 | <literal>mgmt</literal>.</para> | ||
676 | |||
677 | <para><emphasis role="bold">Type:</emphasis> | ||
678 | <literal>dpdk</literal> tap.</para> | ||
679 | |||
680 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
681 | <literal>vnf_mgmt_br</literal>.</para> | ||
682 | |||
683 | <para>Click <literal>Create</literal>.</para> | ||
684 | </listitem> | ||
685 | </itemizedlist> | ||
686 | </listitem> | ||
687 | </orderedlist> | ||
688 | </section> | ||
689 | |||
690 | <section id="config_infrastruc_site2"> | ||
691 | <title>Configuring the infrastructure for the uCPE device installed on | ||
692 | site2</title> | ||
693 | |||
694 | <orderedlist> | ||
695 | <listitem> | ||
696 | <para>Select the ucpe2 device: <literal>Configuration -> | ||
697 | OpenVSwitch -> Host Interfaces -> Add</literal>.</para> | ||
698 | |||
699 | <para>Use the following values to fill the required fields:</para> | ||
700 | |||
701 | <itemizedlist> | ||
702 | <listitem> | ||
703 | <para><emphasis role="bold">Source</emphasis>: | ||
704 | <literal>enp4s0f1</literal>. <note> | ||
705 | <para>This is just an example interface. The user must select | ||
706 | the interface needed for use with the LAN connection.</para> | ||
707 | </note></para> | ||
708 | </listitem> | ||
709 | |||
710 | <listitem> | ||
711 | <para><emphasis role="bold">Type</emphasis>: dpdk | ||
712 | (standard).</para> | ||
713 | </listitem> | ||
714 | |||
715 | <listitem> | ||
716 | <para><emphasis role="bold">networking-type</emphasis>: | ||
717 | dpdk.</para> | ||
718 | </listitem> | ||
719 | |||
720 | <listitem> | ||
721 | <para><emphasis role="bold">dpdk-type</emphasis>: vfio-pci.</para> | ||
722 | </listitem> | ||
723 | </itemizedlist> | ||
724 | |||
725 | <para>Click <literal>Create</literal>, and the | ||
726 | <literal>enp4s0f1</literal> interface will be ready to use in a bridge | ||
727 | (LAN).</para> | ||
728 | </listitem> | ||
729 | |||
730 | <listitem> | ||
731 | <para>Select the ucpe2 device: <literal>Configuration -> | ||
732 | OpenVSwitch -> Bridges -> Add</literal>.</para> | ||
733 | |||
734 | <para>Use the following values to fill the required fields for the | ||
735 | four bridges that need to be created:<itemizedlist> | ||
736 | <listitem> | ||
737 | <para><literal>ibm_br</literal>:</para> | ||
738 | |||
739 | <itemizedlist> | ||
740 | <listitem> | ||
741 | <para><emphasis role="bold">id</emphasis>: <autogenerated | ||
742 | - do not change>.</para> | ||
743 | </listitem> | ||
744 | |||
745 | <listitem> | ||
746 | <para><emphasis role="bold">Name</emphasis>: | ||
747 | <literal>ibm_br</literal>.</para> | ||
748 | </listitem> | ||
749 | |||
750 | <listitem> | ||
751 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: | ||
752 | <literal>inbandMgmt</literal>.</para> | ||
753 | </listitem> | ||
754 | |||
755 | <listitem> | ||
756 | <para><emphasis role="bold">mgmt-address</emphasis>: Provide | ||
757 | the IPv4 address of the uCPE Manager machine (E.g. | ||
758 | 172.24.3.109).</para> | ||
759 | </listitem> | ||
760 | |||
761 | <listitem> | ||
762 | <para><emphasis role="bold">mgmt-port</emphasis>: | ||
763 | 830.</para> | ||
764 | </listitem> | ||
765 | </itemizedlist> | ||
766 | |||
767 | <para>Click <literal>Create</literal>.</para> | ||
768 | </listitem> | ||
769 | |||
770 | <listitem> | ||
771 | <para><literal>vnf_mgmt_br</literal>:</para> | ||
772 | |||
773 | <itemizedlist> | ||
774 | <listitem> | ||
775 | <para><emphasis role="bold">id</emphasis>: <autogenerated | ||
776 | - do not change>.</para> | ||
777 | </listitem> | ||
778 | |||
779 | <listitem> | ||
780 | <para><emphasis role="bold">Name</emphasis>: | ||
781 | <literal>vnf_mgmt_br</literal>.</para> | ||
782 | </listitem> | ||
783 | |||
784 | <listitem> | ||
785 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: | ||
786 | <literal>vnfMgmt</literal>.</para> | ||
787 | </listitem> | ||
788 | |||
789 | <listitem> | ||
790 | <para><emphasis role="bold">vnf-mgmt-address</emphasis>: | ||
791 | 10.0.0.1</para> | ||
792 | </listitem> | ||
793 | </itemizedlist> | ||
794 | |||
795 | <para>Click <literal>Create</literal>.</para> | ||
796 | </listitem> | ||
797 | |||
798 | <listitem> | ||
799 | <para><literal>sfc_br</literal>:</para> | ||
800 | |||
801 | <itemizedlist> | ||
802 | <listitem> | ||
803 | <para><emphasis role="bold">id</emphasis>: <autogenerated | ||
804 | - do not change>.</para> | ||
805 | </listitem> | ||
806 | |||
807 | <listitem> | ||
808 | <para><emphasis role="bold">Name</emphasis>: | ||
809 | <literal>sfc_br</literal>.</para> | ||
810 | </listitem> | ||
811 | |||
812 | <listitem> | ||
813 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: | ||
814 | <literal>dataPlane</literal>.</para> | ||
815 | </listitem> | ||
816 | |||
817 | <listitem> | ||
818 | <para><emphasis role="bold">Sub-type</emphasis>: | ||
819 | integration.</para> | ||
820 | </listitem> | ||
821 | </itemizedlist> | ||
822 | |||
823 | <para>Click <literal>Create</literal>.</para> | ||
824 | </listitem> | ||
825 | |||
826 | <listitem> | ||
827 | <para><literal>lan_br</literal>:</para> | ||
828 | |||
829 | <itemizedlist> | ||
830 | <listitem> | ||
831 | <para><emphasis role="bold">id</emphasis>: <autogenerated | ||
832 | - do not change>.</para> | ||
833 | </listitem> | ||
834 | |||
835 | <listitem> | ||
836 | <para><emphasis role="bold">Name</emphasis>: | ||
837 | <literal>lan_br</literal>.</para> | ||
838 | </listitem> | ||
839 | |||
840 | <listitem> | ||
841 | <para><emphasis role="bold">ovs-bridge-type</emphasis>: | ||
842 | <literal>dataPlane</literal>.</para> | ||
843 | </listitem> | ||
844 | |||
845 | <listitem> | ||
846 | <para><emphasis role="bold">Sub-type</emphasis>: | ||
847 | communication. Name: <literal>enp4s0f1</literal></para> | ||
848 | </listitem> | ||
849 | </itemizedlist> | ||
850 | |||
851 | <para>Click <literal>Create</literal>.</para> | ||
852 | </listitem> | ||
853 | </itemizedlist></para> | ||
854 | </listitem> | ||
855 | |||
856 | <listitem> | ||
857 | <para>Instantiate the FlexiWAN VNF by selecting the ucpe2 device, then | ||
858 | the VNF menu -> <literal>Instances</literal> -> | ||
859 | <literal>Add</literal>.</para> | ||
860 | |||
861 | <para>Use the following values to fill the required fields:</para> | ||
862 | |||
863 | <itemizedlist> | ||
864 | <listitem> | ||
865 | <para><emphasis role="bold">Name:</emphasis> | ||
866 | <literal>Flexiwan_ucpe2</literal>.</para> | ||
867 | </listitem> | ||
868 | |||
869 | <listitem> | ||
870 | <para><emphasis role="bold">VNF Type:</emphasis> | ||
871 | <literal>flexiWAN</literal>.</para> | ||
872 | </listitem> | ||
873 | |||
874 | <listitem> | ||
875 | <para><emphasis role="bold">VNFD Version:</emphasis> 1.0.</para> | ||
876 | </listitem> | ||
877 | |||
878 | <listitem> | ||
879 | <para><emphasis role="bold">Flavour:</emphasis> Canonical.</para> | ||
880 | </listitem> | ||
881 | |||
882 | <listitem> | ||
883 | <para><emphasis role="bold">uCPE Device:</emphasis> Ucpe2.</para> | ||
884 | </listitem> | ||
885 | |||
886 | <listitem> | ||
887 | <para><emphasis role="bold">Cloud Init File:</emphasis> | ||
888 | <filename>flexiWAN2_cloudinit.iso</filename>.</para> | ||
889 | |||
890 | <note> | ||
891 | <para>Example image provided. Please see the Appendix for | ||
892 | details on how to change the configuration and create a new | ||
893 | cloud-init iso image.</para> | ||
894 | </note> | ||
895 | |||
896 | <para>Click <literal>Domain Update Script</literal>.</para> | ||
897 | </listitem> | ||
898 | |||
899 | <listitem> | ||
900 | <para>Create the <literal>wan</literal> Interface:</para> | ||
901 | |||
902 | <para><emphasis role="bold">ID:</emphasis> | ||
903 | <literal>wan</literal>.</para> | ||
904 | |||
905 | <para><emphasis role="bold">Type:</emphasis> | ||
906 | <literal>dpdk</literal> tap.</para> | ||
907 | |||
908 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
909 | <literal>ibm_br</literal>.</para> | ||
910 | |||
911 | <para>Click <literal>Create</literal>.</para> | ||
912 | </listitem> | ||
913 | |||
914 | <listitem> | ||
915 | <para>Create the <literal>lan</literal> Interface:</para> | ||
916 | |||
917 | <para><emphasis role="bold">ID:</emphasis> | ||
918 | <literal>lan</literal>.</para> | ||
919 | |||
920 | <para><emphasis role="bold">Type:</emphasis> | ||
921 | <literal>dpdk</literal> tap.</para> | ||
922 | |||
923 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
924 | <literal>sfc_br</literal>.</para> | ||
925 | |||
926 | <para>Click <literal>Create</literal>.</para> | ||
927 | </listitem> | ||
928 | </itemizedlist> | ||
929 | </listitem> | ||
930 | |||
931 | <listitem> | ||
932 | <para>Instantiate the pfSense VNF by selecting the | ||
933 | <literal>ucpe2</literal> device, then the VNF menu -> | ||
934 | <literal>Instances</literal> -> <literal>Add</literal>.</para> | ||
935 | |||
936 | <para>Use the following values to fill the required fields:</para> | ||
937 | |||
938 | <itemizedlist> | ||
939 | <listitem> | ||
940 | <para><emphasis role="bold">Name:</emphasis> | ||
941 | <literal>Pfsense_ucpe2</literal>.</para> | ||
942 | </listitem> | ||
943 | |||
944 | <listitem> | ||
945 | <para><emphasis role="bold">VNF Type:</emphasis> | ||
946 | <literal>pfSense</literal>.</para> | ||
947 | </listitem> | ||
948 | |||
949 | <listitem> | ||
950 | <para><emphasis role="bold">VNFD Version:</emphasis> 1.0.</para> | ||
951 | </listitem> | ||
952 | |||
953 | <listitem> | ||
954 | <para><emphasis role="bold">Flavour:</emphasis> Canonical.</para> | ||
955 | </listitem> | ||
956 | |||
957 | <listitem> | ||
958 | <para><emphasis role="bold">uCPE Device:</emphasis> Ucpe2.</para> | ||
959 | </listitem> | ||
960 | |||
961 | <listitem> | ||
962 | <para><emphasis role="bold">Cloud Init File:</emphasis> | ||
963 | <filename>pfsense_192_168_2_1.iso</filename>.</para> | ||
964 | |||
965 | <para>Click <literal>Domain Update Script</literal>.</para> | ||
966 | </listitem> | ||
967 | |||
968 | <listitem> | ||
969 | <para>Create the <literal>wan</literal> Interface:</para> | ||
970 | |||
971 | <para><emphasis role="bold">ID:</emphasis> | ||
972 | <literal>wan</literal>.</para> | ||
973 | |||
974 | <para><emphasis role="bold">Type:</emphasis> | ||
975 | <literal>dpdk</literal> tap.</para> | ||
976 | |||
977 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
978 | <literal>sfc_br</literal>.</para> | ||
979 | |||
980 | <para>Click <literal>Create</literal>.</para> | ||
981 | </listitem> | ||
982 | |||
983 | <listitem> | ||
984 | <para>Create the <literal>lan</literal> Interface:</para> | ||
985 | |||
986 | <para><emphasis role="bold">ID:</emphasis> | ||
987 | <literal>lan</literal>.</para> | ||
988 | |||
989 | <para><emphasis role="bold">Type:</emphasis> | ||
990 | <literal>dpdk</literal> tap.</para> | ||
991 | |||
992 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
993 | <literal>lan_br</literal>.</para> | ||
994 | |||
995 | <para>Click <literal>Create</literal>.</para> | ||
996 | </listitem> | ||
997 | |||
998 | <listitem> | ||
999 | <para>Create the <literal>mgmt</literal> Interface:</para> | ||
1000 | |||
1001 | <para><emphasis role="bold">ID:</emphasis> | ||
1002 | <literal>mgmt</literal>.</para> | ||
1003 | |||
1004 | <para><emphasis role="bold">Type:</emphasis> | ||
1005 | <literal>dpdk</literal> tap.</para> | ||
1006 | |||
1007 | <para><emphasis role="bold">IF Name:</emphasis> Bridge: | ||
1008 | <literal>vnf_mgmt_br</literal>.</para> | ||
1009 | |||
1010 | <para>Click <literal>Create</literal>.</para> | ||
1011 | </listitem> | ||
1012 | </itemizedlist> | ||
1013 | </listitem> | ||
1014 | </orderedlist> | ||
1015 | |||
1016 | <figure> | ||
1017 | <title>Overview</title> | ||
1018 | |||
1019 | <mediaobject> | ||
1020 | <imageobject> | ||
1021 | <imagedata align="center" contentwidth="600" | ||
1022 | fileref="images/br_to_br_conn_overview.png" /> | ||
1023 | </imageobject> | ||
1024 | </mediaobject> | ||
1025 | </figure> | ||
1026 | </section> | ||
1027 | |||
1028 | <section id="flexiwan_config"> | ||
1029 | <title>Configuring FlexiWAN</title> | ||
1030 | |||
1031 | <para>Connect to <ulink | ||
1032 | url="https://app.flexiwan.com">https://app.flexiwan.com</ulink> and make | ||
1033 | sure you have an account and at least two valid device tokens. </para> | ||
1034 | |||
1035 | <para>Proceed to the Investory<remark>is this accurate?</remark> menu, | ||
1036 | click on <literal>Devices</literal>, the devices should already be present | ||
1037 | and need to be set. </para> | ||
1038 | |||
1039 | <para><emphasis role="bold">How to set a device</emphasis></para> | ||
1040 | |||
1041 | <orderedlist> | ||
1042 | <listitem> | ||
1043 | <para>Select each device and make sure to set the following | ||
1044 | values:</para> | ||
1045 | |||
1046 | <para><table> | ||
1047 | <tgroup cols="2"> | ||
1048 | <tbody> | ||
1049 | <row> | ||
1050 | <entry>Target1(ucpe1)</entry> | ||
1051 | |||
1052 | <entry>Target1(ucpe2)</entry> | ||
1053 | </row> | ||
1054 | |||
1055 | <row> | ||
1056 | <entry>Device Name: target1</entry> | ||
1057 | |||
1058 | <entry>Device Name: target2</entry> | ||
1059 | </row> | ||
1060 | |||
1061 | <row> | ||
1062 | <entry>Description: Set IPv4 for the second interface | ||
1063 | (ens3): 10.0.1.1/24.</entry> | ||
1064 | |||
1065 | <entry>Description: Set IPv4 for the second interface | ||
1066 | (ens3): 10.0.2.1/24.</entry> | ||
1067 | </row> | ||
1068 | |||
1069 | <row> | ||
1070 | <entry>Set "Approved".</entry> | ||
1071 | |||
1072 | <entry>Set "Approved".</entry> | ||
1073 | </row> | ||
1074 | |||
1075 | <row> | ||
1076 | <entry>Click "Update Device".</entry> | ||
1077 | |||
1078 | <entry>Click "Update Device".</entry> | ||
1079 | </row> | ||
1080 | </tbody> | ||
1081 | </tgroup> | ||
1082 | </table></para> | ||
1083 | </listitem> | ||
1084 | |||
1085 | <listitem> | ||
1086 | <para>Select the option for each device to be put in the "running" | ||
1087 | state. </para> | ||
1088 | </listitem> | ||
1089 | |||
1090 | <listitem> | ||
1091 | <para>Wait for each "vRouter" to enter the running state.</para> | ||
1092 | </listitem> | ||
1093 | |||
1094 | <listitem> | ||
1095 | <para>Select the main top up checkbox in order to select all devices | ||
1096 | and hit "Create Tunnels". At this moment a direct connection should be | ||
1097 | available between those two targets.</para> | ||
1098 | </listitem> | ||
1099 | </orderedlist> | ||
1100 | |||
1101 | <note> | ||
1102 | <para>For the pfSense VNF there is no need for manual configuration. The | ||
1103 | configuration provided into the cloud init image is good enough to run | ||
1104 | the setup.</para> | ||
1105 | </note> | ||
1106 | </section> | ||
1107 | </chapter> \ 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 new file mode 100644 index 0000000..eaa7ebd --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/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 | <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 new file mode 100644 index 0000000..bb969c6 --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/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 | ||
26 | sudo apt-get -y update | ||
27 | sudo 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 | ||
37 | curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
38 | chmod a+x ~/bin/repo | ||
39 | export 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.1</phrase></para> | ||
48 | |||
49 | <para id="Yocto_NAME"><phrase>krogoth</phrase></para> | ||
50 | |||
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> | ||
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 | ||
62 | cd enea-linux | ||
63 | repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ | ||
64 | -b refs/tags/EL6 -m $MACHINE/default.xml | ||
65 | repo 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-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 new file mode 100755 index 0000000..62e5d02 --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/eltf_params_updated_template_how_to_use.txt | |||
@@ -0,0 +1,320 @@ | |||
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 new file mode 100755 index 0000000..977de0f --- /dev/null +++ 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 new file mode 100755 index 0000000..feb18a3 --- /dev/null +++ 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 new file mode 100644 index 0000000..c294a77 --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/introduction.xml | |||
@@ -0,0 +1,72 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="intro_evalkit221"> | ||
3 | <title>Introduction</title> | ||
4 | |||
5 | <para>Enea NFV Access for the universal Customer Premise Equipment (uCPE) is | ||
6 | a virtualization and management platform, which allows end-users to | ||
7 | introduce, instantiate, and run third-party VNFs onto their systems.</para> | ||
8 | |||
9 | <para>The solution is comprised of two major components working in close | ||
10 | cooperation:</para> | ||
11 | |||
12 | <itemizedlist> | ||
13 | <listitem> | ||
14 | <para>The Enea NFV Access Run-Time Platform, which acts as the host for | ||
15 | Virtualized Network Functions (VNFs) and provides management over | ||
16 | NETCONF.</para> | ||
17 | </listitem> | ||
18 | |||
19 | <listitem> | ||
20 | <para>The Enea uCPE Manager, a solution that runs on an external server, | ||
21 | providing VNF Management functionality and managing large numbers of | ||
22 | uCPEs.</para> | ||
23 | </listitem> | ||
24 | </itemizedlist> | ||
25 | |||
26 | <para>The current Enea NFV Access solution provides a working and deployable | ||
27 | configuration as an example for branch-to-branch connection setup using the | ||
28 | flexiWAN and pfSense VNFs service chained together on a uCPE device. </para> | ||
29 | |||
30 | <para>This document will present all information required to replicate the | ||
31 | use cases described therein in the user's environment. The first part of | ||
32 | this manual uses the GUI mode of the uCPE Manager to detail the steps in | ||
33 | order to reproduce the use cases, while the chapters thereafter use the | ||
34 | automation framework.</para> | ||
35 | |||
36 | <note> | ||
37 | <para>All VNF configurations should be seen as example configurations | ||
38 | working in Enea internal lab and the user must update these files with the | ||
39 | configuration data needed according to his network setup. Particularities | ||
40 | are described in Appendix A.</para> | ||
41 | |||
42 | <para>This is document assumes the user is familiar with ENFV Access and | ||
43 | has read the Enea NFV Access Getting Started manual before continuing with | ||
44 | the following.</para> | ||
45 | </note> | ||
46 | |||
47 | <section id="def_acro_evalkit221"> | ||
48 | <title>Definitions and Acronyms</title> | ||
49 | |||
50 | <section> | ||
51 | <title>uCPE Manager</title> | ||
52 | |||
53 | <para>The Enea uCPE Manager is an EMS/NMS platform that provides the VNF | ||
54 | Management capabilities for NFV Access devices. The uCPE Manager can be | ||
55 | deployed on a Linux (CentOS) based physical or virtual server. | ||
56 | Co-resident with the uCPE Manager is additional functionality, which | ||
57 | includes the Automation Framework.</para> | ||
58 | </section> | ||
59 | |||
60 | <section> | ||
61 | <title>Automation Framework</title> | ||
62 | |||
63 | <para>The Automation Framework consists of a set of tooling and a | ||
64 | collection of Python based scripts that can be used to automate the | ||
65 | process of onboarding a VNF with all of the required configuration for | ||
66 | day zero deployment at scale. </para> | ||
67 | |||
68 | <para>This tooling calls the auto generated REST API that's exposed on | ||
69 | the uCPE Manager as a north bound interface.</para> | ||
70 | </section> | ||
71 | </section> | ||
72 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/doc/prerequisites.xml b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/prerequisites.xml new file mode 100644 index 0000000..1b348ee --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/prerequisites.xml | |||
@@ -0,0 +1,103 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="prereq_evalkit221"> | ||
3 | <title>Prerequisites</title> | ||
4 | |||
5 | <section id="prereq_table"> | ||
6 | <title>Prerequisites</title> | ||
7 | |||
8 | <table> | ||
9 | <title> Required Elements </title> | ||
10 | |||
11 | <tgroup cols="2"> | ||
12 | <colspec align="left" /> | ||
13 | |||
14 | <thead> | ||
15 | <row> | ||
16 | <entry align="center">Prerequisites</entry> | ||
17 | |||
18 | <entry align="center">Observations</entry> | ||
19 | </row> | ||
20 | </thead> | ||
21 | |||
22 | <tbody> | ||
23 | <row> | ||
24 | <entry>uCPE device<itemizedlist> | ||
25 | <listitem> | ||
26 | <para>Processor Xeon-D/atom-C3000</para> | ||
27 | </listitem> | ||
28 | |||
29 | <listitem> | ||
30 | <para>2 x network interfaces</para> | ||
31 | </listitem> | ||
32 | |||
33 | <listitem> | ||
34 | <para>SSD storage</para> | ||
35 | </listitem> | ||
36 | |||
37 | <listitem> | ||
38 | <para>8GB RAM</para> | ||
39 | </listitem> | ||
40 | </itemizedlist></entry> | ||
41 | |||
42 | <entry><itemizedlist> | ||
43 | <listitem> | ||
44 | <para>This is an example hardware configuration available in | ||
45 | the Enea Lab.</para> | ||
46 | </listitem> | ||
47 | |||
48 | <listitem> | ||
49 | <para>One of the SFP ports is connected to a network with | ||
50 | DHCP server access (receiving a dynamic IP based on | ||
51 | MAC).</para> | ||
52 | </listitem> | ||
53 | |||
54 | <listitem> | ||
55 | <para>The device has network access to the uCPE | ||
56 | Manager.</para> | ||
57 | </listitem> | ||
58 | |||
59 | <listitem> | ||
60 | <para>NFV Access is installed on the device. Please see the | ||
61 | <emphasis>Enea NFV Access Getting Started</emphasis> Manual, | ||
62 | chapter "Enea NFV Access Installer" for more details.</para> | ||
63 | </listitem> | ||
64 | </itemizedlist></entry> | ||
65 | </row> | ||
66 | |||
67 | <row> | ||
68 | <entry>Management machine - Linux based (CentOS)</entry> | ||
69 | |||
70 | <entry><itemizedlist> | ||
71 | <listitem> | ||
72 | <para>The uCPE Manager is installed on this host or virtual | ||
73 | machine. Pease see the <emphasis>Enea NFV Access Getting | ||
74 | Started</emphasis> Manual, chapter "Getting Started with | ||
75 | Enea uCPE Manager" for more details.</para> | ||
76 | </listitem> | ||
77 | |||
78 | <listitem> | ||
79 | <para>The uCPE Manager must have access to the me1100 | ||
80 | target.</para> | ||
81 | </listitem> | ||
82 | |||
83 | <listitem> | ||
84 | <para>A web browser will access the management interface of | ||
85 | the VNFs. Management interfaces of the VNF can be accessed | ||
86 | from any machine connected on the same network with the | ||
87 | me1100 target.</para> | ||
88 | </listitem> | ||
89 | </itemizedlist></entry> | ||
90 | </row> | ||
91 | </tbody> | ||
92 | </tgroup> | ||
93 | </table> | ||
94 | </section> | ||
95 | |||
96 | <section id="rel_struc_evalkit221"> | ||
97 | <title>Release structure</title> | ||
98 | |||
99 | <para></para> | ||
100 | |||
101 | <programlisting></programlisting> | ||
102 | </section> | ||
103 | </chapter> \ No newline at end of file | ||
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 new file mode 100644 index 0000000..455ac1f --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/run_example_uc_auto_fm.xml | |||
@@ -0,0 +1,41 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="run_example_uc_auto_fm"> | ||
3 | <title>Running Example Use-cases from the Automation Framework</title> | ||
4 | |||
5 | <section id="setup_ucpe1"> | ||
6 | <title>Setup on ucpe1</title> | ||
7 | |||
8 | <para><emphasis role="bold">How to Deploy fexiwan and pfsense VNFs on | ||
9 | ucpe1</emphasis></para> | ||
10 | |||
11 | <programlisting>> cd automation_and_systemtest/automation_framework/unittestSuite | ||
12 | > python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> \ | ||
13 | -n ucpe1 -s flexiwan_pfsense_ucpe1.json -d "ucpe1 Deployment"</programlisting> | ||
14 | |||
15 | <para><emphasis role="bold">Clean-up:</emphasis></para> | ||
16 | |||
17 | <programlisting>> python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> \ | ||
18 | -n ucpe1 -s ucpe1Cleanup.json -d "ucpe1 Clean-up"</programlisting> | ||
19 | </section> | ||
20 | |||
21 | <section id="setup_ucpe2"> | ||
22 | <title>Setup on ucpe2</title> | ||
23 | |||
24 | <para><emphasis role="bold">How Deploy fexiwan and pfsense VNFs on | ||
25 | ucpe2</emphasis></para> | ||
26 | |||
27 | <programlisting>> cd automation_and_systemtest/automation_framework/unittestSuite | ||
28 | > python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> \ | ||
29 | -n ucpe2 -s flexiwan_pfsense_ucpe2.json -d "ucpe2 Deployment"</programlisting> | ||
30 | |||
31 | <para><emphasis role="bold">Clean-up:</emphasis></para> | ||
32 | |||
33 | <programlisting>> python unittestSuite.py -u admin -p admin -H <uCPE_Manager_IP> \ | ||
34 | -n ucpe1 -s ucpe1Cleanup.json -d "ucpe1 Clean-up"</programlisting> | ||
35 | |||
36 | <note> | ||
37 | <para>Please replace <uCPE_Manager_IP> with IP address of uCPE | ||
38 | Manager machine.</para> | ||
39 | </note> | ||
40 | </section> | ||
41 | </chapter> \ No newline at end of file | ||
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 new file mode 100644 index 0000000..0261844 --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/setup_cleanup.xml | |||
@@ -0,0 +1,54 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="setup_cleanup"> | ||
3 | <title>Setup Clean-up</title> | ||
4 | |||
5 | <para>In order to remove the setup created in the previous chapter all | ||
6 | components need to be deleted in reverse order:</para> | ||
7 | |||
8 | <orderedlist> | ||
9 | <listitem> | ||
10 | <para>Select the ucpe1 target, access the <emphasis>VNF</emphasis> menu | ||
11 | then <literal>Instances FlexiWAN and pfSense</literal> and press | ||
12 | Delete.</para> | ||
13 | </listitem> | ||
14 | |||
15 | <listitem> | ||
16 | <para>Select the ucpe1 target, access the | ||
17 | <emphasis>Configuration</emphasis> menu, then | ||
18 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal>. Select | ||
19 | all bridges and press Delete.</para> | ||
20 | </listitem> | ||
21 | |||
22 | <listitem> | ||
23 | <para>Select the ucpe1 target, access the | ||
24 | <emphasis>Configuration</emphasis> menu, then | ||
25 | <literal>OpenVSwitch</literal> -> <literal>Host Interfaces</literal>. | ||
26 | Select all interfaces and press Delete.</para> | ||
27 | </listitem> | ||
28 | |||
29 | <listitem> | ||
30 | <para>Select the ucpe2 target, access the <emphasis>VNF</emphasis> menu | ||
31 | then <literal>Instances FlexiWAN and pfSense</literal> and press | ||
32 | Delete.</para> | ||
33 | </listitem> | ||
34 | |||
35 | <listitem> | ||
36 | <para>Select the ucpe2 target, access the | ||
37 | <emphasis>Configuration</emphasis> menu, then | ||
38 | <literal>OpenVSwitch</literal> -> <literal>Bridges</literal>. Select | ||
39 | all bridges and press Delete.</para> | ||
40 | </listitem> | ||
41 | |||
42 | <listitem> | ||
43 | <para>Select the ucpe2 target, access the | ||
44 | <emphasis>Configuration</emphasis> menu, then | ||
45 | <literal>OpenVSwitch</literal> -> <literal>Host Interfaces</literal>. | ||
46 | Select all interfaces and press Delete.</para> | ||
47 | </listitem> | ||
48 | |||
49 | <listitem> | ||
50 | <para>Access the <emphasis>VNF</emphasis> menu, select | ||
51 | <literal>Descriptors</literal>. Select all bundles press Delete.</para> | ||
52 | </listitem> | ||
53 | </orderedlist> | ||
54 | </chapter> \ No newline at end of file | ||
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 new file mode 100644 index 0000000..fa3b07e --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/doc/validating_setup.xml | |||
@@ -0,0 +1,37 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="validating_setup"> | ||
3 | <title>Validating the Setup</title> | ||
4 | |||
5 | <para><emphasis role="bold">In order to access the web interfaces of the | ||
6 | pfSense VNF:</emphasis></para> | ||
7 | |||
8 | <orderedlist> | ||
9 | <listitem> | ||
10 | <para>Open a browser on a machine connected on the same network with the | ||
11 | WAN port of the uCPE device.</para> | ||
12 | </listitem> | ||
13 | |||
14 | <listitem> | ||
15 | <para>Connect to: <literal>https://<publicIP>:60002</literal> with | ||
16 | the username: admin and the password: pfsense.<note> | ||
17 | <para>Please make sure the WAN interface of each device has access | ||
18 | to the internet.</para> | ||
19 | </note></para> | ||
20 | </listitem> | ||
21 | </orderedlist> | ||
22 | |||
23 | <para><emphasis role="bold">In order to validate the data | ||
24 | path:</emphasis></para> | ||
25 | |||
26 | <orderedlist> | ||
27 | <listitem> | ||
28 | <para>Connect a test machine to the LAN physical port.</para> | ||
29 | </listitem> | ||
30 | |||
31 | <listitem> | ||
32 | <para>Check for a dynamic IP. The pfSense LAN interface is configured | ||
33 | with a DHCP server:<programlisting>> dhclient eth1 | ||
34 | > ping 192.168.2.1</programlisting></para> | ||
35 | </listitem> | ||
36 | </orderedlist> | ||
37 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-evalkit-2.2.1/swcomp.mk b/doc/book-enea-nfv-access-evalkit-2.2.1/swcomp.mk new file mode 100755 index 0000000..70f0766 --- /dev/null +++ b/doc/book-enea-nfv-access-evalkit-2.2.1/swcomp.mk | |||
@@ -0,0 +1,10 @@ | |||
1 | # Component build specification | ||
2 | |||
3 | # Version of THIS book | ||
4 | BOOK_VER ?= $(REL_VER)-dev | ||
5 | |||
6 | DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) | ||
7 | |||
8 | BOOKPACKAGES := book-enea-nfv-access-evalkit-2.2.1 | ||
9 | BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Access $(PROD_VER) for CMC Networks Example Use-cases" | ||
10 | BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) | ||