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/PNF by VSP import`_
  22 - `Create a VF/PNF manually`_
  23 - `Update a VF/PNF [optional]`_
  24 - `Submit for testing`_
  25 - `Test a VF/PNF`_
  26
  27 .. _doc_guide_user_des_vf-cre_cre-imp:
  28
  29 Create a VF/PNF by VSP import
  30 -----------------------------
  31
  32 **Prerequisites:** (see :ref:`doc_guide_user_des_res-onb` )
  33
  34 - Create a license for each VF/PNF
  35 - Create a Vendor Software Product.
  36
  37 **Steps**
  38
  39 #. From the SDC HOME page, click the *Import VSP*
  40
  41    |image2|
  42
  43 #. From the *Import VF* box, expand a VSP name and click the *Import VSP* icon.
  44
  45    |image3|
  46
  47 #. In the General section, complete all fields.
  48
  49    .. note:: Use the letters "VF" or "PNF" in the name to indicate that the
  50              component type.
  51
  52 #. Click *Create*.
  53
  54    - A message displays while creation is in progress. (This can take up to
  55      10 minutes.)
  56    - A message displays when creation is complete.
  57
  58 #. Click *Check In* to save changes.
  59
  60    - A box displays for confirming the changes.
  61
  62 #. Enter a comment and click *OK*.
  63
  64    - A message displays when the VF/PNF is checked in.
  65
  66 #. [Optional]  At any time before submitting the VF/PNF for testing, click
  67    these options to update VF/PNF information:
  68
  69    .. note:: These tasks can be done only before submitting the VF for testing.
  70
  71    - **Icon** change the icon associated with the VF/PNF (vendor-supplied icons
  72      are preferred)
  73    - **Deployment Artifacts** download, view, modify, or change deployment
  74      artifacts (for example, the contents of the Heat .zip file, which contains
  75      the Heat volume template, the license, etc.)
  76    - **Information Artifacts** view or upload artifacts, such as test scripts, test
  77      results, or the AIC questionnaire
  78    - **TOSCA Artifacts** view or upload the TOSCA model or the TOSCA template
  79    - **Properties** define or update properties
  80    - **Composition** view or edit the graphical representation of the resource-level
  81      TOSCA model (generated from the Heat template)
  82    - **Activity Log** view activity related to assets associated with the VF/PNF
  83      (displays the action, date, user, status, and any comments related to each
  84      action)
  85    - **Deployment** view VF modules defined in the Heat template
  86    - **Inputs** view inputs defined for the resource-level TOSCA model
  87
  88 #. After creating a VF/PNF, submit it for testing (see `Submit for testing`_).
  89
  90 .. _doc_guide_user_des_vf-cre_cre-man:
  91
  92 Create a VF/PNF manually
  93 ------------------------
  94
  95 **Steps**
  96
  97 #. From the SDC HOME page, click the *Add VF* or *Add PNF*
  98
  99    |image9|
 100
 101 #. In the General section, complete all fields.
 102
 103 #. Before submitting the VF/PNF for testing, click these
 104    options to update VF/PNF information:
 105
 106    .. note:: These tasks can be done only before submitting the VF/PNF for testing.
 107
 108    - **Icon** change the icon associated with the VF/PNF (vendor-supplied icons are
 109      preferred)
 110    - **Deployment Artifacts** download, view, modify, or change VF/PNF deployment
 111      artifacts (for example, the contents of the Heat .zip file, which contains
 112      the Heat volume template, the VF license, etc.)
 113    - **Information Artifacts** view or upload artifacts, such as test scripts, test
 114      results, or the AIC questionnaire
 115    - **TOSCA Artifacts** view or download the TOSCA model or the TOSCA template
 116    - **Properties** define or update properties
 117    - **Composition** view or edit the graphical representation of the resource-level
 118      TOSCA model (generated from the Heat template)
 119    - **Activity Log** view activity related to assets associated with the VF/PNF
 120      (displays the action, date, user, status, and any comments related to each
 121      action)
 122    - **Deployment** view VF modules defined in the Heat template
 123    - **Inputs** view inputs defined for the resource-level TOSCA model
 124
 125 #. Click *Create*.
 126
 127    - A message displays while creation is in progress. (This can take up to
 128      10 minutes.)
 129    - A message displays when creation is complete.
 130
 131 #. Click *Check In* to save changes.
 132
 133    - A box displays for confirming the changes.
 134
 135 #. Enter a comment and click *OK*.
 136
 137    - A message displays when the is checked in.
 138
 139
 140 #. After creating a VF/PNF, submit it for testing (see `Submit for testing`_).
 141
 142
 143 .. _doc_guide_user_des_vf-cre_vf-upd:
 144
 145 Update a VF/PNF [optional]
 146 --------------------------
 147
 148 - Update the VSP and other artifacts in a VF.
 149 - Upload a new version the VSP to the VF whenever the VSP is updated (see steps
 150   3 to 5). Other reasons for updating a VF include:
 151
 152   - artifact changes at the VF level that need be uploaded, for example,
 153     changes to ENV values (see step 6)
 154
 155 **Prerequisites:**
 156
 157 - `Create a VF/PNF by VSP import`_ or `Create a VF/PNF manually`_
 158 - If the VSP was updated: :ref:`doc_guide_user_des_res-onb_upd-vsp`
 159
 160 **Steps**
 161
 162 #. From the SDC HOME page, click *CATALOG* and search for a VF.
 163
 164 #. In the General section, click *Check Out*.
 165    The Select VSP field is displays.
 166
 167 #. In the Select VSP field, click *Browse*.
 168    The Import VF box displays and shows the VSP that was used to create the VF.
 169
 170 #. Expand the VSP field and click.
 171
 172    |image4|
 173
 174 #. Click |image5|
 175    A progress bar displays. |image6|
 176
 177 #. Click *Deployment Artifact* to edit, upload, or delete associated [Optional]
 178    deployment artifacts.
 179
 180 #. Click *Information Artifact* and edit, upload, or delete associated
 181    [Optional] information artifacts.
 182
 183 #. Click *Check In* to save changes.
 184
 185 #. After updating the VF:
 186
 187    - Submit the VF for testing (see `Submit for testing`_).
 188    - Update the VF version in any service that contains the VF
 189      (see step 4 in Update a service [optional]).
 190
 191 .. _doc_guide_user_des_vf-cre_sub-tst:
 192
 193 Submit for testing
 194 ------------------
 195
 196 **Prerequisites:** `Create a VF/PNF by VSP import`_ or
 197 `Create a VF/PNF manually`_
 198
 199 **Steps**
 200
 201 #. When a VF/PNF is ready for testing, click *CATALOG* and service for the
 202    VF/PNF.
 203 #. Click the VF/PNF and click *Submit for Testing*.
 204
 205    |image7|
 206
 207    |image8|
 208
 209 #. Enter a message for the testers asking that they begin service certification
 210    and click *OK*.
 211
 212    The default mail client launches with a draft email containing the message.
 213
 214 #. Add the email addresses of the people on the Certification Group for this
 215    site with the *Tester* role and send the email.
 216
 217 .. _doc_guide_user_des_vf-cre_tst-vf:
 218
 219 Test a VF/PNF
 220 -------------
 221
 222 Test the design and artifacts of a VF/PNF.
 223
 224 **Prerequisites:** `Submit for testing`_
 225
 226 **Steps**
 227
 228 #. Sign in to SDC as a *Tester*.
 229 #. From the HOME page, select *Ready For Testing* under Active Projects.
 230 #. In the right pane, click the VF.
 231 #. Click *Start Testing*.
 232 #. Test the VF.
 233 #. When testing is complete, click *Accept*.
 234
 235 .. |image1| image:: media/design_vf_workflow.png
 236 .. |image2| image:: media/SDC-Import.png
 237 .. |image3| image:: media/image2017-1-27_11-14-3.png
 238 .. |image4| image:: media/image2017-1-27_11-17-18.png
 239 .. |image5| image:: media/sdc_artifact_update.png
 240 .. |image6| image:: media/design_vf_updatevspmessage.png
 241 .. |image7| image:: media/image2017-1-27_11-20-13.png
 242 .. |image8| image:: media/image2017-1-27_11-21-4.png
 243 .. |image9| image:: media/SDC-Add.png
 244