diff options
Diffstat (limited to 'doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml')
-rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml | 102 |
1 files changed, 54 insertions, 48 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml index e8c65eb..fbf7091 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/vnf_mg.xml | |||
@@ -2,17 +2,17 @@ | |||
2 | <chapter id="vnf_mg"> | 2 | <chapter id="vnf_mg"> |
3 | <title>VNF Management</title> | 3 | <title>VNF Management</title> |
4 | 4 | ||
5 | <para>The Enea uCPE Manager is responsible for onboarding, configuring (e.g. | 5 | <para>The Enea Edge Management is responsible for onboarding, configuring |
6 | CloudInit) and ensuring life cycle management of VNFs that are instantiated | 6 | (e.g. CloudInit) and ensuring life cycle management of VNFs that are |
7 | and run on the various uCPE devices.</para> | 7 | instantiated and run on the various uCPE devices.</para> |
8 | 8 | ||
9 | <section id="onboarding_a_vnf"> | 9 | <section id="onboarding_a_vnf"> |
10 | <title>Onboarding a VNF</title> | 10 | <title>Onboarding a VNF</title> |
11 | 11 | ||
12 | <para>The onboarding of a VNF means adding it to the Enea uCPE Manager VNF | 12 | <para>The onboarding of a VNF means adding it to the Enea Edge Management |
13 | Catalogue and preparing it for instantiation (deployment on connected uCPE | 13 | VNF Catalogue and preparing it for instantiation (deployment on connected |
14 | devices). This is accomplished using the Enea uCPE Manager Onboarding | 14 | uCPE devices). This is accomplished using the Enea Edge Management |
15 | graphical user interface.</para> | 15 | Onboarding graphical user interface.</para> |
16 | 16 | ||
17 | <para>Typically, the Getting Started Guide of a VNF, provided by the VNF | 17 | <para>Typically, the Getting Started Guide of a VNF, provided by the VNF |
18 | vendor, contains all necessary information needed to onboard a VNF.</para> | 18 | vendor, contains all necessary information needed to onboard a VNF.</para> |
@@ -35,8 +35,8 @@ | |||
35 | <note> | 35 | <note> |
36 | <para>There are no standard ways of managing VNF licenses, | 36 | <para>There are no standard ways of managing VNF licenses, |
37 | therefore no general guidelines can be provided. One example of | 37 | therefore no general guidelines can be provided. One example of |
38 | license handling that can be employed in the Enea uCPE Manager is | 38 | license handling that can be employed in the Enea Edge Management |
39 | the adding of a license during the Cloud-Init setup.</para> | 39 | is the adding of a license during the Cloud-Init setup.</para> |
40 | </note> | 40 | </note> |
41 | </listitem> | 41 | </listitem> |
42 | 42 | ||
@@ -109,32 +109,35 @@ | |||
109 | </section> | 109 | </section> |
110 | 110 | ||
111 | <section id="onboard_in_ucpemg"> | 111 | <section id="onboard_in_ucpemg"> |
112 | <title>Onboarding into the Enea uCPE Manager</title> | 112 | <title>Onboarding into the Enea Edge Management</title> |
113 | 113 | ||
114 | <para><emphasis role="bold">How to onboard a VNF into the Enea uCPE | 114 | <para><emphasis role="bold">How to onboard a VNF into the Enea Edge |
115 | Manager </emphasis></para> | 115 | Management </emphasis></para> |
116 | 116 | ||
117 | <orderedlist> | 117 | <orderedlist> |
118 | <listitem> | 118 | <listitem> |
119 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> | 119 | <para>Select from the top toolbar <emphasis |
120 | and then <emphasis role="bold">Descriptors</emphasis>.</para> | 120 | role="bold">VNF</emphasis> and then <emphasis |
121 | role="bold">Descriptors</emphasis>.</para> | ||
121 | </listitem> | 122 | </listitem> |
122 | 123 | ||
123 | <listitem> | 124 | <listitem> |
124 | <para>Click the <emphasis role="bold">On-board</emphasis> button.</para> | 125 | <para>Click the <emphasis role="bold">On-board</emphasis> |
126 | button.</para> | ||
125 | </listitem> | 127 | </listitem> |
126 | 128 | ||
127 | <listitem> | 129 | <listitem> |
128 | <para>When prompted by the UI, make sure the <emphasis role="bold">VM | 130 | <para>When prompted by the UI, make sure the <emphasis |
129 | Image</emphasis> radio button at the top of the onboarding screen is | 131 | role="bold">VM Image</emphasis> radio button at the top of the |
130 | selected, it will trigger a popup menu window.</para> | 132 | onboarding screen is selected, it will trigger a popup menu |
133 | window.</para> | ||
131 | </listitem> | 134 | </listitem> |
132 | </orderedlist> | 135 | </orderedlist> |
133 | 136 | ||
134 | <para>This window contains data fields where both necessary and optional | 137 | <para>This window contains data fields where both necessary and optional |
135 | information about the VNF can be supplied. After doing so, press the | 138 | information about the VNF can be supplied. After doing so, press the |
136 | Onboard button, the Enea uCPE Manager will create the VNF descriptor and | 139 | Onboard button, the Enea Edge Management will create the VNF descriptor |
137 | add it to its VNF Catalog.</para> | 140 | and add it to its VNF Catalog.</para> |
138 | 141 | ||
139 | <figure> | 142 | <figure> |
140 | <title>Onboard a VNF</title> | 143 | <title>Onboard a VNF</title> |
@@ -153,8 +156,8 @@ | |||
153 | <listitem> | 156 | <listitem> |
154 | <para><emphasis role="bold">VM Image File</emphasis>. This is the | 157 | <para><emphasis role="bold">VM Image File</emphasis>. This is the |
155 | Virtual Machine image file for the VNF. Typically, it is a QCOW | 158 | Virtual Machine image file for the VNF. Typically, it is a QCOW |
156 | image. Press <emphasis role="bold">Choose File</emphasis> and select the image you | 159 | image. Press <emphasis role="bold">Choose File</emphasis> and select |
157 | wish to upload.</para> | 160 | the image you wish to upload.</para> |
158 | </listitem> | 161 | </listitem> |
159 | 162 | ||
160 | <listitem> | 163 | <listitem> |
@@ -171,7 +174,7 @@ | |||
171 | <listitem> | 174 | <listitem> |
172 | <para><emphasis role="bold">Description</emphasis>. This field | 175 | <para><emphasis role="bold">Description</emphasis>. This field |
173 | contains any description provided and is only displayed in the GUI | 176 | contains any description provided and is only displayed in the GUI |
174 | tables in the Enea uCPE Manager.</para> | 177 | tables in the Enea Edge Management.</para> |
175 | </listitem> | 178 | </listitem> |
176 | 179 | ||
177 | <listitem> | 180 | <listitem> |
@@ -203,14 +206,14 @@ | |||
203 | 206 | ||
204 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> | 207 | <para><emphasis role="bold">Interfaces Tab</emphasis></para> |
205 | 208 | ||
206 | <para>Click on the <emphasis role="bold">Interfaces</emphasis> tab to show the | 209 | <para>Click on the <emphasis role="bold">Interfaces</emphasis> tab to |
207 | Interfaces table.</para> | 210 | show the Interfaces table.</para> |
208 | 211 | ||
209 | <para>This table will contain the interfaces required by this VNF to be | 212 | <para>This table will contain the interfaces required by this VNF to be |
210 | configured, when creating an instance. Consult the VNF vendor to | 213 | configured, when creating an instance. Consult the VNF vendor to |
211 | determine which and how many are required. Each interface requires a | 214 | determine which and how many are required. Each interface requires a |
212 | name, and optionally a description, used only by the Enea uCPE | 215 | name, and optionally a description, used only by the Enea Edge |
213 | Manager.</para> | 216 | Management.</para> |
214 | 217 | ||
215 | <note> | 218 | <note> |
216 | <para>CAUTION: The user MUST conserve the same order for the virtual | 219 | <para>CAUTION: The user MUST conserve the same order for the virtual |
@@ -219,9 +222,9 @@ | |||
219 | 222 | ||
220 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> | 223 | <para><emphasis role="bold">Cloud Init Tab</emphasis></para> |
221 | 224 | ||
222 | <para>Click the <emphasis role="bold">Cloud Init</emphasis> tab to provide the | 225 | <para>Click the <emphasis role="bold">Cloud Init</emphasis> tab to |
223 | Cloud-Init configuration. There are three fields that need to be | 226 | provide the Cloud-Init configuration. There are three fields that need |
224 | populated:</para> | 227 | to be populated:</para> |
225 | 228 | ||
226 | <orderedlist> | 229 | <orderedlist> |
227 | <listitem> | 230 | <listitem> |
@@ -273,7 +276,7 @@ | |||
273 | <para>The <literal>Content Files Table</literal> is ONLY used if | 276 | <para>The <literal>Content Files Table</literal> is ONLY used if |
274 | <literal>ConfigDrive</literal> is chosen as the Cloud-Init | 277 | <literal>ConfigDrive</literal> is chosen as the Cloud-Init |
275 | Datasource. For each content file added, a <literal>Path</literal> | 278 | Datasource. For each content file added, a <literal>Path</literal> |
276 | must be provided. When the Enea uCPE Manager is used to create an | 279 | must be provided. When the Enea Edge Management is used to create an |
277 | instance for multiple VNFs, the user will be prompted to provide a | 280 | instance for multiple VNFs, the user will be prompted to provide a |
278 | data file for each entry in this table. Each type of VNF will | 281 | data file for each entry in this table. Each type of VNF will |
279 | require different cloud-init files, e.g.: a license file. The data | 282 | require different cloud-init files, e.g.: a license file. The data |
@@ -292,9 +295,9 @@ | |||
292 | <para>In this table, you can enter values for properties that will be | 295 | <para>In this table, you can enter values for properties that will be |
293 | used during instantiation of the VNF. The values will augment the | 296 | used during instantiation of the VNF. The values will augment the |
294 | default values in the <filename>domain.xml</filename> file used by | 297 | default values in the <filename>domain.xml</filename> file used by |
295 | <literal>libvirt/virsh</literal> (running in Enea NFV Access) when | 298 | <literal>libvirt/virsh</literal> (running in Enea Edge) when creating an |
296 | creating an instance of the VNF. Consult with the VNF Vendor or ENEA | 299 | instance of the VNF. Consult with the VNF Vendor or ENEA support for |
297 | support for values needed by specific VNFs.</para> | 300 | values needed by specific VNFs.</para> |
298 | 301 | ||
299 | <para><emphasis role="bold">Property Values</emphasis></para> | 302 | <para><emphasis role="bold">Property Values</emphasis></para> |
300 | 303 | ||
@@ -349,8 +352,8 @@ | |||
349 | 352 | ||
350 | <orderedlist> | 353 | <orderedlist> |
351 | <listitem> | 354 | <listitem> |
352 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> and | 355 | <para>Select from the top toolbar <emphasis role="bold">VNF</emphasis> |
353 | choose <emphasis role="bold">Instances</emphasis>.</para> | 356 | and choose <emphasis role="bold">Instances</emphasis>.</para> |
354 | </listitem> | 357 | </listitem> |
355 | 358 | ||
356 | <listitem> | 359 | <listitem> |
@@ -406,13 +409,14 @@ | |||
406 | </listitem> | 409 | </listitem> |
407 | 410 | ||
408 | <listitem> | 411 | <listitem> |
409 | <para>Hit the <emphasis role="bold">Create</emphasis> button to deploy the VNF and | 412 | <para>Hit the <emphasis role="bold">Create</emphasis> button to deploy |
410 | run it on the specified uCPE device.</para> | 413 | the VNF and run it on the specified uCPE device.</para> |
411 | </listitem> | 414 | </listitem> |
412 | </orderedlist> | 415 | </orderedlist> |
413 | 416 | ||
414 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then choosing <emphasis role="bold">Events</emphasis> | 417 | <para>Selecting the <emphasis role="bold">VNF</emphasis> menu then |
415 | will show that the VNF was created and a connection was established.</para> | 418 | choosing <emphasis role="bold">Events</emphasis> will show that the VNF |
419 | was created and a connection was established.</para> | ||
416 | </section> | 420 | </section> |
417 | 421 | ||
418 | <section id="enter_console"> | 422 | <section id="enter_console"> |
@@ -425,8 +429,9 @@ | |||
425 | 429 | ||
426 | <orderedlist> | 430 | <orderedlist> |
427 | <listitem> | 431 | <listitem> |
428 | <para>SSH to the uCPE device from the Enea uCPE Manager | 432 | <para>SSH to the uCPE device from the Enea Edge Management (Access the |
429 | (Access the <emphasis role="bold">Device</emphasis> menu and select <emphasis role="bold">SSH</emphasis>) using:</para> | 433 | <emphasis role="bold">Device</emphasis> menu and select <emphasis |
434 | role="bold">SSH</emphasis>) using:</para> | ||
430 | 435 | ||
431 | <itemizedlist> | 436 | <itemizedlist> |
432 | <listitem> | 437 | <listitem> |
@@ -440,12 +445,13 @@ | |||
440 | <para>For reverse ssh connections (ssh to a uCPE device behind | 445 | <para>For reverse ssh connections (ssh to a uCPE device behind |
441 | NAT): the <literal>Username</literal> (default: root) and the | 446 | NAT): the <literal>Username</literal> (default: root) and the |
442 | <literal>Reverse ssh</literal> checkbox checked. The port will be | 447 | <literal>Reverse ssh</literal> checkbox checked. The port will be |
443 | automatically choosen by the Enea uCPE Manager in the range | 448 | automatically chosen by the Enea Edge Management in the range |
444 | defined in the <emphasis role="bold">SSH</emphasis> configuration panel, | 449 | defined in the <emphasis role="bold">SSH</emphasis> configuration |
445 | available when accessing <emphasis role="bold">System</emphasis>, then | 450 | panel, available when accessing <emphasis |
446 | <emphasis role="bold">Configuration</emphasis> and choosing <emphasis role="bold">Reverse | 451 | role="bold">System</emphasis>, then <emphasis |
447 | SSH</emphasis> . By default, the start port will | 452 | role="bold">Configuration</emphasis> and choosing <emphasis |
448 | be <literal>7000</literal> and the maximum number of ports | 453 | role="bold">Reverse SSH</emphasis> . By default, the start port |
454 | will be <literal>7000</literal> and the maximum number of ports | ||
449 | allocated to all devices is 10. Only one port per device is | 455 | allocated to all devices is 10. Only one port per device is |
450 | allowed.</para> | 456 | allowed.</para> |
451 | 457 | ||