docs/guides/onap-user/design/resource-onboarding/index.rst

   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.
   4
   5 .. _doc_guide_user_des_res-onb:
   6
   7 Resource Onboarding
   8 ===================
   9 **Goal:** Add models and other artifacts required to create, configure,
  10           instantiate, and manage a VF and, optionally, a VFC.
  11
  12 **Tool:** SDC
  13
  14 **SDC user role:** Designer
  15
  16 |image0|
  17
  18 **Steps**
  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]`_
  27
  28 After updating the artifacts in a VSP, also update:
  29     * the VF created from the VSP
  30     * any services that include the VF
  31
  32 |image1|
  33
  34 .. _doc_guide_user_des_res-onb_cre-lic:
  35
  36 Create a License Model
  37 ----------------------
  38
  39 VSPs optionally require a license and entitlements to enable the service
  40 provider to track the usage.
  41
  42 Note: For interim saving while creating the license model and its components,
  43 click |image2|
  44
  45 **Prerequisites:** To obtain license information, contact the service
  46                    provider's Supply Chain Management (SCM) group.
  47
  48 |image3|
  49
  50 #. From the SDC HOME page, click *ONBOARD*.
  51 #. Hover over Add and select New License Model.
  52 #. Complete all fields.
  53 #. Click *Save*.
  54 #. In the ONBOARD header, hover over the arrow after License Agreements to
  55    reveal a menu.
  56    Select the following options in order:
  57
  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`_).
  63
  64       Note: Perform all steps above before submitting the license model to
  65       the SDC catalog.
  66
  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
  70    displays.
  71 #. After creating a license, complete `Create a Vendor Software Product`_ to
  72    add the VSP required for the associated VF.
  73
  74 Create a License Key Group [Optional]
  75 -------------------------------------
  76
  77 If required by the resource model, create one or more license key groups;
  78 otherwise the license key group is optional.
  79
  80 **Prerequisites:** `Create a License Model`_
  81
  82 |image4|
  83
  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.
  89 4. Click *Save*.
  90
  91 Create an Entitlement Pool
  92 --------------------------
  93
  94 **Prerequisites:** If required by the resource model, create one or more
  95                    license key groups (see
  96                    `Create a License Key Group [Optional]`_).
  97
  98 |image5|
  99
 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).
 104 4. Click *Save*.
 105
 106 Create a Feature Group
 107 ----------------------
 108
 109 **Prerequisites:** Create one or more:
 110
 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`_)
 114
 115 |image6|
 116
 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.
 127 10. Click *Save*.
 128
 129 Create a License Agreement
 130 --------------------------
 131
 132 **Prerequisites:** Create one or more feature groups
 133                    (see `Create a Feature Group`_).
 134
 135 |image7|
 136
 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
 141    by a red asterisk).
 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.
 145 7. Click *Save*.
 146 8. Return to step 5 of `Create a License Model`_ to complete the license model.
 147
 148 .. _doc_guide_user_des_res-onb_cre-vsp:
 149
 150 Create a Vendor Software Product
 151 --------------------------------
 152
 153 Create one or more Vendor Software Products (VSPs) as the building blocks
 154 for VFs.
 155
 156 .. note::
 157    For interim saving while creating a VSP, click |image2|
 158
 159 **Prerequisites:**
 160
 161 * `Create a License Model`_
 162 * Existing VNF HEAT package or VNF/PNF CSAR/Zip package
 163
 164 #. From the SDC HOME page, click *ONBOARD*.
 165 #. Hover over Add and select New Vendor Software Product.
 166 #. The New Software Product box is displayed.
 167     Complete all fields.
 168 #. Click *Save*.
 169     The Overview section is displayed.
 170
 171    .. note::
 172      A warning is displayed under License Agreement if the VSP does not have
 173      an associated license.
 174
 175 #. Click *Software Product Details* (left pane).
 176
 177    |image8|
 178
 179 #. In order, select a licensing version, a license agreement, and one or more
 180    feature groups.
 181 #. [Optional] Complete other fields, such as Availability (high-availability
 182    zones) and Storage Data Replication (requirement for storage replication),
 183    as required.
 184 #. In Software Product Attachments (right pane), click *Select file*.
 185 #. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
 186    In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
 187    and click *Open*.
 188 #. SDC validates the files in the package. After successful validation, SDC
 189    displays the files and a success message. If validation fails, SDC displays
 190    the errors in the files.
 191
 192    Example Heat errors:
 193
 194    |image9|
 195
 196 #. Click *Check In* to save the changes.
 197 #. Click *Submit* to add the VSP to the catalog.
 198 #. A success message is displayed. If the VSP attachments contain errors, an
 199    error message is displayed instead. Fix the issue(s) and re-submit.
 200 #. To configure VFCs associated with the VSP, see
 201    `Update VFCs in a VSP [optional]`_, below.
 202
 203
 204 .. _doc_guide_user_des_res-onb_upd-vfc:
 205
 206 Update VFCs in a VSP [optional]
 207 -------------------------------
 208
 209 If required, configure Virtual Function Components (VFCs) associated with a
 210 VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed
 211 on the Components tab.
 212
 213 .. note::
 214   All fields are optional. Answers to questionnaires are stored as metadata
 215   only on the SDC platform.
 216
 217 **Prerequisites:** Add one or more VSPs
 218                    (see `Create a Vendor Software Product`_).
 219
 220 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
 221 #. In the Overview section, click *Check Out*.
 222 #. In Components (bottom pane), click a VFC (VSP component).
 223     The component links display in the left pane.
 224 #. Click *General* to view and edit general parameters such as hypervisor,
 225    image format, VM recovery details, and DNS configuration.
 226 #. Click *Compute* to view and edit VM parameters such as the number of VMs
 227    required for a VFC instance and persistent storage/volume size.
 228 #. Click *High Availability & Load Balancing* to answer questions related
 229    to VM availability and load balancing.
 230 #. Click *Networks* to view or edit parameters related to network capacity
 231    and interfaces.
 232
 233    .. note::
 234      Click an interface to view or edit it. A dialog box displays similar
 235      to the figure below.
 236
 237    |image10|
 238
 239 #. Click *Storage* to configure storage information, such as backup type,
 240    storage size, and logging.
 241 #. Click *Process Details*, click *Add Component Process Details*, and complete
 242    the Create New Process Details dialog box. Use Process Details to identify
 243    the processes and configuration associated with VFCs.
 244 #. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling.
 245 #. Click *Overview* and click *Check In* to save changes.
 246 #. If updating a VSP, click *Submit*. If this procedure is performed during the
 247    workflow to create a VSP, there is no need to click *Submit* now.
 248
 249 .. _doc_guide_user_des_res-onb_upd-vsp:
 250
 251 Update a VSP [optional]
 252 -----------------------
 253
 254 Upload a new Heat package to a VSP. Afterward, update the VF and service.
 255
 256 **Prerequisites:** Add one or more VSPs
 257                    (see `Create a Vendor Software Product`_).
 258
 259 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
 260 #. In the Overview section, click *Check Out*.
 261 #. In Software Product Attachments (right pane), click *Select file*.
 262 #. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
 263
 264    In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
 265    and click *Open*.
 266
 267     SDC warns that uploading a new package erases existing data.
 268 #. Click *Continue* to upload the new package.
 269     SDC validates the files in the package. After successful validation, SDC
 270     displays the files and a success message. If validation fails, SDC displays
 271     the errors in the files.
 272
 273    .. note::
 274      If the Heat template contains errors, contact the Certification Group for
 275      guidance on how to proceed.
 276
 277 #. Click *Check In* to save changes.
 278 #. Click *Submit* to add the VSP to the catalog.
 279     A success message is displayed. If the VSP attachments contain errors, an
 280     error message is displayed instead. Fix the issue(s) and re-submit.
 281 #. After updating the VSP:
 282     #. Upload the VSP to the VF
 283        (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
 284     #. Update the VF version in services that include the VF (see step 4
 285        in :ref:`doc_guide_user_des_ser-des`).
 286
 287
 288 .. |image0| image:: media/sdro-resource-onboarding-workflow.png
 289
 290 .. |image1| image:: media/sdro-vsp-service-workflow.png
 291
 292 .. |image2| image:: media/sdro-sdc_vsp_save.png
 293
 294 .. |image3| image:: media/sdro-license-creation.png
 295
 296 .. |image4| image:: media/sdro-license-keygroup.png
 297
 298 .. |image5| image:: media/sdro-entitlement-pool.png
 299
 300 .. |image6| image:: media/sdro-feature-group.png
 301
 302 .. |image7| image:: media/sdro-license-agreement.png
 303
 304 .. |image8| image:: media/sdro-software-product.png
 305
 306 .. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png
 307
 308 .. |image10| image:: media/sdro-edit-nic.png