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.
49 #. From the SDC HOME page, click *ONBOARD*.
53 #. In the Workspace select *CREATE NEW VLM*.
57 #. Complete all fields.
59 #. In the Overview Dialog.
63 Select the following options in order:
65 #. Create 0 or more license key groups (see
66 `Create a License Key Group [Optional]`_).
67 #. Create 1 or more entitlement pools (see `Create an Entitlement Pool`_).
68 #. Create 1 or more feature groups (see `Create a Feature Group`_).
69 #. Create 1 or more license agreements (see `Create a License Agreement`_).
71 Note: Perform all steps above before submitting the license model to
76 #. Click *Submit* to add the license model to the catalog.
77 After filling a comment, press *Commit&Submit*.
81 #. After creating a license, complete `Create a Vendor Software Product`_ to
82 add the VSP required for the associated VF/PNF.
85 Create a License Key Group [Optional]
86 -------------------------------------
88 If required by the resource model, create one or more license key groups;
89 otherwise the license key group is optional.
91 **Prerequisites:** `Create a License Model`_
93 #. Select the License Model in the Onboard section of the SDC.
94 #. In the Overview click the + behind the *License Key Groups*.
98 #. Complete all fields (mandatory fields are marked by a red asterisk).
101 Create an Entitlement Pool
102 --------------------------
104 **Prerequisites:** If required by the resource model, create one or more
105 license key groups (see
106 `Create a License Key Group [Optional]`_).
108 #. Select the License Model in the Onboard section of the SDC.
109 #. In the Overview click the + behind the *Entitlement Pools*.
113 #. Complete required fields (mandatory fields are marked by a red asterisk).
116 Create a Feature Group
117 ----------------------
119 **Prerequisites:** Create one or more:
121 * license key groups if required by the resource model
122 (see `Create a License Key Group [optional]`_)
123 * entitlement pools (see `Create an Entitlement Pool`_)
125 #. Select the License Model in the Onboard section of the SDC.
126 #. In the Overview click the + behind the *Feature Groups*.
130 #. On the General tab, complete all fields.
131 #. Click *Entitlement Pools*.
132 #. Click *Available Entitlement Pools*.
133 #. Select one or more entitlement pools and click the right arrow.
134 #. Click *License Key Groups*.
135 #. Click *Available License Key Groups*.
136 #. Select one or more license key groups and click the right arrow.
139 Create a License Agreement
140 --------------------------
142 **Prerequisites:** Create one or more feature groups
143 (see `Create a Feature Group`_).
145 #. Select the License Model in the Onboard section of the SDC.
146 #. In the Overview click the + behind the *License Agreements*.
150 #. On the General tab, complete required fields.
151 #. Click *Feature Groups*.
152 #. If not selected, click *Available Feature Groups*.
153 #. Select one or more groups and click the right arrow.
155 #. Return to step 6 of `Create a License Model`_ to complete the license model.
157 .. _doc_guide_user_des_res-onb_cre-vsp:
159 Create a Vendor Software Product
160 --------------------------------
162 Create one or more Vendor Software Products (VSPs) as the building blocks
166 For interim saving while creating a VSP, click |image2|
170 * `Create a License Model`_
171 * VNF HEAT package or VNF/PNF CSAR/Zip package is available.
173 See :ref:`sdc_onboarding_package_types` for a description
174 of the onboarding package types.
175 * 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>`.
177 #. From the SDC HOME page, click *ONBOARD*.
181 #. In the Workspace select *CREATE NEW VSP*.
185 #. Complete all fields.
187 The Overview page is shown
192 A warning is displayed under License Agreement if the VSP does not have
193 an associated license.
195 #. Click *General* in the left section.
197 #. For the defined Vendor, select a licensing version, a license agreement,
198 and one or more feature groups.
202 #. [Optional] Complete other fields, such as Availability (high-availability
203 zones) and Storage Data Replication (requirement for storage replication),
205 #. In the *Overview* section, select *Software Product Attachments*
206 (right pane), click *Select file*.
207 #. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
209 In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
211 #. The file is loaded and the attachments page opens
215 #. Press the Button *Procees to Validation*. After successful validation, SDC
216 displays the files and a success message. If validation fails, SDC displays
217 the errors in the files.
223 #. Click *Submit* to add the VSP to the catalog.
225 After filling a comment, press *Commit&Submit*.
226 #. A success message is displayed. If the VSP attachments contain errors, an
227 error message is displayed instead. Fix the issue(s) and re-submit.
228 #. To configure VFCs associated with the VSP, see
229 `Update VFCs in a VSP [optional]`_, below.
232 .. _doc_guide_user_des_res-onb_upd-vfc:
234 Update VFCs in a VSP [optional]
235 -------------------------------
237 If required, configure Virtual Function Components (VFCs) associated with a
238 VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed
239 on the Components tab.
242 All fields are optional. Answers to questionnaires are stored as metadata
243 only on the SDC platform.
245 **Prerequisites:** Add one or more VSPs
246 (see `Create a Vendor Software Product`_).
248 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
249 #. Selecting the VSP opens the *Versions* page.
253 #. Press the + at *Create New Version* on the version to update
257 #. Fill the fields and press *Create*
258 #. In Components , click a VFC (VSP component).
260 The component links display in the left pane.
261 #. Click *General* to view and edit general parameters such as hypervisor,
262 image format, VM recovery details, and DNS configuration.
263 #. Click *Compute* to view and edit VM parameters such as the number of VMs
264 required for a VFC instance and persistent storage/volume size.
265 #. Click *High Availability & Load Balancing* to answer questions related
266 to VM availability and load balancing.
267 #. Click *Networks* to view or edit parameters related to network capacity
271 Click an interface to view or edit it. A dialog box displays similar
276 #. Click *Storage* to configure storage information, such as backup type,
277 storage size, and logging.
278 #. Click *Process Details*, click *Add Component Process Details*, and complete
279 the *Create New Process Details* dialog box.
281 Use Process Details to identify
282 the processes and configuration associated with VFCs.
283 #. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling.
284 #. To update the VSP, click *Submit*
286 After filling a comment, press *Commit&Submit* and the
287 new version is certified.
289 .. _doc_guide_user_des_res-onb_upd-vsp:
291 Update a VSP [optional]
292 -----------------------
294 Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and service.
296 **Prerequisites:** Add one or more VSPs
297 (see `Create a Vendor Software Product`_).
299 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
300 #. Selecting the VSP opens the *Versions* page.
304 #. Press the + at *Create New Version* on the version to update
308 #. Fill the fields and press *Create*
309 #. In Software Product Attachments (right pane), click *Select file*.
310 #. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
312 In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
315 SDC warns that uploading a new package erases existing data.
316 #. Click *Continue* to upload the new package.
317 #. The file is loaded and the attachments page opens
321 #. Press the Button *Procees to Validation*. After successful validation, SDC
322 displays the files and a success message. If validation fails, SDC displays
323 the errors in the files.
329 #. Click *Submit* to add the new VSP version to the catalog.
330 After filling a comment, press *Commit&Submit* and the
331 new version is certified.
332 #. After updating the VSP:
334 #. Upload the VSP to the Vf/PNF
335 (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
336 #. Update the VF/PNF version in services that include the VF/PNF (see step 4
337 in :ref:`doc_guide_user_des_ser-des`).
339 .. _doc_guide_user_des_res-onb_pre-install_root_certificate:
341 Pre-Install Root Certificate in SDC [only needed for secure package]
342 --------------------------------------------------------------------
343 SDC supports the onboarding of packages that are secured according to security option 2 in ETSI NFV-SOL 004v2.6.1.
345 During onboarding, SDC will validate the authenticity and integrity of a secure package. To enable this validation,
346 the root certificate corresponding to the certificate included in the package needs to be available to SDC.
347 This is currently done by uploading the root certificate to the following default directory location::
349 /dockerdata-nfs/{{ .Release.Name }}/sdc/onbaording/cert
352 The directory listed above is mapped to the following directory in the onboarding pod (sdc-onboarding-be)
357 so it is also possible to copy the root certificate directly to this directory in the pod.
359 The location where the root certificate is uploaded is configurable. The relevant parameters are described in
360 the *cert* block in the following values file::
362 <path_to_oom_kubernetes>/sdc/charts/sdc-onboarding-be/values.yaml
365 .. |image0| image:: media/sdro-resource-onboarding-workflow.png
367 .. |image1| image:: media/sdro-vsp-service-workflow.png
369 .. |image2| image:: media/sdro-sdc_vsp_save.png
371 .. |image3| image:: media/sdro-license-creation.png
373 .. |image4| image:: media/sdro-license-keygroup.png
375 .. |image5| image:: media/sdro-entitlement-pool.png
377 .. |image6| image:: media/sdro-feature-group.png
379 .. |image7| image:: media/sdro-license-agreement.png
381 .. |image8| image:: media/sdro-software-product.png
383 .. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png
385 .. |image10| image:: media/sdro-edit-nic.png
387 .. |image11| image:: media/sdro-new-vlm.png
389 .. |image12| image:: media/sdro-new-vlm-dialog.png
391 .. |image13| image:: media/sdro-new-vlm-overview.png
393 .. |image14| image:: media/sdro-license-model.png
395 .. |image15| image:: media/sdro-license-model-submit.png
397 .. |image21| image:: media/sdro-new-vsp.png
399 .. |image22| image:: media/sdro-new-vsp-overview.png
401 .. |image23| image:: media/sdro-new-vsp-general.png
403 .. |image24| image:: media/sdro-new-vsp-attachments.png
405 .. |image25| image:: media/sdro-vsp-version.png
407 .. |image26| image:: media/sdro-vsp-version-dialog.png