summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-vnf-onboarding-guide/doc/instantiation.xml
blob: 90ffb2377d6aaa29b8854b92b8574040f909cbdb (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="instantiation">
  <title>Instantiation</title>

  <para>When a VNF is onboarded and available in the VNF catalog, it can be
  instantiated (deployed) on connected uCPE devices. The instantiation wizard uses
  the configurations provided when the VNF is onboarded, as a template for
  instantiation. Before the instantiation, however, the uCPE device needs
  to be prepared:</para>

  <orderedlist>
    <listitem>
      <para>Physical NICs used with the VNF directly (through SR-IOV or PCI
      Passthrough) or indirectly (through bridges) need to be configured
      (Device-&gt;Configuration-&gt;OpenVSwitch-&gt;Host Interfaces).</para>

      <note>
        <para>Before configuring any physical NICs determine which is used for
        managing the uCPE device. Altering the configuration of a NIC may cause
        connectivity issues.</para>
      </note>
    </listitem>

    <listitem>
      <para>Add any needed bridges, connecting them to the physical NICs
      previously configured or making them integration bridges (without
      physical NIC) for service chaining.</para>
    </listitem>
  </orderedlist>

  <para>Once the physical NICs and bridges are configured, the VNF can be
  instantiated using the Instantiation Wizard.</para>

  <section id="using_wiz">
    <title>Using the Instantiation Wizard</title>

    <orderedlist>
      <listitem>
        <para>Enter the Instantiation Wizard by accessing VNF-&gt;Instances
        and hitting <literal>Add</literal>.</para>
      </listitem>

      <listitem>
        <para>Fill out the following mandatory fields:</para>

        <itemizedlist spacing="compact">
          <listitem>
            <para>Name (a descriptive name).</para>
          </listitem>

          <listitem>
            <para>Device (the uCPE device to instantiate the VNF on).</para>
          </listitem>

          <listitem>
            <para>Networking Configuration:</para>

            <itemizedlist spacing="compact">
              <listitem>
                <para>Connect each configured NIC with a bridge, SR-IOV or PCI
                Passthrough.</para>
              </listitem>

              <listitem>
                <para>Set up each NIC with a driver method (DPDK or
                e1000).</para>
              </listitem>
            </itemizedlist>

            <note>
              <para>All configured NICs must be set up before instantiating a
              VNF. Failure to do so will end in a failed instantiation.</para>
            </note>
          </listitem>
        </itemizedlist>
      </listitem>

      <listitem>
        <para>Add VNF specific configuration by uploading a Cloud-Init file
        (when the Cloud-Init is used).</para>
      </listitem>

      <listitem>
        <para>Add any VNF specific files (e.g license files).</para>
      </listitem>

      <listitem>
        <para>Hit the <literal>Create</literal> button to deploy the VNF.</para>
      </listitem>
    </orderedlist>
  </section>

  <section id="enter_console">
    <title>Entering the VNF Console</title>

    <para>Once the VNF is deployed, the VNF console can be entered using SSH
    and virsh commands. The VNF Console is a typical starting point for
    determining a successful deployment and configuring a VNF beyond Day
    Zero.</para>

    <orderedlist spacing="compact">
      <listitem>
        <para>SSH to the uCPE device from the Enea uCPE Manager
        (Device-&gt;SSH) with default user and password:
        <literal>root</literal>.</para>
      </listitem>

      <listitem>
        <para>In SSH:</para>

        <orderedlist>
          <listitem>
            <para>Use the <command>virsh list</command> command to list all
            running VNFs and to determine the VNF's instance number.</para>
          </listitem>

          <listitem>
            <para>Use the <command>virsh console &lt;instance
            number&gt;</command> command to enter the VNF specific
            console.</para>
          </listitem>
        </orderedlist>
      </listitem>
    </orderedlist>
  </section>
</chapter>