summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-example-usecases/doc/clav_vnf_examples.xml
blob: 1da91fe0cb9fb661af81efa5fb7534e3672f58fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="clav_vnf_example">
  <title>Clavister VNF Example Use-cases</title>

  <para>The Clavister VNF is a telco-ready, carrier-grade virtual next
  generation firewall.</para>

  <section id="clav_vnf">
    <title>Clavister VNF using an Open vSwitch Bridge</title>

    <para>In this use-case, uCPE device 1 runs the Clavister VNF, while uCPE
    device 2 runs two Enea Test VNFs with iPerf client and server
    applications. The uCPE devices are connected using OVS-DPDK
    bridges.</para>

    <section id="prere_clav_vnf">
      <title>Prerequisites</title>

      <para>Two uCPE devices will be required for this setup. The system
      requirements for each uCPE device are:</para>

      <itemizedlist>
        <listitem>
          <para>1 Network Interface</para>
        </listitem>

        <listitem>
          <para>2 GB of RAM memory</para>
        </listitem>
      </itemizedlist>

      <para>The following files are needed for this example use-case:</para>

      <itemizedlist>
        <listitem>
          <para>Enea Test VNF image. Please contact Enea to get this image.</para>
        </listitem>

        <listitem>
          <para>Clavister VNF image. Please contact Clavister to get this
          image.</para>
        </listitem>
        
        <listitem><para>VNF Configuration files. These files are provided with your Enea
        NFV Access release:</para>
        
        <itemizedlist spacing="compact">
          <listitem><para><filename>clavister-cloudinit.conf</filename>.</para></listitem>
          <listitem><para><filename>enea-vnf-iperf-client.conf</filename>.</para></listitem>
          <listitem><para><filename>enea-vnf-iperf-server.conf</filename>.</para></listitem>
          </itemizedlist>
          </listitem>
      </itemizedlist>
    </section>

    <section id="clav_vnf_setup_1">
      <title>Use-case Setup</title>

      <para>In this use-case, uCPE device 1 runs the Clavister VNF, while uCPE
      device 2 runs two Enea Test VNFs with iPerf client and server
      applications. The uCPE devices are connected using OVS-DPDK
      bridges.</para>

      <figure>
          <title>Clavister VNF using an Open vSwitch bridge</title>

          <mediaobject>
            <imageobject>
              <imagedata align="center" contentwidth="600"
                         fileref="images/uc_clavister_bridge.png" />
            </imageobject>
          </mediaobject>
        </figure>
        
       <note>
         <para>When connecting, the uCPE devices can use a back-to-back or a VPN connection. 
           An appropriate interface with the required capabilities needs to be chosen for 
           this purpose.</para>
          </note>
      
      <para><emphasis role="bold">Network Configuration:</emphasis></para>

      <orderedlist>
        <listitem>
          <para>Select uCPE device 1, access <literal>Configuration</literal>,
          add the network interface that will be used and configure it for
          DPDK.</para>
        </listitem>

        <listitem>
          <para>Create an OVS bridge and attach the DPDK network
          interface.</para>
        </listitem>

        <listitem>
          <para>Repeat the steps above for uCPE device 2.</para>
        </listitem>
      </orderedlist>

      <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>

      <orderedlist>
        <listitem>
          <para>Onboard the Clavister VNF by filling the required fields with
          the following values:</para>

          <itemizedlist spacing="compact">
            <listitem>
              <para><emphasis role="bold">VM Image File</emphasis>: Provide
              the path to the Clavister VNF qcow2 image</para>
            </listitem>

            <listitem>
              <para><emphasis role="bold">Memory in MB</emphasis>: 1024</para>
            </listitem>

            <listitem>
              <para><emphasis role="bold">Num of CPUs</emphasis>: 4</para>
            </listitem>

            <listitem>
              <para><emphasis role="bold">Storage in GB</emphasis>: 20</para>
            </listitem>

            <listitem>
              <para><emphasis role="bold">Interfaces</emphasis>: Add 2
              interfaces</para>
            </listitem>

            <listitem>
              <para><emphasis role="bold">Cloud-init Datasource</emphasis>:
              ConfigDrive</para>
            </listitem>

            <listitem>
              <para><emphasis role="bold">Cloud-init Disk Type</emphasis>:
              disk</para>
            </listitem>
          </itemizedlist>
        </listitem>

        <listitem>
          <para>Onboard the Enea Test VNF by filling the required fields with
          the following values: <itemizedlist spacing="compact">
              <listitem>
                <para><emphasis role="bold">VM Image File</emphasis>: Provide
                the path to the Enea Test VNF qcow2 image</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Memory in MB</emphasis>:
                2048</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Num of CPUs</emphasis>: 2</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Storage in GB</emphasis>:
                10</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Interfaces</emphasis>: Add 1
                interface</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Cloud-init Datasource</emphasis>:
                NoCloud</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Cloud-init Disk Type</emphasis>:
                disk</para>
              </listitem>
            </itemizedlist></para>
        </listitem>
      </orderedlist>

      <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>

      <para><orderedlist>
          <listitem>
            <para>Instantiate the Clavister VNF on uCPE device 1 using the
            required fields below:</para>

            <itemizedlist spacing="compact">
              <listitem>
                <para><emphasis role="bold">Name</emphasis>: clavister</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">VNF Type</emphasis>: Select
                Clavister VNF</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">uCPE Device</emphasis>: Select
                uCPE device 1</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Cloud Init File</emphasis>:
                Provide the path to the Clavister cloud-init file.</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Interfaces</emphasis>: Set the
                interface type to <literal>DPDK</literal> and select the OVS
                bridge created above, for both interfaces.</para>
              </listitem>
            </itemizedlist>
          </listitem>

          <listitem>
            <para>Instantiate the Enea iPerf server VNF on uCPE device 2 by
            filling the required fields with the values below:</para>

            <itemizedlist spacing="compact">
              <listitem>
                <para><emphasis role="bold">Name</emphasis>:
                iperf_server</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">VNF Type</emphasis>: Select Enea
                Test VNF</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">uCPE Device</emphasis>: Select
                uCPE device 2</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Cloud Init File</emphasis>:
                Provide the path to the Enea VNF IPerf server cloud-init
                file.</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Interfaces</emphasis>: Set the
                interface type to <literal>DPDK</literal> and select the OVS
                bridge created above.</para>
              </listitem>
            </itemizedlist>
          </listitem>

          <listitem>
            <para>Instantiate the Enea iPerf client VNF on uCPE device 2 by
            filling the required fields with the values below:</para>

            <itemizedlist spacing="compact">
              <listitem>
                <para><emphasis role="bold">Name</emphasis>:
                iperf_client</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">VNF Type</emphasis>: Select Enea
                Test VNF</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">uCPE Device</emphasis>: Select
                uCPE device 2</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Cloud Init File</emphasis>:
                Provide the path to the Enea VNF iPerf client cloud-init
                file.</para>
              </listitem>

              <listitem>
                <para><emphasis role="bold">Interfaces</emphasis>: Set the
                interface type to <literal>DPDK</literal> and select the OVS
                bridge created above.</para>
              </listitem>
            </itemizedlist>
          </listitem>
        </orderedlist></para>
    </section>

    <section id="test_clav_uc_1">
      <title>Testing the Use-case</title>

      <para>SSH to uCPE device 2 (Username: root) and connect to the IPerf
      client VNF console:</para>

      <programlisting>virsh list
virsh console &lt;id of iperf client&gt;</programlisting>

      <para>In order to check that traffic is forwarded between the VNFs, run
      the following:</para>

      <programlisting># qemux86-64 login: root
root@qemux86-64:~# iperf3 -c 192.168.10.10</programlisting>
    </section>
  </section>

  <section id="clav_example_sriov">
    <title>Clavister VNF using SR-IOV</title>

    <section id="prere_clav_vnf_sriov">
      <title>Prerequisites</title>

      <para>Two uCPE devices will be required for this setup. The system
      requirements for each uCPE device are:</para>

      <itemizedlist>
        <listitem>
          <para>1 Network Interface</para>
        </listitem>

        <listitem>
          <para>2 GB of RAM memory</para>
        </listitem>
      </itemizedlist>

      <para>The following files are needed for this example use-case:</para>

      <itemizedlist>
        <listitem>
          <para>Enea Test VNF image. Please contact Enea to get this image.</para>
        </listitem>

        <listitem>
          <para>Clavister VNF image. Please contact Clavister to get this
          image.</para>
        </listitem>
        
        <listitem><para>VNF Configuration files. These files are provided with your Enea
        NFV Access release:</para>
          <itemizedlist spacing="compact">
            <listitem><para><filename>clavister-cloudinit.conf</filename>.</para></listitem>
            <listitem><para><filename>enea-vnf-iperf-client.conf</filename>.</para></listitem>
            <listitem><para><filename>enea-vnf-iperf-server.conf</filename>.</para></listitem>
          </itemizedlist>  
        </listitem>
      </itemizedlist>
    </section>

    <section id="clav_vnf_setup_2">
      <title>Use-case Setup</title>

      <para>The following use-case is essentially the same as the one detailed
      above, in this scenario however, the uCPE devices are connected using
      SR-IOV, with two virtual functions.</para>

      <figure>
        <title>Clavister VNF using SR-IOV</title>

        <mediaobject>
          <imageobject>
            <imagedata align="center" contentwidth="600"
                       fileref="images/uc_clavister_sriov.png" />
          </imageobject>
        </mediaobject>
      </figure>

      <para><emphasis role="bold">Network Configuration:</emphasis></para>

      <orderedlist>
        <listitem>
          <para>Select uCPE device 1, access <literal>Configuration</literal>,
          add the network interface that will be used and configure it for
          SR-IOV. For <literal>sriov-mode</literal> select "adapter-pool" and
          "sriov-num-vfs:2".</para>
        </listitem>

        <listitem>
          <para>Repeat the step above for uCPE device 2.</para>
        </listitem>
      </orderedlist>

      <para><emphasis role="bold">Onboarding the VNFs:</emphasis></para>

      <para>See the onboarding parameters in the use-case above.</para>

      <para><emphasis role="bold">Instantiating the VNFs:</emphasis></para>

      <para>Use the same instantiation parameters as above, but select
      interface type <literal>SrIovAdapterPool</literal> instead.</para>
    </section>

    <section id="test_clav_uc_2">
      <title>Testing the Use-case</title>

      <para>Use the same test instructions as detailed in the use-case
      above.</para>
    </section>
  </section>
</chapter>