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, instantiate, and manage a VF and, optionally, a VFC.
  10
  11 **Tool:** SDC
  12
  13 **SDC user role:** Designer
  14
  15 |image0|
  16
  17 **Steps**
  18     * `Create a License Model`_
  19     * `Create a License Key Group [Optional]`_
  20     * `Create an Entitlement Pool`_
  21     * `Create a Feature Group`_
  22     * `Create a License Agreement`_
  23     * `Create a Vendor Software Product`_
  24     * `Update VFCs in a VSP [optional]`_
  25     * `Update a VSP [optional]`_
  26
  27 After updating the artifacts in a VSP, also update:
  28     * the VF created from the VSP
  29     * any services that include the VF
  30
  31 |image1|
  32
  33 Create a License Model
  34 ----------------------
  35
  36 VSPs optionally require a license and entitlements to enable the service provider to track the usage.
  37
  38 Note: For interim saving while creating the license model and its components, click |image2|
  39
  40 **Prerequisites:** To obtain license information, contact the service provider's Supply Chain Management (SCM) group.
  41
  42 |image3|
  43
  44 #. From the SDC HOME page, click *ONBOARD*.
  45 #. Hover over Add and select New License Model.
  46 #. Complete all fields.
  47 #. Click *Save*.
  48 #. In the ONBOARD header, hover over the arrow after License Agreements to reveal a menu.
  49    Select the following options in order:
  50
  51    #. Create 0 or more license key groups (see `Create a License Key Group [Optional]`_).
  52    #. Create 1 or more entitlement pools (see `Create an Entitlement Pool`_).
  53    #. Create 1 or more feature groups (see `Create a Feature Group`_).
  54    #. Create 1 or more license agreements (see `Create a License Agreement`_).
  55
  56       Note: Perform all steps above before submitting the license model to the SDC catalog.
  57
  58 #. In the header, click the license model created in steps 1 to 4.
  59 #. Click *Check In* to save changes.
  60 #. Click *Submit* to add the license model to the catalog. A success message displays.
  61 #. After creating a license, complete `Create a Vendor Software Product`_ to add the VSP required for the associated VF.
  62
  63 Create a License Key Group [Optional]
  64 -------------------------------------
  65
  66 If required by the resource model, create one or more license key groups; otherwise the license key group is optional.
  67
  68 **Prerequisites:** `Create a License Model`_
  69
  70 |image4|
  71
  72 1. From the drop-down menu, select License Key Groups.
  73 2. Click *Add License Key Group*.
  74     The Create New License Key Group box displays.
  75 3. Complete all fields.
  76     Note: Enter the manufacturer reference number in the Name field.
  77 4. Click *Save*.
  78
  79 Create an Entitlement Pool
  80 --------------------------
  81
  82 **Prerequisites:** If required by the resource model, create one or more license key groups (see `Create a License Key Group [Optional]`_).
  83
  84 |image5|
  85
  86 1. From the drop-down menu, select Entitlement Pools.
  87 2. Click *Add Entitlement Pool*.
  88     The Create New Entitlement Pool box displays.
  89 3. Complete required fields (mandatory fields are marked by a red asterisk).
  90 4. Click *Save*.
  91
  92 Create a Feature Group
  93 ----------------------
  94
  95 **Prerequisites:** Create one or more:
  96
  97 * license key groups if required by the resource model (see `Create a License Key Group [optional]`_)
  98 * entitlement pools (see `Create an Entitlement Pool`_)
  99
 100 |image6|
 101
 102 1. From the drop-down menu, select Feature Groups.
 103 2. Click *Add Feature Group*.
 104     The Create New Feature Group box displays.
 105 3. On the General tab, complete all fields.
 106 4. Click *Entitlement Pools*.
 107 5. Click *Available Entitlement Pools*.
 108 6. Select one or more entitlement pools and click the right arrow.
 109 7. Click *License Key Groups*.
 110 8. Click *Available License Key Groups*.
 111 9. Select one or more license key groups and click the right arrow.
 112 10. Click *Save*.
 113
 114 Create a License Agreement
 115 --------------------------
 116
 117 **Prerequisites:** Create one or more feature groups (see `Create a Feature Group`_).
 118
 119 |image7|
 120
 121 1. From the drop-down menu, select License Agreements.
 122 2. Click *Add License Agreement*.
 123     The Create New License Agreement box displays.
 124 3. On the General tab, complete required fields (mandatory fields are marked by a red asterisk).
 125 4. Click *Feature Groups*.
 126 5. If not selected, click *Available Feature Groups*.
 127 6. Select one or more groups and click the right arrow.
 128 7. Click *Save*.
 129 8. Return to step 5 of `Create a License Model`_ to complete the license model.
 130
 131 Create a Vendor Software Product
 132 --------------------------------
 133
 134 Create one or more Vendor Software Products (VSPs) as the building blocks for VFs.
 135
 136 .. note::
 137    For interim saving while creating a VSP, click |image2|
 138
 139 **Prerequisites:**
 140
 141 * `Create a License Model`_
 142 * Generate manifest and package artifacts.
 143
 144 #. From the SDC HOME page, click *ONBOARD*.
 145 #. Hover over Add and select New Vendor Software Product.
 146 #. The New Software Product box is displayed.
 147     Complete all fields.
 148 #. Click *Save*.
 149     The Overview section is displayed.
 150
 151    .. note::
 152      A warning is displayed under License Agreement if the VSP does not have an associated license.
 153
 154 #. Click *Software Product Details* (left pane).
 155
 156    |image8|
 157
 158 #. In order, select a licensing version, a license agreement, and one or more feature groups.
 159 #. [Optional] Complete other fields, such as Availability (high-availability zones) and Storage
 160    Data Replication (requirement for storage replication), as required.
 161 #. In Software Product Attachments (right pane), click *Select file*.
 162 #. Locate a Heat .zip package and click *Open*.
 163    SDC validates the files in the package. After successful validation, SDC displays the files
 164    and a success message. If validation fails, SDC displays the errors in the files.
 165
 166    Example Heat errors:
 167
 168    |image9|
 169
 170 #. Click *Check In* to save the changes.
 171 #. Click *Submit* to add the VSP to the catalog.
 172 #. A success message is displayed. If the VSP attachments contain errors, an error message is displayed instead. Fix the issue(s) and re-submit.
 173 #. To configure VFCs associated with the VSP, see `Update VFCs in a VSP [optional]`_, below.
 174
 175
 176 Update VFCs in a VSP [optional]
 177 -------------------------------
 178
 179 If required, configure Virtual Function Components (VFCs) associated with a VSP, such as the Hypervisor, VM recovery details, and cloning. VFCs are listed on the Components tab.
 180
 181 .. note::
 182   All fields are optional. Answers to questionnaires are stored as metadata only on the SDC platform.
 183
 184 **Prerequisites:** Add one or more VSPs (see `Create a Vendor Software Product`_).
 185
 186 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
 187 #. In the Overview section, click *Check Out*.
 188 #. In Components (bottom pane), click a VFC (VSP component).
 189     The component links display in the left pane.
 190 #. Click *General* to view and edit general parameters such as hypervisor, image format, VM recovery details, and DNS configuration.
 191 #. Click *Compute* to view and edit VM parameters such as the number of VMs required for a VFC instance and persistent storage/volume size.
 192 #. Click *High Availability & Load Balancing* to answer questions related to VM availability and load balancing.
 193 #. Click *Networks* to view or edit parameters related to network capacity and interfaces.
 194
 195    .. note::
 196      Click an interface to view or edit it. A dialog box displays similar to the figure below.
 197
 198    |image10|
 199
 200 #. Click *Storage* to configure storage information, such as backup type, storage size, and logging.
 201 #. Click *Process Details*, click *Add Component Process Details*, and complete the Create New Process Details dialog box. Use Process Details to identify the processes and configuration associated with VFCs.
 202 #. Click *Monitoring* to upload MIB or JSON files for SNMP traps and polling.
 203 #. Click *Overview* and click *Check In* to save changes.
 204 #. If updating a VSP, click *Submit*. If this procedure is performed during the workflow to create a VSP, there is no need to click *Submit* now.
 205
 206 Update a VSP [optional]
 207 -----------------------
 208
 209 Upload a new Heat package to a VSP. Afterward, update the VF and service.
 210
 211 **Prerequisites:** Add one or more VSPs (see `Create a Vendor Software Product`_).
 212
 213 #. From the SDC HOME page, click *ONBOARD* and search for a VSP.
 214 #. In the Overview section, click *Check Out*.
 215 #. In Software Product Attachments (right pane), click *Select file*.
 216 #. Locate a Heat .zip package and click *Open*.
 217     SDC warns that uploading a new package erases existing data.
 218 #. Click *Continue* to upload the new Heat package.
 219     SDC validates the files in the package. After successful validation, SDC displays the files and a success message. If validation fails, SDC displays the errors in the files.
 220
 221    .. note::
 222      If the Heat template contains errors, contact the Certification Group for guidance on how to proceed.
 223
 224 #. Click *Check In* to save changes.
 225 #. Click *Submit* to add the VSP to the catalog.
 226     A success message is displayed. If the VSP attachments contain errors, an error message is displayed instead. Fix the issue(s) and re-submit.
 227 #. After updating the VSP:
 228    #. Upload the VSP to the VF (see steps 3 to 5 in (TBD)Update a VF [optional]).
 229    #. Update the VF version in services that include the VF (see step 4 in (TBD) Update a service [optional]).
 230
 231
 232 .. |image0| image:: media/sdro-resource-onboarding-workflow.png
 233
 234 .. |image1| image:: media/sdro-vsp-service-workflow.png
 235
 236 .. |image2| image:: media/sdro-sdc_vsp_save.png
 237
 238 .. |image3| image:: media/sdro-license-creation.png
 239
 240 .. |image4| image:: media/sdro-license-keygroup.png
 241
 242 .. |image5| image:: media/sdro-entitlement-pool.png
 243
 244 .. |image6| image:: media/sdro-feature-group.png
 245
 246 .. |image7| image:: media/sdro-license-agreement.png
 247
 248 .. |image8| image:: media/sdro-software-product.png
 249
 250 .. |image9| image:: media/sdro-design_onboardvsp_heaterrors.png
 251
 252 .. |image10| image:: media/sdro-edit-nic.png