docs/guides/onap-user/design/vfcreation/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 Doc Team.  All rights reserved.
   4
   5 .. _doc_guide_user_des_vf-cre:
   6
   7 VF Creation and Testing
   8 =======================
   9 **Goal**: Using VSPs, create one or more VFs as the building blocks for a
  10 service. Validate and certify the VFs.
  11
  12 **ONAP Component**: SDC
  13
  14 **SDC user roles**: Designer, Tester
  15
  16 |image1|
  17
  18 Steps
  19 -----
  20
  21 - `Create a VF`_
  22 - `Update a VF [optional]`_
  23 - `Submit a VF for testing`_
  24 - `Test a VF`_
  25
  26 Create a VF
  27 -----------
  28
  29 **Prerequisites:**
  30
  31 - Create a license for each VF (see Create a license model) (see also the
  32   tutorial Creating a Licensing Model)
  33 - Create a Vendor Software Product.
  34
  35 **Steps**
  36
  37 #. From the SDC HOME page, click the *Vendor Software Component* icon in the
  38    header (upper right).
  39
  40    |image2|
  41
  42 #. From the Import VF box, expand a VSP name and click the *Import VSP* icon.
  43
  44    |image3|
  45
  46 #. In the General section, complete all fields.
  47
  48    .. note:: Use the letters "VF" in the name to indicate that the component is a VF.
  49
  50 #. Click *Create*.
  51
  52    - A message displays while VF creation is in progress. (This can take up to
  53      10 minutes.)
  54    - A message displays when VF creation is complete.
  55
  56 #. Click *Check In* to save changes.
  57
  58    - A box displays for confirming the changes.
  59
  60 #. Enter a comment and click *OK*.
  61
  62    - A message displays when the VF is checked in.
  63
  64 #. [Optional]  At any time before submitting the VF for testing, click these
  65    options to update VF information:
  66
  67    .. note:: These tasks can be done only before submitting the VF for testing.
  68
  69    - Icon ??? change the icon associated with the VF (vendor-supplied icons are
  70      preferred)
  71    - Deployment Artifacts ??? download, view, modify, or change VF deployment
  72      artifacts (for example, the contents of the Heat .zip file, which contains
  73      the Heat volume template, the VF license, etc.)
  74    - Information Artifacts ??? view or upload artifacts, such as test scripts, test
  75      results, or the AIC questionnaire
  76    - TOSCA Artifacts ??? view or upload the TOSCA model or the TOSCA template
  77    - Properties ??? define or update VF properties (not used in Release 1)
  78    - Composition ??? view or edit the graphical representation of the resource-level
  79      TOSCA model (generated from the Heat template)
  80    - Activity Log ??? view activity related to assets associated with the VF
  81      (displays the action, date, user, status, and any comments related to each
  82      action)
  83    - Deployment ??? view VF modules defined in the Heat template
  84    - Inputs ??? view inputs defined for the resource-level TOSCA model
  85
  86 #. After creating a VF, submit it for testing (see `Submit a VF for testing`_).
  87
  88 Update a VF [optional]
  89 ----------------------
  90
  91 - Update the VSP and other artifacts in a VF.
  92 - Upload a new version the VSP to the VF whenever the VSP is updated (see steps
  93   3 to 5). Other reasons for updating a VF include:
  94
  95   - artifact changes at the VF level that need be uploaded, for example,
  96     changes to ENV values (see step 6)
  97
  98 **Prerequisites:**
  99
 100 - `Create a VF`_.
 101 - If the VSP was updated: Update a VSP [optional]
 102
 103 **Steps**
 104
 105 #. From the SDC HOME page, click *CATALOG* and search for a VF.
 106
 107 #. In the General section, click *Check Out*.
 108    The Select VSP field is displays.
 109
 110 #. In the Select VSP field, click *Browse*.
 111    The Import VF box displays and shows the VSP that was used to create the VF.
 112
 113 #. Expand the VSP field and click.
 114
 115    |image4|
 116
 117 #. Click |image5|
 118    A progress bar displays. |image6|
 119
 120 #. Click *Deployment Artifact* to edit, upload, or delete associated [Optional]
 121    deployment artifacts.
 122
 123 #. Click *Information Artifact* and edit, upload, or delete associated
 124    [Optional] information artifacts.
 125
 126 #. Click *Check In* to save changes.
 127
 128 #. After updating the VF:
 129
 130    - Submit the VF for testing (see Submit a VF for testing).
 131    - Update the VF version in any service that contains the VF
 132      (see step 4 in Update a service [optional]).
 133
 134 Submit a VF for testing
 135 -----------------------
 136
 137 **Prerequisites:** `Create a VF`_
 138
 139 **Steps**
 140
 141 #. When a VF is ready for testing, click *CATALOG* and service for the VF.
 142 #. Click the VF and click *Submit for Testing*.
 143
 144    |image7|
 145
 146    |image8|
 147
 148 #. Enter a message for the testers asking that they begin service certification
 149    and click *OK*.
 150
 151    The default mail client launches with a draft email containing the message.
 152
 153 #. Add the email addresses of the people on the Certification Group for this
 154    site with the *Tester* role and send the email.
 155
 156 Test a VF
 157 ---------
 158
 159 Test the design and artifacts of a VF.
 160
 161 **Prerequisites:** `Submit a VF for testing`_.
 162
 163 **Steps**
 164
 165 #. Sign in to SDC as a *Tester*.
 166 #. From the HOME page, select *Ready For Testing* under Active Projects.
 167 #. In the right pane, click the VF.
 168 #. Click *Start Testing*.
 169 #. Test the VF.
 170 #. When testing is complete, click *Accept*.
 171
 172 .. |image1| image:: media/design_vf_workflow.png
 173 .. |image2| image:: media/image2017-1-27_11-13-30.png
 174 .. |image3| image:: media/image2017-1-27_11-14-3.png
 175 .. |image4| image:: media/image2017-1-27_11-17-18.png
 176 .. |image5| image:: media/sdc_artifact_update.png
 177 .. |image6| image:: media/design_vf_updatevspmessage.png
 178 .. |image7| image:: media/image2017-1-27_11-20-13.png
 179 .. |image8| image:: media/image2017-1-27_11-21-4.png