Changed User Design Guides to reflect the changes in the SDC in Frankfurt
[doc.git] / docs / guides / onap-user / design / vfcreation / index.rst
index 3913066..14928bb 100644 (file)
 .. International License. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2019 ONAP Doc Team.  All rights reserved.
 
-.. _vfcreation-and-testing:
+.. _doc_guide_user_des_vf-cre:
 
-VF Creation and Testing
-=======================
-**Goal**: Using VSPs, create one or more VFs as the building blocks for a
-service. Validate and certify the VFs.
+VF/PNF Creation and Testing
+===========================
+**Goal**: Using VSPs, create one or more VFs/PNFs as the building blocks for a
+service. Validate and certify the VFs/PNFs.
 
 **ONAP Component**: SDC
 
-**SDC user roles**: Designer, Tester
+**SDC user roles**: Designer
 
 |image1|
 
 Steps
 -----
 
-- `Create a VF`_
-- `Update a VF [optional]`_
-- `Submit a VF for testing`_
-- `Test a VF`_
+- `Create a VF/PNF by VSP import`_
+- `Create a VF/PNF manually`_
+- `Update a VF/PNF [optional]`_
+- `Certify VF/PNF`_
 
-Create a VF
------------
+.. _doc_guide_user_des_vf-cre_cre-imp:
 
-**Prerequisites:**
+Create a VF/PNF by VSP import
+-----------------------------
+
+**Prerequisites:** (see :ref:`doc_guide_user_des_res-onb` )
 
-- Create a license for each VF (see Create a license model) (see also the
-  tutorial Creating a Licensing Model)
+- Create a license for each VF/PNF
 - Create a Vendor Software Product.
 
 **Steps**
 
-#. From the SDC HOME page, click the *Vendor Software Component* icon in the
-   header (upper right).
+#. From the SDC HOME page, click the *Import VSP*
 
    |image2|
 
-#. From the Import VF box, expand a VSP name and click the *Import VSP* icon.
+#. From the *Import VSP* box, expand a VSP name and click the *Import VSP* icon.
 
    |image3|
 
 #. In the General section, complete all fields.
 
-   .. note:: Use the letters "VF" in the name to indicate that the component is a VF.
+   |image10|
 
 #. Click *Create*.
 
-   - A message displays while VF creation is in progress. (This can take up to
+   - A message displays while creation is in progress. (This can take up to
      10 minutes.)
-   - A message displays when VF creation is complete.
+   - A message displays when creation is complete.
+
+
+#. [Optional]  At any time before checking in the VF/PNF, click
+   these options to update VF/PNF information:
+
+   .. note:: These tasks can be done only before certifying the VF/PNF.
+
+   - **General->Icon** change the icon associated with the VF/PNF
+     (vendor-supplied icons are preferred)
+   - **Deployment Artifacts** download, view, modify, or change deployment
+     artifacts (for example, the contents of the Heat .zip file, which contains
+     the Heat volume template, the license, CDS Blueprints,...)
+   - **Information Artifacts** view or upload artifacts, such as test
+     scripts, test results, or the AIC questionnaire
+   - **TOSCA Artifacts** view or upload the TOSCA model or the TOSCA template
+   - **Composition** view or edit the graphical representation of the resource-level
+     TOSCA model (generated from the Heat template)
+   - **Activity Log** view activity related to assets associated with the VF/PNF
+     (displays the action, date, user, status, and any comments related to each
+     action)
+   - **Deployment** view VF modules defined in the Heat template
+   - **Properties Assignment** define or update properties and input parameters
+     and policies
+   - **Req.& Capabilities** view and add requirements and capabilities
 
 #. Click *Check In* to save changes.
 
-   - A box displays for confirming the changes.
+   - A box to enter comments for confirming the changes open.
 
 #. Enter a comment and click *OK*.
 
-   - A message displays when the VF is checked in.
+   - A message displays when the VF/PNF is checked in and you are redirected
+     to the Home screen.
+#. After creating and checking a VF/PNF, certify it (see `Certify VF/PNF`_).
 
-#. [Optional]  At any time before submitting the VF for testing, click these
-   options to update VF information:
+.. _doc_guide_user_des_vf-cre_cre-man:
 
-   .. note:: These tasks can be done only before submitting the VF for testing.
+Create a VF/PNF manually
+------------------------
 
-   - Icon ??? change the icon associated with the VF (vendor-supplied icons are
-     preferred)
-   - Deployment Artifacts ??? download, view, modify, or change VF deployment
+**Steps**
+
+#. From the SDC HOME page, click the *ADD VF* or *ADD PNF*
+
+   |image2|
+
+#. In the General section, complete all fields.
+
+#. Before check-in the VF/PNF, click these
+   options to update VF/PNF information:
+
+   .. note:: These tasks can be done only before certifying the VF/PNF.
+
+   - **General->Icon** change the icon associated with the VF/PNF
+     (vendor-supplied icons are preferred)
+   - **Deployment Artifacts** download, view, modify, or change deployment
      artifacts (for example, the contents of the Heat .zip file, which contains
-     the Heat volume template, the VF license, etc.)
-   - Information Artifacts ??? view or upload artifacts, such as test scripts, test
-     results, or the AIC questionnaire
-   - TOSCA Artifacts ??? view or upload the TOSCA model or the TOSCA template
-   - Properties ??? define or update VF properties (not used in Release 1)
-   - Composition ??? view or edit the graphical representation of the resource-level
+     the Heat volume template, the license, CDS Blueprints,...)
+   - **Information Artifacts** view or upload artifacts, such as test
+     scripts, test results, or the AIC questionnaire
+   - **TOSCA Artifacts** view or upload the TOSCA model or the TOSCA template
+   - **Composition** view or edit the graphical representation of the resource-level
      TOSCA model (generated from the Heat template)
-   - Activity Log ??? view activity related to assets associated with the VF
+   - **Activity Log** view activity related to assets associated with the VF/PNF
      (displays the action, date, user, status, and any comments related to each
      action)
-   - Deployment ??? view VF modules defined in the Heat template
-   - Inputs ??? view inputs defined for the resource-level TOSCA model
+   - **Deployment** view VF modules defined in the Heat template
+   - **Properties Assignment** define or update properties and input parameters
+     and policies
+   - **Req.& Capabilities** view and add requirements and capabilities
+
+#. Click *Create*.
+
+   - A message displays while creation is in progress. (This can take up to
+     10 minutes.)
+   - A message displays when creation is complete.
+
+#. Click *Check In* to save changes.
+
+   - A box to enter comments for confirming the changes open.
+
+#. Enter a comment and click *OK*.
+
+   - A message displays when the VF/PNF is checked in and you are redirected
+     to the Home screen.
+#. After creating and checking a VF/PNF, certify it (see `Certify VF/PNF`_).
+
 
-#. After creating a VF, submit it for testing (see `Submit a VF for testing`_).
+.. _doc_guide_user_des_vf-cre_vf-upd:
 
-Update a VF [optional]
-----------------------
+Update a VF/PNF [optional]
+--------------------------
 
-- Update the VSP and other artifacts in a VF.
-- Upload a new version the VSP to the VF whenever the VSP is updated (see steps
-  3 to 5). Other reasons for updating a VF include:
+- Update the VSP and other artifacts in a VF/PNF.
+- Upload a new version the VSP to the VF/PNF whenever the VSP is updated
+  (see steps  3 to 5).
+- Other reasons for updating a VF/PNF include:
 
-  - artifact changes at the VF level that need be uploaded, for example,
+  - artifact changes at the VF/PNF level that need be uploaded, for example,
     changes to ENV values (see step 6)
 
 **Prerequisites:**
 
-- `Create a VF`_.
-- If the VSP was updated: Update a VSP [optional]
+- `Create a VF/PNF by VSP import`_ or `Create a VF/PNF manually`_
+- If the VSP was updated: :ref:`doc_guide_user_des_res-onb_upd-vsp`
 
 **Steps**
 
-#. From the SDC HOME page, click *CATALOG* and search for a VF.
+#. From the SDC HOME page, click *CATALOG* and search for the VF/PNF.
 
 #. In the General section, click *Check Out*.
-   The Select VSP field is displays.
+   The *VSP* field is displays.
 
-#. In the Select VSP field, click *Browse*.
-   The Import VF box displays and shows the VSP that was used to create the VF.
+#. In the *VSP* field, click *Browse*.
+   The *Import VSP* box displays and shows the VSP that was used to create the VF/PNF.
 
 #. Expand the VSP field and click.
 
    |image4|
 
-#. Click |image5|
-   A progress bar displays. |image6|
+#. Click *Update VSP*
+   A progress bar displays.|image5|
 
 #. Click *Deployment Artifact* to edit, upload, or delete associated [Optional]
    deployment artifacts.
@@ -125,55 +183,48 @@ Update a VF [optional]
 
 #. Click *Check In* to save changes.
 
-#. After updating the VF:
+   - A box to enter comments for confirming the changes open.
 
-   - Submit the VF for testing (see Submit a VF for testing).
-   - Update the VF version in any service that contains the VF
-     (see step 4 in Update a service [optional]).
+#. Enter a comment and click *OK*.
 
-Submit a VF for testing
------------------------
+   - A message displays when the VF/PNF is checked in and you are redirected
+     to the Home screen.
+#. After updating the VF/PNF:
 
-**Prerequisites:** `Create a VF`_
+   - Certify it (see `Certify VF/PNF`_).
+   - Update the VF/PNF version in any service that contains the VF/PNF,
+     please go to :ref:`doc_guide_user_des_ser-upd_serv`
 
-**Steps**
+.. _doc_guide_user_des_vf-cre_sub-tst:
 
-#. When a VF is ready for testing, click *CATALOG* and service for the VF.
-#. Click the VF and click *Submit for Testing*.
+Certify VF/PNF
+--------------
 
-   |image7|
-
-   |image8|
+**Prerequisites:** `Create a VF/PNF by VSP import`_ or
+`Create a VF/PNF manually`_
 
-#. Enter a message for the testers asking that they begin service certification
-   and click *OK*.
+**Steps**
 
-   The default mail client launches with a draft email containing the message.
+#. When a VF/PNF is ready for certification,
+   click *CATALOG* and search for the checked-in VF/PNF.
+#. Click the VF/PNF and click *Certify*.
 
-#. Add the email addresses of the people on the Certification Group for this
-   site with the *Tester* role and send the email.
+   |image7|
 
-Test a VF
----------
+   |image8|
 
-Test the design and artifacts of a VF.
+#. Enter a comment and click *OK*.
 
-**Prerequisites:** `Submit a VF for testing`_.
+#. A Message appears, that the VF/PNF is certified.
 
-**Steps**
 
-#. Sign in to SDC as a *Tester*.
-#. From the HOME page, select *Ready For Testing* under Active Projects.
-#. In the right pane, click the VF.
-#. Click *Start Testing*.
-#. Test the VF.
-#. When testing is complete, click *Accept*.
-
-.. |image1| image:: media/design_vf_workflow.png
-.. |image2| image:: media/image2017-1-27_11-13-30.png
-.. |image3| image:: media/image2017-1-27_11-14-3.png
-.. |image4| image:: media/image2017-1-27_11-17-18.png
+.. |image1| image:: media/sdc-vf-workflow.png
+.. |image2| image:: media/sdc-home.png
+.. |image3| image:: media/sdc-Import.png
+.. |image4| image:: media/sdc-vsp-update.png
 .. |image5| image:: media/sdc_artifact_update.png
 .. |image6| image:: media/design_vf_updatevspmessage.png
-.. |image7| image:: media/image2017-1-27_11-20-13.png
-.. |image8| image:: media/image2017-1-27_11-21-4.png
+.. |image7| image:: media/sdc-vf-general-certify.png
+.. |image8| image:: media/sdc-vf-certify-confirm.png
+.. |image9| image:: media/SDC-Add.png
+.. |image10| image:: media/sdc-vf-general.png