1 .. This work is licensed under a Creative Commons Attribution 4.0
2 .. International License. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2019 ONAP Contributors. All rights reserved.
5 .. _doc_guide_user_des_res-onb:
9 **Goal:** Add models and other artifacts required to create, configure,
10 instantiate, and manage a VF/PNF and, optionally, a VFC.
14 **SDC user role:** Designer
19 * `Create a License Model`_
20 * `Create a License Key Group [Optional]`_
21 * `Create an Entitlement Pool`_
22 * `Create a Feature Group`_
23 * `Create a License Agreement`_
24 * `Create a Vendor Software Product`_
25 * `Update VFCs in a VSP [optional]`_
26 * `Update a VSP [optional]`_
28 After updating the artifacts in a VSP, also update:
29 * the VF/PNF created from the VSP
30 * any services that include the VF/PNF
34 .. _doc_guide_user_des_res-onb_cre-lic:
36 Create a License Model
37 ----------------------
39 VSPs optionally require a license and entitlements to enable the service
40 provider to track the usage.
42 Note: For interim saving while creating the license model and its components,
45 **Prerequisites:** To obtain license information, contact the service
46 provider's Supply Chain Management (SCM) group.
50 #. From the SDC HOME page, click *ONBOARD*.
51 #. Hover over Add and select New License Model.
52 #. Complete all fields.
54 #. In the ONBOARD header, hover over the arrow after License Agreements to
56 Select the following options in order:
58 #. Create 0 or more license key groups (see
59 `Create a License Key Group [Optional]`_).
60 #. Create 1 or more entitlement pools (see `Create an Entitlement Pool`_).
61 #. Create 1 or more feature groups (see `Create a Feature Group`_).
62 #. Create 1 or more license agreements (see `Create a License Agreement`_).
64 Note: Perform all steps above before submitting the license model to
67 #. In the header, click the license model created in steps 1 to 4.
68 #. Click *Check In* to save changes.
69 #. Click *Submit* to add the license model to the catalog. A success message
71 #. After creating a license, complete `Create a Vendor Software Product`_ to
72 add the VSP required for the associated VF/PNF.
74 Create a License Key Group [Optional]
75 -------------------------------------
77 If required by the resource model, create one or more license key groups;
78 otherwise the license key group is optional.
80 **Prerequisites:** `Create a License Model`_
84 1. From the drop-down menu, select License Key Groups.
85 2. Click *Add License Key Group*.
86 The Create New License Key Group box displays.
87 3. Complete all fields.
88 Note: Enter the manufacturer reference number in the Name field.
91 Create an Entitlement Pool
92 --------------------------
94 **Prerequisites:** If required by the resource model, create one or more
95 license key groups (see
96 `Create a License Key Group [Optional]`_).
100 1. From the drop-down menu, select Entitlement Pools.
101 2. Click *Add Entitlement Pool*.
102 The Create New Entitlement Pool box displays.
103 3. Complete required fields (mandatory fields are marked by a red asterisk).
106 Create a Feature Group
107 ----------------------
109 **Prerequisites:** Create one or more:
111 * license key groups if required by the resource model
112 (see `Create a License Key Group [optional]`_)
113 * entitlement pools (see `Create an Entitlement Pool`_)
117 1. From the drop-down menu, select Feature Groups.
118 2. Click *Add Feature Group*.
119 The Create New Feature Group box displays.
120 3. On the General tab, complete all fields.
121 4. Click *Entitlement Pools*.
122 5. Click *Available Entitlement Pools*.
123 6. Select one or more entitlement pools and click the right arrow.
124 7. Click *License Key Groups*.
125 8. Click *Available License Key Groups*.
126 9. Select one or more license key groups and click the right arrow.
129 Create a License Agreement
130 --------------------------
132 **Prerequisites:** Create one or more feature groups
133 (see `Create a Feature Group`_).
137 1. From the drop-down menu, select License Agreements.
138 2. Click *Add License Agreement*.
139 The Create New License Agreement box displays.
140 3. On the General tab, complete required fields (mandatory fields are marked
142 4. Click *Feature Groups*.
143 5. If not selected, click *Available Feature Groups*.
144 6. Select one or more groups and click the right arrow.
146 8. Return to step 5 of `Create a License Model`_ to complete the license model.
148 .. _doc_guide_user_des_res-onb_cre-vsp:
150 Create a Vendor Software Product
151 --------------------------------
153 Create one or more Vendor Software Products (VSPs) as the building blocks
157 For interim saving while creating a VSP, click |image2|
161 * `Create a License Model`_
162 * VNF HEAT package or VNF/PNF CSAR/Zip package is available.
164 See :ref:`sdc_onboarding_package_types` for a description
165 of the onboarding package types.
166 * If the package is a secure package then :ref:`pre-install the corresponding Root Certificate in SDC <doc_guide_user_des_res-onb_pre-install_root_certificate>`.
168 #. From the SDC HOME page, click *ONBOARD*.
169 #. Hover over Add and select New Vendor Software Product.
170 #. The New Software Product box is displayed.
173 The Overview section is displayed.
176 A warning is displayed under License Agreement if the VSP does not have
177 an associated license.
179 #. Click *Software Product Details* (left pane).
183 #. In order, select a licensing version, a license agreement, and one or more
185 #. [Optional] Complete other fields, such as Availability (high-availability
186 zones) and Storage Data Replication (requirement for storage replication),
188 #. In Software Product Attachments (right pane), click *Select file*.
189 #. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
191 In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
193 #. SDC validates the files in the package. After successful validation, SDC
194 displays the files and a success message. If validation fails, SDC displays
195 the errors in the files.
201 #. Click *Check In* to save the changes.
202 #. Click *Submit* to add the VSP to the catalog.
203 #. A success message is displayed. If the VSP attachments contain errors, an
204 error message is displayed instead. Fix the issue(s) and re-submit.
205 #. To configure VFCs associated with the VSP, see
206 `Update VFCs in a VSP [optional]`_, below.
209 .. _doc_guide_user_des_res-onb_upd-vfc:
211 Update VFCs in a VSP [optional]
212 -------------------------------
214 If required, configure Virtual Function Components (VFCs) associated with a
215 VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed
216 on the Components tab.
219 All fields are optional. Answers to questionnaires are stored as metadata
220 only on the SDC platform.
222 **Prerequisites:** Add one or more VSPs
223 (see `Create a Vendor Software Product`_).
225 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
226 #. In the Overview section, click *Check Out*.
227 #. In Components (bottom pane), click a VFC (VSP component).
228 The component links display in the left pane.
229 #. Click *General* to view and edit general parameters such as hypervisor,
230 image format, VM recovery details, and DNS configuration.
231 #. Click *Compute* to view and edit VM parameters such as the number of VMs
232 required for a VFC instance and persistent storage/volume size.
233 #. Click *High Availability & Load Balancing* to answer questions related
234 to VM availability and load balancing.
235 #. Click *Networks* to view or edit parameters related to network capacity
239 Click an interface to view or edit it. A dialog box displays similar
244 #. Click *Storage* to configure storage information, such as backup type,
245 storage size, and logging.
246 #. Click *Process Details*, click *Add Component Process Details*, and complete
247 the Create New Process Details dialog box. Use Process Details to identify
248 the processes and configuration associated with VFCs.
249 #. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling.
250 #. Click *Overview* and click *Check In* to save changes.
251 #. If updating a VSP, click *Submit*. If this procedure is performed during the
252 workflow to create a VSP, there is no need to click *Submit* now.
254 .. _doc_guide_user_des_res-onb_upd-vsp:
256 Update a VSP [optional]
257 -----------------------
259 Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and service.
261 **Prerequisites:** Add one or more VSPs
262 (see `Create a Vendor Software Product`_).
264 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
265 #. In the Overview section, click *Check Out*.
266 #. In Software Product Attachments (right pane), click *Select file*.
267 #. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
269 In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
272 SDC warns that uploading a new package erases existing data.
273 #. Click *Continue* to upload the new package.
274 SDC validates the files in the package. After successful validation, SDC
275 displays the files and a success message. If validation fails, SDC displays
276 the errors in the files.
279 If the Heat template contains errors, contact the Certification Group for
280 guidance on how to proceed.
281 #. Click *Check In* to save changes.
282 #. Click *Submit* to add the VSP to the catalog.
283 A success message is displayed. If the VSP attachments contain errors, an
284 error message is displayed instead. Fix the issue(s) and re-submit.
285 #. After updating the VSP:
287 #. Upload the VSP to the Vf/PNF
288 (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
289 #. Update the VF/PNF version in services that include the VF/PNF (see step 4
290 in :ref:`doc_guide_user_des_ser-des`).
292 .. _doc_guide_user_des_res-onb_pre-install_root_certificate:
294 Pre-Install Root Certificate in SDC [only needed for secure package]
295 --------------------------------------------------------------------
296 SDC supports the onboarding of packages that are secured according to security option 2 in ETSI NFV-SOL 004v2.6.1.
298 During onboarding, SDC will validate the authenticity and integrity of a secure package. To enable this validation,
299 the root certificate corresponding to the certificate included in the package needs to be available to SDC.
300 This is currently done by uploading the root certificate to the following default directory location::
302 /dockerdata-nfs/{{ .Release.Name }}/sdc/onbaording/cert
305 The directory listed above is mapped to the following directory in the onboarding pod (sdc-onboarding-be)
310 so it is also possible to copy the root certificate directly to this directory in the pod.
312 The location where the root certificate is uploaded is configurable. The relevant parameters are described in
313 the *cert* block in the following values file::
315 <path_to_oom_kubernetes>/sdc/charts/sdc-onboarding-be/values.yaml
318 .. |image0| image:: media/sdro-resource-onboarding-workflow.png
320 .. |image1| image:: media/sdro-vsp-service-workflow.png
322 .. |image2| image:: media/sdro-sdc_vsp_save.png
324 .. |image3| image:: media/sdro-license-creation.png
326 .. |image4| image:: media/sdro-license-keygroup.png
328 .. |image5| image:: media/sdro-entitlement-pool.png
330 .. |image6| image:: media/sdro-feature-group.png
332 .. |image7| image:: media/sdro-license-agreement.png
334 .. |image8| image:: media/sdro-software-product.png
336 .. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png
338 .. |image10| image:: media/sdro-edit-nic.png