summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-vnf-onboarding-guide/doc/vnf_onboarding.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-nfv-access-vnf-onboarding-guide/doc/vnf_onboarding.xml')
-rw-r--r--doc/book-enea-nfv-access-vnf-onboarding-guide/doc/vnf_onboarding.xml173
1 files changed, 0 insertions, 173 deletions
diff --git a/doc/book-enea-nfv-access-vnf-onboarding-guide/doc/vnf_onboarding.xml b/doc/book-enea-nfv-access-vnf-onboarding-guide/doc/vnf_onboarding.xml
deleted file mode 100644
index f0d4e8f..0000000
--- a/doc/book-enea-nfv-access-vnf-onboarding-guide/doc/vnf_onboarding.xml
+++ /dev/null
@@ -1,173 +0,0 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="vnf_onboard">
3 <title>VNF Onboarding</title>
4
5 <para>The onboarding of a VNF means adding it to the Enea uCPE Manager VNF
6 Catalog and preparing it for instantiation (deployment on connected uCPE devices).
7 This is accomplished using the Enea uCPE Manager Onboarding Wizard, a
8 graphical user interface specifically designed to make VNF onboarding simple
9 and fast.</para>
10
11 <para>Typically, the VNF's Getting Started Guide contains all necessary
12 information needed to onboard a VNF using the Onboarding Wizard. This
13 present guide however, provides a number of examples of how to onboard
14 specific commercial VNFs.</para>
15
16 <para>The following sections detail the basic steps needed to successfully
17 onboard a VNF in the Enea uCPE Manager.</para>
18
19 <section id="retrieve_art">
20 <title>Retrieving Artifacts</title>
21
22 <para>The user must first retrieve the necessary artifacts from the VNF
23 vendor:</para>
24
25 <orderedlist>
26 <listitem>
27 <para>Download the VNF from the commercial vendor.</para>
28 </listitem>
29
30 <listitem>
31 <para>Get any VNF specific license from the VNF vendor.</para>
32
33 <note>
34 <para>There are no standard ways of managing VNF licenses, therefore
35 no general guidelines can be provided. One example of license
36 handling that can be employed in the uCPE Manager is the adding of a
37 license during the Cloud-Init setup. The ConfigDrive value is
38 provided in the Fortios specific guidelines.</para>
39 </note>
40 </listitem>
41
42 <listitem>
43 <para>Get access to the VNF specific VNF Manager for day 1 and 2
44 configuration (in cloud or for local deployment).</para>
45 </listitem>
46
47 <listitem>
48 <para>Procure the Getting Started Guide from the VNF vendor,
49 preferably for KVM deployment for VNF specific configuration
50 information.</para>
51 </listitem>
52 </orderedlist>
53 </section>
54
55 <section id="onboard_prep">
56 <title>Preparation</title>
57
58 <para>Once all needed downloadables, documentation and more have been
59 attained, preparation for onboarding must be completed:</para>
60
61 <orderedlist>
62 <listitem>
63 <para>Determine the use-case and performance requirements of the VNF
64 you wish to deploy.</para>
65
66 <itemizedlist>
67 <listitem>
68 <para>This decides what resources the VNF is configured for, along
69 with networking and day zero configurations.</para>
70
71 <para>Generally, the Getting Started Guide for the VNF provides
72 guidelines for resource allocation, but since performance is
73 dependent on hardware capacity, the right resource allocation for
74 deployment is typically determined through benchmarking.</para>
75 </listitem>
76
77 <listitem>
78 <para>Determine the amount of hardware resources needed for the
79 VNF (RAM, CPUs and Disk size).</para>
80 </listitem>
81
82 <listitem>
83 <para>Determine how many Network Interfaces the VNF shall
84 use.</para>
85 </listitem>
86 </itemizedlist>
87 </listitem>
88
89 <listitem>
90 <para>Determine the day zero configuration method from the VNF Getting
91 Started guidelines.</para>
92
93 <note>
94 <para>For many VNFs, day zero configuration can be skipped in early
95 onboarding efforts when automation is not of importance.</para>
96 </note>
97 </listitem>
98
99 <listitem>
100 <para>Determine any requirements needed by the Cloud-Init file
101 structure and the content needed for the VNF when Cloud-Init is
102 used.</para>
103 </listitem>
104 </orderedlist>
105 </section>
106
107 <section id="onboarding">
108 <title>Onboarding the VNF</title>
109
110 <orderedlist>
111 <listitem>
112 <para>Enter the Enea uCPE Manager and choose VNF-&gt;Descriptors in
113 the GUI.</para>
114 </listitem>
115
116 <listitem>
117 <para>Click <literal>Onboard</literal> to start the onboarding
118 procedure.</para>
119 </listitem>
120
121 <listitem>
122 <para>Fill in all mandatory fields in the popup menu: Name, Image,
123 RAM, CPUs, Disk.</para>
124 </listitem>
125
126 <listitem>
127 <para>Define the VNF's Network Interfaces and give them descriptive
128 names.</para>
129 </listitem>
130
131 <listitem>
132 <para>Configure the Cloud-Init settings, starting with the
133 Datasource:</para>
134
135 <itemizedlist spacing="compact">
136 <listitem>
137 <para>Choose <literal>None</literal> if Cloud-Init is not
138 used.</para>
139 </listitem>
140
141 <listitem>
142 <para>Choose <literal>ConfigDrive</literal>,
143 <literal>NoCloud</literal> or <literal>ISO</literal> depending on
144 the VNF specific Cloud-Init implementation.</para>
145 </listitem>
146
147 <listitem>
148 <para>Choose the Cloud-Init mount method based on the VNF specific
149 Cloud-Init implementation.</para>
150 </listitem>
151
152 <listitem>
153 <para>Configure any VNF specific Cloud-Init files according to VNF
154 specific documentation.</para>
155 </listitem>
156 </itemizedlist>
157 </listitem>
158
159 <listitem>
160 <para>Additional Properties (in the Properties Tab) are typically not
161 needed and can be ignored.</para>
162 </listitem>
163
164 <listitem>
165 <para>Click <literal>Onboard</literal> to add the VNF to the Enea uCPE
166 Manager VNF Catalog.</para>
167 </listitem>
168 </orderedlist>
169
170 <para>When the onboarding is complete, the VNF will appear in the VNF
171 Catalog and can be used for deploying services on the uCPE devices.</para>
172 </section>
173</chapter>