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