[VID DOCS] PNF PnP Documentation

Change-Id: I19a74fdcebb974e9c3f64c4341abec5f4250bdde
Signed-off-by: Damian Nowak <damian.nowak@nokia.com>
Issue-ID: VID-970

diff --git a/docs/humaninterfaces.rst b/docs/humaninterfaces.rst
index 97ae05d..28fa65c 100644 (file)
--- a/docs/humaninterfaces.rst
+++ b/docs/humaninterfaces.rst
@@ -18,3 +18,4 @@ The following VID user guides are available on the ONAP Wiki:
    :maxdepth: 1
 
    instantiate.rst
+   instantiatemacro.rst

diff --git a/docs/images/browse-service-models-pnf.png b/docs/images/browse-service-models-pnf.png
new file mode 100644 (file)
index 0000000..241b57c
Binary files /dev/null and b/docs/images/browse-service-models-pnf.png differ

diff --git a/docs/images/instantiation-status-complete.png b/docs/images/instantiation-status-complete.png
new file mode 100644 (file)
index 0000000..5e8d165
Binary files /dev/null and b/docs/images/instantiation-status-complete.png differ

diff --git a/docs/images/instantiation-status.png b/docs/images/instantiation-status.png
new file mode 100644 (file)
index 0000000..8d5937e
Binary files /dev/null and b/docs/images/instantiation-status.png differ

diff --git a/docs/images/new-pnf-instance.png b/docs/images/new-pnf-instance.png
new file mode 100644 (file)
index 0000000..69264c5
Binary files /dev/null and b/docs/images/new-pnf-instance.png differ

diff --git a/docs/images/new-service-instance-popup-pnf.png b/docs/images/new-service-instance-popup-pnf.png
new file mode 100644 (file)
index 0000000..efb8274
Binary files /dev/null and b/docs/images/new-service-instance-popup-pnf.png differ

diff --git a/docs/images/service-information.png b/docs/images/service-information.png
new file mode 100644 (file)
index 0000000..fef5c6c
Binary files /dev/null and b/docs/images/service-information.png differ

diff --git a/docs/images/service-instance-pnf-deploy.png b/docs/images/service-instance-pnf-deploy.png
new file mode 100644 (file)
index 0000000..8f7112f
Binary files /dev/null and b/docs/images/service-instance-pnf-deploy.png differ

diff --git a/docs/images/service-instance-pnf.png b/docs/images/service-instance-pnf.png
new file mode 100644 (file)
index 0000000..58aa2db
Binary files /dev/null and b/docs/images/service-instance-pnf.png differ

diff --git a/docs/instantiate.rst b/docs/instantiate.rst
index 3b65bc5..75a2d45 100644 (file)
--- a/docs/instantiate.rst
+++ b/docs/instantiate.rst
@@ -11,7 +11,7 @@ Overview
 --------
 
 Using VID with A-La-Carte method means that the user needs to performed
-by himself the instantiation of each object  : service, VNF(s), VF module(s),
+by himself the instantiation of each object: service, VNF(s), VF module(s),
 network(s).
 
 ONAP to VIM interactions will occurs when instantiating/deleting VF module(s)
@@ -42,7 +42,7 @@ Network = Virtual Link in SDC
 Pre-requisites
 --------------
 
-pre-instantiation operations must have been performed in AAI and VID,
+Pre-instantiation operations must have been performed in AAI and VID,
 via Rest API, to declare some values for:
 
 - Subscriber Name (= customer in AAI)
@@ -54,13 +54,12 @@ via Rest API, to declare some values for:
 - LCP Region (= CloudOwner/RegionId in AAI)
 - Tenant
 
-see, in the ONAP User Guides, section about adding a CloudSite
+See, in the ONAP User Guides, section about adding a CloudSite
 and section about pre-instantiation Operations
 
 .. note::
    Robot demo script will be used to populate demo models automatically with Demonstration as Subscriber Name in VID by running "demo-k8s.sh onap init"
 
-
 Access to VID portal
 --------------------
 
@@ -96,8 +95,8 @@ There are two choices:
 
 
 
-Instantiate Service
--------------------
+Instantiate Service in "A-la-carte" mode
+----------------------------------------
 
 Click Browse SDC Service Models and search for the service to instantiate.
 
@@ -116,7 +115,7 @@ Complete the fields indicated by the red star and click Confirm.
 .. figure:: images/create-service-instance-alacarte.png
    :align: center
 
-A status ox appears that shows the ONAP SO instantiation progress
+A status box appears that shows the ONAP SO instantiation progress
 as well as any messages associated with the process.
 
 .. figure:: images/create-service-instance-alacarte-success.png

diff --git a/docs/instantiatemacro.rst b/docs/instantiatemacro.rst
new file mode 100644 (file)
index 0000000..3caeb5b
--- /dev/null
+++ b/docs/instantiatemacro.rst
@@ -0,0 +1,111 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+   International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. _instantiatemacro:
+
+Instantiate Service, "Macro" mode (PNF example)
+================================================
+
+
+Overview
+--------
+
+Using VID with Macro method means that all the service model resources are deployed in a single SO API call.
+Macro orchestration model can be used to orchestrate service models, which contain PNFs and VNFs.
+
+
+`Pre-requisites`_
+--------------
+
+.. note::
+   To be able to orchestrate services in "Macro" mode, the VID ModernUI needs to be enabled.
+   Review settings in VID container`s /usr/local/tomcat/webapps/vid/WEB-INF/conf/onap.features.properties file.
+   Flags below must be set to "true":
+
+    FLAG_ENABLE_WEBPACK_MODERN_UI = true
+
+    FLAG_EXTENDED_MACRO_PNF_CONFIG = true
+
+.. _Pre-requisites: https://docs.onap.org/projects/onap-vid/en/latest/instantiate.html#pre-requisites
+
+`Access to VID portal`_
+--------------------
+
+.. _Access to VID portal: https://docs.onap.org/projects/onap-vid/en/latest/instantiate.html#access-to-vid-portal
+
+Instantiate Service in "Macro" mode
+-----------------------------------
+
+A Service Model, which contains a PNF resource will be used to demonstrate the "Macro" orchestration mode.
+
+Click "Browse SDC Service Models" and search for the service to instantiate.
+
+The view show only service models in the DISTRIBUTED state.
+
+.. figure:: images/browse-service-models-pnf.png
+   :align: center
+
+Select a service and click Deploy.
+
+Complete the mandatory fields indicated by the red star and click "Set".
+
+.. figure:: images/new-service-instance-popup-pnf.png
+   :align: center
+
+Add a new object to the service instance.
+
+.. note::
+   The blue button for adding objects to the service instance appears when you hover over the object model.
+
+.. figure:: images/service-instance-pnf.png
+   :align: center
+
+Complete the mandatory fields indicated by the red star and click "Set".
+
+.. note::
+   The PNF instance name must be unique
+
+.. figure:: images/new-pnf-instance.png
+   :align: center
+
+To deploy the selected configuration, click "DEPLOY" button in the top right corner.
+
+.. figure:: images/service-instance-pnf-deploy.png
+   :align: center
+
+If the service instance with selected objects is deployed correctly, you will be redirected to the page where you can check the instantiation status.
+
+.. figure:: images/instantiation-status.png
+   :align: center
+
+.. note::
+   In case of Service Models, which contain PNF resources, to complete the deployment of the service instance with PNF object, send a "pnfRegistration" event to VES.
+   No additional actions are needed for VNFs/CNFs.
+
+
+Instantiation Status
+-----------------------------------
+
+The "Instantiation Status" contains information about all deployed service instances.
+
+To check detailed information, click the ellipsis on the right side of the selected service instance.
+
+.. figure:: images/instantiation-status-complete.png
+   :align: center
+
+.. figure:: images/service-information.png
+   :align: center
+
+
+
+Deleting Service Instances previous orchestrated in "macro" model
+-----------------------------------------
+
+To delete a previously created "Macro" instance using VID, the entire service instance must be deleted.
+
+To proceed with a service instance removal, from VID Home screen:
+
+- search for existing service instance
+- edit/view the service instance you want to delete
+- click on red button with white cross
+- confirm deletion of the service instance