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