[DOC] Tutorial for vfw service design

This describes step by step instructions for vfw design

Change-Id: I9910b43e6d596bbcb397cc6789dc973992b91c7f
Issue-ID: DOC-708
Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>

diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst
index d49b011..02d56f2 100644 (file)
--- a/docs/guides/onap-user/index.rst
+++ b/docs/guides/onap-user/index.rst
@@ -37,10 +37,15 @@ document sets in :ref:`doc_onap-developer_guide_projects`
 Tutorials
 ---------
 
+.. toctree::
+   :maxdepth: 1
+
+   vFW Design Tutorial <./vfw-design-tutorial/index.rst>
+
 Verified Use Cases
 ------------------
 In the following page you find all use cases and functional requirements
 which have been officially verified in the actual release by the ONAP community.
 
 * :ref:`Guilin Use Cases<onap-integration:docs_usecases_release>`
-* :ref:`Deprecated Use Cases<onap-integration:docs_usecases>`
\ No newline at end of file
+* :ref:`Deprecated Use Cases<onap-integration:docs_usecases>`

diff --git a/docs/guides/onap-user/vfw-design-tutorial/index.rst b/docs/guides/onap-user/vfw-design-tutorial/index.rst
new file mode 100644 (file)
index 0000000..77bfaef
--- /dev/null
+++ b/docs/guides/onap-user/vfw-design-tutorial/index.rst
@@ -0,0 +1,293 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright © 2017-2020 Aarna Networks, Inc.
+
+vFW Service Design Tutorial
+###########################
+
+Browser settings
+================
+
+This exercise will use the ONAP Portal. To interact properly with Portal services, please make sure to set the
+following settings in your Firefox browser before starting the Service Design and Deployment.
+
+Check your Firefox browser setting to make sure that Remote Proxy DNS setting is on
+
+* Type "about:config" in the address bar
+* Select "Accept the risk"
+* In the Search enter Proxy
+* Enable "network.proxy.socks_remote_dns  = true" (Just double click to change the flag)
+* Please make sure to undo this change after testing, since this could cause potential security risk!
+
+Check your Firefox settings to allow mixed contents
+
+* Type "about:config" in the address bar
+* In the Search enter Mixed
+* Click on variable security.mixed_content.block_active_content
+* Change the value to False (Just double click to change the flag)
+
+Below are the portal URL & User Login details to connect to the ONAP portal
+
+https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm
+
+User login credentials and roles
+::
+
+  Username=cs0008, password=demo123456!, Role=DESIGNER
+  Username=demo,   password=demo123456!, Role=ADMIN
+
+.. note::
+  From F release onwards, service design and deployment can be done with cs0008 and demo users
+
+Ex: To open portal URL from FireFox browser and accept SSL certificate exception after the settings
+
+|image8|
+
+Login into the portal as designer (cs0008) and enter password (demo123456!) then click on LOGIN
+
+|image21|
+
+Service Design & Distribution using SDC GUI
+===========================================
+
+In this section, you will learn the following through the SDC GUI
+
+* How to create a Vendor License Model
+* How to create and onboard Vendor Software Product
+* How to create a Service
+* How to distribute a Service
+
+Let us start by creating the VLM
+
+1. Create Vendor Licence Model (VLM) in SDC
+
+ A. Login to the ONAP portal as designer cs0008 / demo123456!
+ B. Go to SDC → ONBOARD → WORKSPACE → CREATE NEW VLM (Enter below attributes and Create)
+
+ |image35|
+
+ |image34|
+
+ C. Create New License Key Group
+
+ |image15|
+
+ D. Create Entitlement Pool
+
+ |image38|
+
+ E. Create Feature Group (Assign Entitlement Pool & License Key Group in other 2 tabs)
+
+ |image5|
+
+ |image40|
+
+ |image27|
+
+ F. Create License Agreement (Assign Feature Group under the Feature Group Tab)
+
+ |image32|
+
+ |image9|
+
+ G. Click Submit (Top Right Corner of the page) and fill comment then press Commit & Submit
+
+ |image7|
+
+2. Create Vendor Software Product (VSP)
+
+Prerequisite: Download VNF Heat package from gerrit (git clone "https://gerrit.onap.org/r/demo") and copy
+the required HEAT package & use it while upload the package
+
+ A. Go to SDC Home → ONBOARD → WORKSPACE  → CREATE NEW VSP (complete all the fields, click on Network Package
+ checkbox then click create)
+
+ |image22|
+
+ B. Assign the license Agreement by selecting the Missing icon
+
+ |image20|
+
+ C. Select the Licenses drop down box (populate all three fields)
+
+ |image24|
+
+ D. Go to Overview (Left hand side bar), select Software Product Attachments in the right pane, click Select file
+
+   Import HEAT package (ex: vfw_demo.zip) by clicking Select File Button. This file should be copied to your
+   local workstation where the browser is running.
+
+ |image37|
+
+It will take you to the setup page
+
+|image25|
+
+ E. Click on “PROCEED TO VALIDATION” and ignore warnings
+
+ |image17|
+
+ F. Click Submit (right corner), fill the comment then press COMMIT & SUBMIT, you will see submit successful message
+
+ |image3|
+
+3. Import Vendor Software Product and certify
+
+ A. Go to the SDC Home page click Import VSP button
+
+ |image13|
+
+ B. From the Import VSP box, expand a VSP name and click the Import VSP icon
+
+ |image39|
+
+ C. In the General section, complete all fields then click create (top right corner)
+
+ |image43|
+
+ D. Click Check In to save changes (top right corner), enter a comment and click OK
+
+ |image29|
+
+ E.  click CATALOG and search for the checked-in VF, you will see your VF In Design Check In state
+
+ |image10|
+
+ F. Click the VF and click certify (top right corner), enter a comment then click OK
+
+ |image11|
+
+ |image31|
+
+4. Create a Service and certify
+
+ A. Go to SDC UI → Home Page and Select the Add Service Button
+
+ |image44|
+
+ B In the General section, complete all fields then click Create
+
+ |image19|
+
+ C. select the “Composition” Menu on the left hand side menu bar
+
+ |image41|
+
+ D. On the Composition Page, Search for the vFW_demo service (look under Application L4+)
+
+ |image14|
+
+ E. On the Composition Page, Search for  Generic NeutronNet (look under Generic/Network Elements)
+
+ |image26|
+
+ F. Drag and drop vFW_demo created earlier during onboarding & the Generic NeutronNet onto the right hand side palette
+
+ |image1|
+
+ G. Connect the elements by connecting + signs and Select appropriate options for
+ Requirements and Capabilities, click Next then click Finish at the end
+
+ |image33|
+
+ |image2|
+
+ |image23|
+
+ |image36|
+
+ H. Click Check In to save changes, Enter a comment and click OK
+
+ |image6|
+
+ I. click CATALOG and search for the checked-in Service, you will see you service is in
+ Design Checkin state
+
+ |image28|
+
+ J. Click the Service and click Certify, Enter a comment and click OK, you will
+ see certification succeeded message
+
+ |image31|
+
+5. Distribute the Service
+
+ A. From the SDC HOME page, click CATALOG and search for the service
+ (it will be in Waiting For Distribution state)
+
+ |image18|
+
+ B. Select the service that is Ready for Distribution, click Distribute (top right corner)
+
+ |image30|
+
+ |image12|
+
+ C. To Monitor Distribution, click on Distribution on the left pane
+
+ |image41|
+
+ |image16|
+
+
+.. |image8| image:: media/image8.png
+.. |image21| image:: media/image21.png
+.. |image35| image:: media/image35.png
+.. |image34| image:: media/image34.png
+.. |image15| image:: media/image15.png
+.. |image38| image:: media/image38.png
+.. |image5| image:: media/image5.png
+.. |image40| image:: media/image40.png
+.. |image27| image:: media/image27.png
+.. |image32| image:: media/image32.png
+.. |image9| image:: media/image9.png
+.. |image7| image:: media/image7.png
+.. |image22| image:: media/image22.png
+.. |image20| image:: media/image20.png
+.. |image24| image:: media/image24.png
+.. |image37| image:: media/image37.png
+.. |image25| image:: media/image25.png
+.. |image17| image:: media/image17.png
+.. |image3| image:: media/image3.png
+.. |image13| image:: media/image13.png
+.. |image39| image:: media/image39.png
+.. |image43| image:: media/image43.png
+.. |image29| image:: media/image29.png
+.. |image10| image:: media/image10.png
+.. |image11| image:: media/image11.png
+.. |image31| image:: media/image31.png
+.. |image44| image:: media/image44.png
+.. |image19| image:: media/image19.png
+.. |image41| image:: media/image41.png
+.. |image14| image:: media/image14.png
+.. |image26| image:: media/image26.png
+.. |image1| image:: media/image1.png
+.. |image33| image:: media/image33.png
+.. |image2| image:: media/image2.png
+.. |image23| image:: media/image23.png
+.. |image36| image:: media/image36.png
+.. |image6| image:: media/image6.png
+.. |image28| image:: media/image28.png
+.. |image31| image:: media/image31.png
+.. |image18| image:: media/image18.png
+.. |image30| image:: media/image30.png
+.. |image12| image:: media/image12.png
+.. |image41| image:: media/image41.png
+.. |image16| image:: media/image16.png
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image1.png b/docs/guides/onap-user/vfw-design-tutorial/media/image1.png
new file mode 100644 (file)
index 0000000..5c52992
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image1.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image10.png b/docs/guides/onap-user/vfw-design-tutorial/media/image10.png
new file mode 100644 (file)
index 0000000..715beec
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image10.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image11.png b/docs/guides/onap-user/vfw-design-tutorial/media/image11.png
new file mode 100644 (file)
index 0000000..b0b2c48
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image11.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image12.png b/docs/guides/onap-user/vfw-design-tutorial/media/image12.png
new file mode 100644 (file)
index 0000000..e7d0738
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image12.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image13.png b/docs/guides/onap-user/vfw-design-tutorial/media/image13.png
new file mode 100644 (file)
index 0000000..aede961
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image13.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image14.png b/docs/guides/onap-user/vfw-design-tutorial/media/image14.png
new file mode 100644 (file)
index 0000000..1971481
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image14.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image15.png b/docs/guides/onap-user/vfw-design-tutorial/media/image15.png
new file mode 100644 (file)
index 0000000..e2a76bc
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image15.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image16.png b/docs/guides/onap-user/vfw-design-tutorial/media/image16.png
new file mode 100644 (file)
index 0000000..f867810
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image16.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image17.png b/docs/guides/onap-user/vfw-design-tutorial/media/image17.png
new file mode 100644 (file)
index 0000000..da40db6
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image17.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image18.png b/docs/guides/onap-user/vfw-design-tutorial/media/image18.png
new file mode 100644 (file)
index 0000000..4ccf960
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image18.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image19.png b/docs/guides/onap-user/vfw-design-tutorial/media/image19.png
new file mode 100644 (file)
index 0000000..abaf5ac
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image19.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image2.png b/docs/guides/onap-user/vfw-design-tutorial/media/image2.png
new file mode 100644 (file)
index 0000000..a3c3bc6
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image2.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image20.png b/docs/guides/onap-user/vfw-design-tutorial/media/image20.png
new file mode 100644 (file)
index 0000000..87922aa
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image20.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image21.png b/docs/guides/onap-user/vfw-design-tutorial/media/image21.png
new file mode 100644 (file)
index 0000000..cc3379f
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image21.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image22.png b/docs/guides/onap-user/vfw-design-tutorial/media/image22.png
new file mode 100644 (file)
index 0000000..0e6abfa
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image22.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image23.png b/docs/guides/onap-user/vfw-design-tutorial/media/image23.png
new file mode 100644 (file)
index 0000000..ba91ed3
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image23.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image24.png b/docs/guides/onap-user/vfw-design-tutorial/media/image24.png
new file mode 100644 (file)
index 0000000..9e2aee9
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image24.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image25.png b/docs/guides/onap-user/vfw-design-tutorial/media/image25.png
new file mode 100644 (file)
index 0000000..d594cf0
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image25.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image26.png b/docs/guides/onap-user/vfw-design-tutorial/media/image26.png
new file mode 100644 (file)
index 0000000..edde3e7
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image26.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image27.png b/docs/guides/onap-user/vfw-design-tutorial/media/image27.png
new file mode 100644 (file)
index 0000000..df81c11
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image27.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image28.png b/docs/guides/onap-user/vfw-design-tutorial/media/image28.png
new file mode 100644 (file)
index 0000000..d9874c5
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image28.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image29.png b/docs/guides/onap-user/vfw-design-tutorial/media/image29.png
new file mode 100644 (file)
index 0000000..db2bdf9
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image29.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image3.png b/docs/guides/onap-user/vfw-design-tutorial/media/image3.png
new file mode 100644 (file)
index 0000000..fec518b
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image3.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image30.png b/docs/guides/onap-user/vfw-design-tutorial/media/image30.png
new file mode 100644 (file)
index 0000000..f95fc24
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image30.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image31.png b/docs/guides/onap-user/vfw-design-tutorial/media/image31.png
new file mode 100644 (file)
index 0000000..1a50945
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image31.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image32.png b/docs/guides/onap-user/vfw-design-tutorial/media/image32.png
new file mode 100644 (file)
index 0000000..f400a74
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image32.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image33.png b/docs/guides/onap-user/vfw-design-tutorial/media/image33.png
new file mode 100644 (file)
index 0000000..d05154b
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image33.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image34.png b/docs/guides/onap-user/vfw-design-tutorial/media/image34.png
new file mode 100644 (file)
index 0000000..fc48285
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image34.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image35.png b/docs/guides/onap-user/vfw-design-tutorial/media/image35.png
new file mode 100644 (file)
index 0000000..600f36b
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image35.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image36.png b/docs/guides/onap-user/vfw-design-tutorial/media/image36.png
new file mode 100644 (file)
index 0000000..553db66
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image36.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image37.png b/docs/guides/onap-user/vfw-design-tutorial/media/image37.png
new file mode 100644 (file)
index 0000000..0b8e4c0
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image37.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image38.png b/docs/guides/onap-user/vfw-design-tutorial/media/image38.png
new file mode 100644 (file)
index 0000000..2fd04d6
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image38.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image39.png b/docs/guides/onap-user/vfw-design-tutorial/media/image39.png
new file mode 100644 (file)
index 0000000..874b6e9
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image39.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image4.png b/docs/guides/onap-user/vfw-design-tutorial/media/image4.png
new file mode 100644 (file)
index 0000000..82e3a92
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image4.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image40.png b/docs/guides/onap-user/vfw-design-tutorial/media/image40.png
new file mode 100644 (file)
index 0000000..0ef90c9
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image40.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image41.png b/docs/guides/onap-user/vfw-design-tutorial/media/image41.png
new file mode 100644 (file)
index 0000000..7895599
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image41.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image42.png b/docs/guides/onap-user/vfw-design-tutorial/media/image42.png
new file mode 100644 (file)
index 0000000..6ddd4bd
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image42.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image43.png b/docs/guides/onap-user/vfw-design-tutorial/media/image43.png
new file mode 100644 (file)
index 0000000..2933f7e
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image43.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image44.png b/docs/guides/onap-user/vfw-design-tutorial/media/image44.png
new file mode 100644 (file)
index 0000000..9dc118f
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image44.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image5.png b/docs/guides/onap-user/vfw-design-tutorial/media/image5.png
new file mode 100644 (file)
index 0000000..7c2140e
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image5.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image6.png b/docs/guides/onap-user/vfw-design-tutorial/media/image6.png
new file mode 100644 (file)
index 0000000..0594df9
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image6.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image7.png b/docs/guides/onap-user/vfw-design-tutorial/media/image7.png
new file mode 100644 (file)
index 0000000..f987e40
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image7.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image8.png b/docs/guides/onap-user/vfw-design-tutorial/media/image8.png
new file mode 100644 (file)
index 0000000..97a616a
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image8.png differ

diff --git a/docs/guides/onap-user/vfw-design-tutorial/media/image9.png b/docs/guides/onap-user/vfw-design-tutorial/media/image9.png
new file mode 100644 (file)
index 0000000..c2eb4dc
Binary files /dev/null and b/docs/guides/onap-user/vfw-design-tutorial/media/image9.png differ