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 [Optional]`_
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 [Optional]
37 ---------------------------------
39 VSPs optionally require a license and entitlements to enable the service
40 provider to track the usage.
43 For interim saving while creating the license model and its components, click |image2|
45 **Prerequisites:** To obtain license information, contact the service
46 provider's Supply Chain Management (SCM) group.
49 #. From the SDC HOME page, navigate to the ONBOARD Tab.
53 #. In the Workspace select *CREATE NEW VLM*.
57 #. Complete all fields.
59 #. After creation of the VLM, you should be presented with the “Overview” tab of the VLM.
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.After filling a comment, press *Commit&Submit*.
80 #. After creating a license, complete `Create a Vendor Software Product`_ to
81 add the VSP required for the associated VF/PNF.
84 Create a License Key Group [Optional]
85 -------------------------------------
87 If required by the resource model, create one or more license key groups;
88 otherwise the license key group is optional.
90 **Prerequisites:** `Create a License Model [Optional]`_
92 #. Select the License Model in the Onboard section of the SDC.
93 #. In the Overview click the + inside the License Key Groups OR Navigate to License Key Groups and click on “+ ADD LICENSE KEY GROUP”
97 #. Complete all fields (mandatory fields are marked by a red asterisk).
100 Create an Entitlement Pool
101 --------------------------
103 **Prerequisites:** If required by the resource model, create one or more
104 license key groups (see
105 `Create a License Key Group [Optional]`_).
107 #. Select the License Model in the Onboard section of the SDC.
108 #. In the Overview click the + sign inside the Entitlement Pools OR Navigate to Entitlement Pools and click on “+ ADD ENTITLEMENT POOL”
112 #. Complete required fields (mandatory fields are marked by a red asterisk).
115 Create a Feature Group
116 ----------------------
118 **Prerequisites:** Create one or more:
120 * license key groups if required by the resource model
121 (see `Create a License Key Group [optional]`_)
122 * entitlement pools (see `Create an Entitlement Pool`_)
124 #. Select the License Model in the Onboard section of the SDC.
125 #. In the Overview click the + sign inside the Feature Groups OR Navigate to Feature Groups and click on “+ ADD FEATURE GROUP”
129 #. On the General tab, complete all fields.
130 #. Navigate to the *Entitlement Pools*. Tab
131 * In the Available Entitlement Pools, select one or more entitlement pools and click on the “>” sign.
132 * Selected pools should now be seen under the Selected Entitlements Pools.
133 #. Navigate to the *License Key Groups*. Tab
134 * In the Available License Key Groups, select one or more license key groups and click on the “>” sign.
135 * Selected pools should now be seen under the Selected License Key Groups.
138 Create a License Agreement
139 --------------------------
141 **Prerequisites:** Create one or more feature groups
142 (see `Create a Feature Group`_).
144 #. Select the License Model in the Onboard section of the SDC.
145 #. In the Overview click the + sign inside the License Agreements OR Navigate to License Agreements and click on “+ Add FEATURE GROUP”
149 #. On the General tab, complete required fields.
150 #. Click *Feature Groups*.
151 #. If not selected, click Available *Feature Groups*.
152 * Select one or more groups in the Available Feature Groups, select one or more feature groups and click on the “>” sign.
153 * Selected feature groups should now be seen under the Selected Feature Groups.
155 #. Return to step 6 of `Create a License Model [Optional]`_ 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 [Optional]`_
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>`.
178 Example packages can be found in the SDC project: :ref:`SDC Packages<onap-sdc:sdc_onboarding_package_types>`
180 #. From the SDC HOME page, click *ONBOARD*.
184 #. In the Workspace select *CREATE NEW VSP*.
188 #. Complete all fields.
190 The Overview page is shown
195 A warning is displayed under License Agreement if the VSP does not have
196 an associated license.
198 #. Click *General* in the left section.
200 #. For the defined Vendor, select a licensing version, a license agreement,
201 and one or more feature groups.
205 #. [Optional] Complete other fields, such as Availability (high-availability
206 zones) and Storage Data Replication (requirement for storage replication),
208 #. In the *Overview* section, select *Software Product Attachments*
209 (right pane), click *Select file*.
210 #. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
212 In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
214 #. The file is loaded and the attachments page opens
218 #. Press the Button *Proceed to Validation*. After successful validation, SDC
219 displays the files and a success message. If validation fails, SDC displays
220 the errors in the files.
226 #. Click *Submit* to add the VSP to the catalog.
228 After filling a comment, press *Commit&Submit*.
229 #. A success message is displayed. If the VSP attachments contain errors, an
230 error message is displayed instead. Fix the issue(s) and re-submit.
231 #. To configure VFCs associated with the VSP, see
232 `Update VFCs in a VSP [optional]`_, below.
235 .. _doc_guide_user_des_res-onb_upd-vfc:
237 Update VFCs in a VSP [optional]
238 -------------------------------
240 If required, configure Virtual Function Components (VFCs) associated with a
241 VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed
242 on the Components tab.
245 All fields are optional. Answers to questionnaires are stored as metadata
246 only on the SDC platform.
248 **Prerequisites:** Add one or more VSPs
249 (see `Create a Vendor Software Product`_).
251 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
252 #. Selecting the VSP opens the *Versions* page.
256 #. Press the + at *Create New Version* on the version to update
260 #. Fill the fields and press *Create*
261 #. In Components , click a VFC (VSP component).
263 The component links display in the left pane.
264 #. Click *General* to view and edit general parameters such as hypervisor,
265 image format, VM recovery details, and DNS configuration.
266 #. Click *Compute* to view and edit VM parameters such as the number of VMs
267 required for a VFC instance and persistent storage/volume size.
268 #. Click *High Availability & Load Balancing* to answer questions related
269 to VM availability and load balancing.
270 #. Click *Networks* to view or edit parameters related to network capacity
274 Click an interface to view or edit it. A dialog box displays similar
279 #. Click *Storage* to configure storage information, such as backup type,
280 storage size, and logging.
281 #. Click *Process Details*, click *Add Component Process Details*, and complete
282 the *Create New Process Details* dialog box.
284 Use Process Details to identify
285 the processes and configuration associated with VFCs.
286 #. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling.
287 #. To update the VSP, click *Submit*
289 After filling a comment, press *Commit&Submit* and the
290 new version is certified.
292 .. _doc_guide_user_des_res-onb_upd-vsp:
294 Update a VSP [optional]
295 -----------------------
297 Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and service.
299 **Prerequisites:** Add one or more VSPs
300 (see `Create a Vendor Software Product`_).
302 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
303 #. Selecting the VSP opens the *Versions* page.
307 #. Press the + at *Create New Version* on the version to update
311 #. Fill the fields and press *Create*
312 #. In Software Product Attachments (right pane), click *Select file*.
313 #. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
315 In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
318 SDC warns that uploading a new package erases existing data.
319 #. Click *Continue* to upload the new package.
320 #. The file is loaded and the attachments page opens
324 #. Press the Button *Proceed to Validation*. After successful validation, SDC
325 displays the files and a success message. If validation fails, SDC displays
326 the errors in the files.
332 #. Click *Submit* to add the new VSP version to the catalog.
333 After filling a comment, press *Commit&Submit* and the
334 new version is certified.
335 #. After updating the VSP:
337 #. Upload the VSP to the Vf/PNF
338 (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
339 #. Update the VF/PNF version in services that include the VF/PNF (see step 4
340 in :ref:`doc_guide_user_des_ser-des`).
342 .. _doc_guide_user_des_res-onb_pre-install_root_certificate:
344 Pre-Install Root Certificate in SDC [only needed for secure package]
345 --------------------------------------------------------------------
346 SDC supports the onboarding of packages that are secured according to security option 2 in ETSI NFV-SOL 004v2.6.1.
348 During onboarding, SDC will validate the authenticity and integrity of a secure package. To enable this validation,
349 the root certificate corresponding to the certificate included in the package needs to be available to SDC.
350 This is currently done by uploading the root certificate to the following default directory location::
352 /dockerdata-nfs/{{ .Release.Name }}/sdc/onbaording/cert
355 The directory listed above is mapped to the following directory in the onboarding pod (sdc-onboarding-be)
360 so it is also possible to copy the root certificate directly to this directory in the pod.
362 The location where the root certificate is uploaded is configurable. The relevant parameters are described in
363 the *cert* block in the following values file::
365 <path_to_oom_kubernetes>/sdc/charts/sdc-onboarding-be/values.yaml
368 .. |image0| image:: media/sdro-resource-onboarding-workflow.png
370 .. |image1| image:: media/sdro-vsp-service-workflow.png
372 .. |image2| image:: media/sdro-sdc_vsp_save.png
374 .. |image3| image:: media/sdro-license-creation.png
376 .. |image4| image:: media/sdro-license-keygroup.png
378 .. |image5| image:: media/sdro-entitlement-pool.png
380 .. |image6| image:: media/sdro-feature-group.png
382 .. |image7| image:: media/sdro-license-agreement.png
384 .. |image8| image:: media/sdro-software-product.png
386 .. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png
388 .. |image10| image:: media/sdro-edit-nic.png
390 .. |image11| image:: media/sdro-new-vlm.png
392 .. |image12| image:: media/sdro-new-vlm-dialog.png
394 .. |image13| image:: media/sdro-new-vlm-overview.png
396 .. |image14| image:: media/sdro-license-model.png
398 .. |image15| image:: media/sdro-license-model-submit.png
400 .. |image21| image:: media/sdro-new-vsp.png
402 .. |image22| image:: media/sdro-new-vsp-overview.png
404 .. |image23| image:: media/sdro-new-vsp-general.png
406 .. |image24| image:: media/sdro-new-vsp-attachments.png
408 .. |image25| image:: media/sdro-vsp-version.png
410 .. |image26| image:: media/sdro-vsp-version-dialog.png