Merge "Move SO/BB for PNF documentation from ONAP WIKI to ONAP RTD"

8 files changed, 136 insertions, 0 deletions

diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst
index 85e7010fcb..e174133d6f 100644
--- a/docs/developer_info/developer_information.rst
+++ b/docs/developer_info/developer_information.rst
@@ -20,6 +20,7 @@ SO Developer Information
    BPMN_Subprocess_Process_Flows.rst
    BPMN_Project_Deployment_Strategy.rst
    BPMN-INFRA_Workflow_Understanding.rst
+   pnf_pnp_workflow_migration_to_BB/pnf_pnp_support_in_service_orchestration.rst
    Docker-Config_Understanding.rst
    Mso_Openstack_Adapter.rst
    Cxf_Logging.rst
diff --git a/docs/developer_info/pnf_pnp_workflow_migration_to_BB/Building_Block_based_PNF_PnP_flows.rst b/docs/developer_info/pnf_pnp_workflow_migration_to_BB/Building_Block_based_PNF_PnP_flows.rst
new file mode 100644
index 0000000000..c31ca44d8e
--- /dev/null
+++ b/docs/developer_info/pnf_pnp_workflow_migration_to_BB/Building_Block_based_PNF_PnP_flows.rst
@@ -0,0 +1,102 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2021 NOKIA, Ltd.
+
+Building Block based PNF PnP flows
+==================================
+
+.. image:: ../../images/proposed_building_blocks.png
+
+AssignPnfBB
+-----------
+
+* Responsibility:
+
+  * Creates PNF entry in AAI (with PNF name chosen by user)
+
+  * Additionally stores PNF model-related parameters in AAI:
+    * model-customization-id
+    * model-invariant-id
+    * model-version-id
+
+  * Makes a link in AAI between Service entry and PNF entry
+
+  * Sets PNF orchestration status in AAI to Assigned
+
+* Currently implemented in CreateAndActivatePnfResource.bpmn
+
+WaitForPnfReadyBB
+-----------------
+
+* Responsibility:
+
+  * Waits for "PNF ready" event sent from PRH to DMaaP
+    * pnfCorrelationId from the event must match PNF instance name provided by the user during service instantiation
+
+  * Sets PNF orchestration status in AAI to:
+    * Register - when starting to wait for PNF ready event
+    * Registered - when PNF ready event is successfully received
+
+  * Currently implemented in CreateAndActivatePnfResource.bpmn
+
+
+Support for config assign (ControllerExecutionBB, action: configAssign)
+-----------------------------------------------------------------------
+
+* Responsibility:
+  * Runs config assign via CDS
+
+* Currently implemented in ConfigurePnfResource.bpmn
+
+* We will reuse generic BPMN for calling CDS (ControllerExecutionBB)
+
+* Things to consider:
+  * SkipPostInstantiationConfiguration should be taken into account
+
+
+Support for config deploy (ControllerExecutionBB, action: configDeploy)
+-----------------------------------------------------------------------
+
+
+* Responsibility:
+  * Runs config deploy via CDS
+
+* Currently implemented in ConfigurePnfResource.bpmn
+
+* We will reuse generic BPMN for calling CDS (ControllerExecutionBB)
+
+* Things to consider:
+  * SkipPostInstantiationConfiguration should be taken into account
+
+ActivatePnfBB
+-------------
+
+* Responsibility:
+  * Sets PNF orchestration status in AAI as Active
+
+
+Sequence in Service-Macro-Create flow
+-------------------------------------
+
+1. AssignServiceInstanceBB
+2. CreateNetworkCollectionBB
+3. AssignNetworkBB
+4. AssignVnfBB
+5. AssignVolumeGroupBB
+6. AssignVfModuleBB
+7. **AssignPnfBB**
+8. **WaitForPnfReadyBB**
+9. **ControllerExecutionBB (action: configAssign, scope: pnf)**
+10. **ControllerExecutionBB (action: configDeploy, scope: pnf)**
+11. **ActivatePnfBB**
+12. ConfigAssignVnfBB
+13. CreateNetworkBB
+14. ActivateNetworkBB
+15. CreateVolumeGroupBB
+16. ActivateVolumeGroupBB
+17. CreateVfModuleBB
+18. ActivateVfModuleBB
+19. ConfigDeployVnfBB
+20. ActivateVnfBB
+21. ActivateNetworkCollectionBB
+22. ActivateServiceInstanceBB
\ No newline at end of file
diff --git a/docs/developer_info/pnf_pnp_workflow_migration_to_BB/Legacy_PNF_PNP_BPMN_workflows.rst b/docs/developer_info/pnf_pnp_workflow_migration_to_BB/Legacy_PNF_PNP_BPMN_workflows.rst
new file mode 100644
index 0000000000..260197e767
--- /dev/null
+++ b/docs/developer_info/pnf_pnp_workflow_migration_to_BB/Legacy_PNF_PNP_BPMN_workflows.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2021 NOKIA, Ltd.
+
+Legacy PNF PNP BPMN workflows
+=============================
+
+**By PNF PNP workflow we understand 2 BPMNs:**
+
+* CreateAndActivatePnfResource
+
+.. image:: ../../images/CreateAndActivatePnfResource.png
+
+* ConfigurePnfResource
+
+.. image:: ../../images/ConfigurePnfResource.png
+
+**Both included in CreateVcpeResCustService_simplified BPMN**
+
+.. image:: ../../images/goal3.png
diff --git a/docs/developer_info/pnf_pnp_workflow_migration_to_BB/pnf_pnp_support_in_service_orchestration.rst b/docs/developer_info/pnf_pnp_workflow_migration_to_BB/pnf_pnp_support_in_service_orchestration.rst
new file mode 100644
index 0000000000..0e3f4341e8
--- /dev/null
+++ b/docs/developer_info/pnf_pnp_workflow_migration_to_BB/pnf_pnp_support_in_service_orchestration.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2021 NOKIA, Ltd.
+
+PNF PnP support in Service Orchestration
+========================================
+
+.. toctree::
+   :maxdepth: 1
+
+
+   Legacy_PNF_PNP_BPMN_workflows.rst
+   Building_Block_based_PNF_PnP_flows.rst
\ No newline at end of file
diff --git a/docs/images/ConfigurePnfResource.png b/docs/images/ConfigurePnfResource.png
new file mode 100644
index 0000000000..7d1fbf81c5
--- /dev/null
+++ b/docs/images/ConfigurePnfResource.png
diff --git a/docs/images/CreateAndActivatePnfResource.png b/docs/images/CreateAndActivatePnfResource.png
new file mode 100644
index 0000000000..0c440cb169
--- /dev/null
+++ b/docs/images/CreateAndActivatePnfResource.png
diff --git a/docs/images/goal3.png b/docs/images/goal3.png
new file mode 100644
index 0000000000..a0c1d18a40
--- /dev/null
+++ b/docs/images/goal3.png
diff --git a/docs/images/proposed_building_blocks.png b/docs/images/proposed_building_blocks.png
new file mode 100644
index 0000000000..eabe251e64
--- /dev/null
+++ b/docs/images/proposed_building_blocks.png