summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
diff options
context:
space:
mode:
authorSona Sarmadi <sona.sarmadi@enea.com>2019-10-07 13:43:34 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2019-10-11 15:12:53 +0200
commitc809d907776503d4bdae0056a78ebb4d8840d559 (patch)
tree22aac1ec36f5503217b3e47f36b79e412b858753 /doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
parenta5ce1952613df9f1286c2be8cfe81b625b7b7bbf (diff)
downloadel_releases-nfv-access-c809d907776503d4bdae0056a78ebb4d8840d559.tar.gz
ExampleUsecases: Update Example Usecases
- Update Example Usecases manual each chapter. - Add "uCPE system requirements" for all examples, specify number of physical NICs, RAM and cores (not vCPUs!) - Remove all figures - Remove all tables - Remove In-band Management example usecase Change-Id: Id183ba0cd1e9fca370d992273d797faadfcf9e3b Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
Diffstat (limited to 'doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml')
-rw-r--r--doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml127
1 files changed, 62 insertions, 65 deletions
diff --git a/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml b/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
index db4525a..806430a 100644
--- a/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
+++ b/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
@@ -8,29 +8,47 @@
8 <section id="prere_clav_vnf"> 8 <section id="prere_clav_vnf">
9 <title>Prerequisites</title> 9 <title>Prerequisites</title>
10 10
11 <para>The following files provided with your Enea NFV Access release are 11 <para>System requirements for the uCPE devices:</para>
12 needed for this example use case: <remark>FIXME - These filenames may need
13 to be updated</remark></para>
14 12
15 <itemizedlist> 13 <itemizedlist>
16 <listitem> 14 <listitem>
17 <para><literal>enea-nfv-access-vnf-qemux86-64.wic.qcow2</literal></para> 15 <para>1 Network Interface</para>
18 </listitem> 16 </listitem>
19 17
20 <listitem> 18 <listitem>
21 <para><literal>clavister-cos-stream-&lt;version&gt;-virtual-x64-generic.qcow2</literal></para> 19 <para>2 GB of RAM memory</para>
22 </listitem> 20 </listitem>
21 </itemizedlist>
22
23 <para>The following files are needed for this example use case:</para>
24
25 <itemizedlist>
26 <para>VNF images:</para>
27
28 <listitem>
29 <para>Enea Test VNF. Please contact Enea to get this image.</para>
30 </listitem>
31
32 <listitem>
33 <para>Clavister VNF. Please contact Clavister to get this
34 image.</para>
35 </listitem>
36 </itemizedlist>
37
38 <itemizedlist>
39 <para>VNF Configuration files, these files are provided with your Enea
40 NFV Access release:</para>
23 41
24 <listitem> 42 <listitem>
25 <para><literal>clavister-cloudinit.conf</literal></para> 43 <para><filename>clavister-cloudinit.conf</filename>. </para>
26 </listitem> 44 </listitem>
27 45
28 <listitem> 46 <listitem>
29 <para><literal>enea-vnf-iperf-client.conf</literal></para> 47 <para><filename>enea-vnf-iperf-client.conf</filename>.</para>
30 </listitem> 48 </listitem>
31 49
32 <listitem> 50 <listitem>
33 <para><literal>enea-vnf-iperf-server.conf</literal></para> 51 <para><filename>enea-vnf-iperf-server.conf</filename>.</para>
34 </listitem> 52 </listitem>
35 </itemizedlist> 53 </itemizedlist>
36 </section> 54 </section>
@@ -39,22 +57,9 @@
39 <title>Clavister VNF using an Open vSwitch Bridge</title> 57 <title>Clavister VNF using an Open vSwitch Bridge</title>
40 58
41 <para>In this use-case, uCPE device 1 runs the Clavister VNF, while uCPE 59 <para>In this use-case, uCPE device 1 runs the Clavister VNF, while uCPE
42 device 2 runs two Enea NFV Access VNFs with iPerf client and server 60 device 2 runs two Enea Test VNFs with iPerf client and server
43 applications. The uCPE devices are connected using OVS-DPDK bridges. 61 applications. The uCPE devices are connected using OVS-DPDK
44 </para> 62 bridges.</para>
45
46 <remark>FIXME: New image needed</remark>
47
48 <figure condition="hidden">
49 <title>Clavister VNF using Open vSwitch Bridge Overview</title>
50
51 <mediaobject>
52 <imageobject>
53 <imagedata align="center" fileref="images/clavister_vnf_diagram.png"
54 scale="50" />
55 </imageobject>
56 </mediaobject>
57 </figure>
58 63
59 <section id="clav_vnf_setup_1"> 64 <section id="clav_vnf_setup_1">
60 <title>Use-case Setup</title> 65 <title>Use-case Setup</title>
@@ -63,8 +68,9 @@
63 68
64 <orderedlist> 69 <orderedlist>
65 <listitem> 70 <listitem>
66 <para>Select uCPE device 1, access <literal>Configuration</literal>, add the network 71 <para>Select uCPE device 1, access <literal>Configuration</literal>,
67 interface that will be used and configure it for DPDK.</para> 72 add the network interface that will be used and configure it for
73 DPDK.</para>
68 </listitem> 74 </listitem>
69 75
70 <listitem> 76 <listitem>
@@ -81,8 +87,8 @@
81 87
82 <orderedlist> 88 <orderedlist>
83 <listitem> 89 <listitem>
84 <para>Onboard the Clavister VNF by filling the required fields with the following 90 <para>Onboard the Clavister VNF by filling the required fields with
85 values:</para> 91 the following values:</para>
86 92
87 <itemizedlist spacing="compact"> 93 <itemizedlist spacing="compact">
88 <listitem> 94 <listitem>
@@ -120,11 +126,11 @@
120 </listitem> 126 </listitem>
121 127
122 <listitem> 128 <listitem>
123 <para>Onboard the Enea VNF by filling the required fields with the following values: 129 <para>Onboard the Enea Test VNF by filling the required fields with
124 <itemizedlist spacing="compact"> 130 the following values: <itemizedlist spacing="compact">
125 <listitem> 131 <listitem>
126 <para><emphasis role="bold">VM Image File</emphasis>: Provide 132 <para><emphasis role="bold">VM Image File</emphasis>: Provide
127 the path to the Enea NFV Access VNF qcow2 image</para> 133 the path to the Enea Test VNF qcow2 image</para>
128 </listitem> 134 </listitem>
129 135
130 <listitem> 136 <listitem>
@@ -187,16 +193,16 @@
187 </listitem> 193 </listitem>
188 194
189 <listitem> 195 <listitem>
190 <para><emphasis role="bold">Interfaces</emphasis>: Set the interface type 196 <para><emphasis role="bold">Interfaces</emphasis>: Set the
191 to <literal>DPDK</literal> and select the OVS bridge created 197 interface type to <literal>DPDK</literal> and select the OVS
192 above, for both interfaces.</para> 198 bridge created above, for both interfaces.</para>
193 </listitem> 199 </listitem>
194 </itemizedlist> 200 </itemizedlist>
195 </listitem> 201 </listitem>
196 202
197 <listitem> 203 <listitem>
198 <para>Instantiate the Enea iPerf server VNF on uCPE device 2 by filling 204 <para>Instantiate the Enea iPerf server VNF on uCPE device 2 by
199 the required fields with the values below:</para> 205 filling the required fields with the values below:</para>
200 206
201 <itemizedlist spacing="compact"> 207 <itemizedlist spacing="compact">
202 <listitem> 208 <listitem>
@@ -206,7 +212,7 @@
206 212
207 <listitem> 213 <listitem>
208 <para><emphasis role="bold">VNF Type</emphasis>: Select Enea 214 <para><emphasis role="bold">VNF Type</emphasis>: Select Enea
209 NFV Access VNF</para> 215 Test VNF</para>
210 </listitem> 216 </listitem>
211 217
212 <listitem> 218 <listitem>
@@ -221,15 +227,16 @@
221 </listitem> 227 </listitem>
222 228
223 <listitem> 229 <listitem>
224 <para><emphasis role="bold">Interfaces</emphasis>: Set the interface type to 230 <para><emphasis role="bold">Interfaces</emphasis>: Set the
225 <literal>DPDK</literal> and select the OVS bridge created above.</para> 231 interface type to <literal>DPDK</literal> and select the OVS
232 bridge created above.</para>
226 </listitem> 233 </listitem>
227 </itemizedlist> 234 </itemizedlist>
228 </listitem> 235 </listitem>
229 236
230 <listitem> 237 <listitem>
231 <para>Instantiate the Enea iPerf client VNF on uCPE device 2 by 238 <para>Instantiate the Enea iPerf client VNF on uCPE device 2 by
232 filling the required fields with the values below:</para> 239 filling the required fields with the values below:</para>
233 240
234 <itemizedlist spacing="compact"> 241 <itemizedlist spacing="compact">
235 <listitem> 242 <listitem>
@@ -239,7 +246,7 @@
239 246
240 <listitem> 247 <listitem>
241 <para><emphasis role="bold">VNF Type</emphasis>: Select Enea 248 <para><emphasis role="bold">VNF Type</emphasis>: Select Enea
242 NFV Access VNF</para> 249 Test VNF</para>
243 </listitem> 250 </listitem>
244 251
245 <listitem> 252 <listitem>
@@ -254,8 +261,9 @@
254 </listitem> 261 </listitem>
255 262
256 <listitem> 263 <listitem>
257 <para><emphasis role="bold">Interfaces</emphasis>: Set the interface 264 <para><emphasis role="bold">Interfaces</emphasis>: Set the
258 type to <literal>DPDK</literal> and select the OVS bridge created above.</para> 265 interface type to <literal>DPDK</literal> and select the OVS
266 bridge created above.</para>
259 </listitem> 267 </listitem>
260 </itemizedlist> 268 </itemizedlist>
261 </listitem> 269 </listitem>
@@ -282,22 +290,9 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
282 <section id="clav_example_sriov"> 290 <section id="clav_example_sriov">
283 <title>Clavister VNF using SR-IOV</title> 291 <title>Clavister VNF using SR-IOV</title>
284 292
285 <para>The following use-case is essentially the same as the one detailed above, 293 <para>The following use-case is essentially the same as the one detailed
286 in this scenario however, the uCPE devices are connected using SR-IOV, 294 above, in this scenario however, the uCPE devices are connected using
287 with two virtual functions.</para> 295 SR-IOV, with two virtual functions.</para>
288
289 <remark>FIXME: New image needed</remark>
290
291 <figure condition="hidden">
292 <title>Clavister VNF using SR-IOV Overview</title>
293
294 <mediaobject>
295 <imageobject>
296 <imagedata align="center" fileref="images/clav_VNF_demo_SR-IOV.png"
297 scale="60" />
298 </imageobject>
299 </mediaobject>
300 </figure>
301 296
302 <section id="clav_vnf_setup_2"> 297 <section id="clav_vnf_setup_2">
303 <title>Use-case Setup</title> 298 <title>Use-case Setup</title>
@@ -306,9 +301,10 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
306 301
307 <orderedlist> 302 <orderedlist>
308 <listitem> 303 <listitem>
309 <para>Select uCPE device 1, access <literal>Configuration</literal>, 304 <para>Select uCPE device 1, access <literal>Configuration</literal>,
310 add the network interface that will be used and configure it for SR-IOV. 305 add the network interface that will be used and configure it for
311 For <literal>sriov-mode</literal> select "adapter-pool" and "sriov-num-vfs:2".</para> 306 SR-IOV. For <literal>sriov-mode</literal> select "adapter-pool" and
307 "sriov-num-vfs:2".</para>
312 </listitem> 308 </listitem>
313 309
314 <listitem> 310 <listitem>
@@ -323,13 +319,14 @@ root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
323 <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para> 319 <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>
324 320
325 <para>Use the same instantiation parameters as above, but select 321 <para>Use the same instantiation parameters as above, but select
326 interface type <literal>SrIovAdapterPool</literal> instead.</para> 322 interface type <literal>SrIovAdapterPool</literal> instead.</para>
327 </section> 323 </section>
328 324
329 <section id="test_clav_uc_2"> 325 <section id="test_clav_uc_2">
330 <title>Testing the Use-case</title> 326 <title>Testing the Use-case</title>
331 327
332 <para>Use the same test instructions as detailed in the use-case above.</para> 328 <para>Use the same test instructions as detailed in the use-case
329 above.</para>
333 </section> 330 </section>
334 </section> 331 </section>
335</chapter> 332</chapter>