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/PNF Creation and Testing
   8 ===========================
   9 **Goal**: Using VSPs, create one or more VFs/PNFs as the building blocks for a
  10 service. Validate and certify the VFs/PNFs.
  11
  12 **ONAP Component**: SDC
  13
  14 **SDC user roles**: Designer
  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 - `Certify VF/PNF`_
  25
  26 .. _doc_guide_user_des_vf-cre_cre-imp:
  27
  28 Create a VF/PNF by VSP import
  29 -----------------------------
  30
  31 **Prerequisites:** (see :ref:`doc_guide_user_des_res-onb` )
  32
  33 - Create a license for each VF/PNF
  34 - Create a Vendor Software Product.
  35
  36 **Steps**
  37
  38 #. From the SDC HOME page, click the *Import VSP*
  39
  40    |image2|
  41
  42 #. From the *Import VSP* 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    |image10|
  49
  50 #. Click *Create*.
  51
  52    - A message displays while creation is in progress. (This can take up to
  53      10 minutes.)
  54    - A message displays when creation is complete.
  55
  56
  57 #. [Optional]  At any time before checking in the VF/PNF, click
  58    these options to update VF/PNF information:
  59
  60    .. note:: These tasks can be done only before certifying the VF/PNF.
  61
  62    - **General->Icon** change the icon associated with the VF/PNF
  63      (vendor-supplied icons are preferred)
  64    - **Deployment Artifacts** download, view, modify, or change deployment
  65      artifacts (for example, the contents of the Heat .zip file, which contains
  66      the Heat volume template, the license, CDS Blueprints,...)
  67    - **Information Artifacts** view or upload artifacts, such as test
  68      scripts, test results, or the AIC questionnaire
  69    - **TOSCA Artifacts** view or upload the TOSCA model or the TOSCA template
  70    - **Composition** view or edit the graphical representation of the resource-level
  71      TOSCA model (generated from the Heat template)
  72    - **Activity Log** view activity related to assets associated with the VF/PNF
  73      (displays the action, date, user, status, and any comments related to each
  74      action)
  75    - **Deployment** view VF modules defined in the Heat template
  76    - **Properties Assignment** define or update properties and input parameters
  77      and policies
  78    - **Req.& Capabilities** view and add requirements and capabilities
  79
  80 #. Click *Check In* to save changes.
  81
  82    - A box to enter comments for confirming the changes open.
  83
  84 #. Enter a comment and click *OK*.
  85
  86    - A message displays when the VF/PNF is checked in and you are redirected
  87      to the Home screen.
  88 #. After creating and checking a VF/PNF, certify it (see `Certify VF/PNF`_).
  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    |image2|
 100
 101 #. In the General section, complete all fields.
 102
 103 #. Before check-in the VF/PNF, click these
 104    options to update VF/PNF information:
 105
 106    .. note:: These tasks can be done only before certifying the VF/PNF.
 107
 108    - **General->Icon** change the icon associated with the VF/PNF
 109      (vendor-supplied icons are preferred)
 110    - **Deployment Artifacts** download, view, modify, or change deployment
 111      artifacts (for example, the contents of the Heat .zip file, which contains
 112      the Heat volume template, the license, CDS Blueprints,...)
 113    - **Information Artifacts** view or upload artifacts, such as test
 114      scripts, test results, or the AIC questionnaire
 115    - **TOSCA Artifacts** view or upload the TOSCA model or the TOSCA template
 116    - **Composition** view or edit the graphical representation of the resource-level
 117      TOSCA model (generated from the Heat template)
 118    - **Activity Log** view activity related to assets associated with the VF/PNF
 119      (displays the action, date, user, status, and any comments related to each
 120      action)
 121    - **Deployment** view VF modules defined in the Heat template
 122    - **Properties Assignment** define or update properties and input parameters
 123      and policies
 124    - **Req.& Capabilities** view and add requirements and capabilities
 125
 126 #. Click *Create*.
 127
 128    - A message displays while creation is in progress. (This can take up to
 129      10 minutes.)
 130    - A message displays when creation is complete.
 131
 132 #. Click *Check In* to save changes.
 133
 134    - A box to enter comments for confirming the changes open.
 135
 136 #. Enter a comment and click *OK*.
 137
 138    - A message displays when the VF/PNF is checked in and you are redirected
 139      to the Home screen.
 140 #. After creating and checking a VF/PNF, certify it (see `Certify VF/PNF`_).
 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/PNF.
 149 - Upload a new version the VSP to the VF/PNF whenever the VSP is updated
 150   (see steps  3 to 5).
 151 - Other reasons for updating a VF/PNF include:
 152
 153   - artifact changes at the VF/PNF level that need be uploaded, for example,
 154     changes to ENV values (see step 6)
 155
 156 **Prerequisites:**
 157
 158 - `Create a VF/PNF by VSP import`_ or `Create a VF/PNF manually`_
 159 - If the VSP was updated: :ref:`doc_guide_user_des_res-onb_upd-vsp`
 160
 161 **Steps**
 162
 163 #. From the SDC HOME page, click *CATALOG* and search for the VF/PNF.
 164
 165 #. In the General section, click *Check Out*.
 166    The *VSP* field is displays.
 167
 168 #. In the *VSP* field, click *Browse*.
 169    The *Import VSP* box displays and shows the VSP that was used to create the VF/PNF.
 170
 171 #. Expand the VSP field and click.
 172
 173    |image4|
 174
 175 #. Click *Update VSP*
 176    A progress bar displays.|image5|
 177
 178 #. Click *Deployment Artifact* to edit, upload, or delete associated [Optional]
 179    deployment artifacts.
 180
 181 #. Click *Information Artifact* and edit, upload, or delete associated
 182    [Optional] information artifacts.
 183
 184 #. Click *Check In* to save changes.
 185
 186    - A box to enter comments for confirming the changes open.
 187
 188 #. Enter a comment and click *OK*.
 189
 190    - A message displays when the VF/PNF is checked in and you are redirected
 191      to the Home screen.
 192 #. After updating the VF/PNF:
 193
 194    - Certify it (see `Certify VF/PNF`_).
 195    - Update the VF/PNF version in any service that contains the VF/PNF,
 196      please go to :ref:`doc_guide_user_des_ser-upd_serv`
 197
 198 .. _doc_guide_user_des_vf-cre_sub-tst:
 199
 200 Certify VF/PNF
 201 --------------
 202
 203 **Prerequisites:** `Create a VF/PNF by VSP import`_ or
 204 `Create a VF/PNF manually`_
 205
 206 **Steps**
 207
 208 #. When a VF/PNF is ready for certification,
 209    click *CATALOG* and search for the checked-in VF/PNF.
 210 #. Click the VF/PNF and click *Certify*.
 211
 212    |image7|
 213
 214    |image8|
 215
 216 #. Enter a comment and click *OK*.
 217
 218 #. A Message appears, that the VF/PNF is certified.
 219
 220
 221 .. |image1| image:: media/sdc-vf-workflow.png
 222 .. |image2| image:: media/sdc-home.png
 223 .. |image3| image:: media/sdc-Import.png
 224 .. |image4| image:: media/sdc-vsp-update.png
 225 .. |image5| image:: media/sdc_artifact_update.png
 226 .. |image6| image:: media/design_vf_updatevspmessage.png
 227 .. |image7| image:: media/sdc-vf-general-certify.png
 228 .. |image8| image:: media/sdc-vf-certify-confirm.png
 229 .. |image9| image:: media/SDC-Add.png
 230 .. |image10| image:: media/sdc-vf-general.png