docs/instantiatemacro.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. _instantiatemacro:
   5
   6 Instantiate Service, "Macro" mode (PNF example)
   7 ================================================
   8
   9
  10 Overview
  11 --------
  12
  13 Using VID with Macro method means that all the service model resources are deployed in a single SO API call.
  14 Macro orchestration model can be used to orchestrate service models, which contain PNFs and VNFs.
  15
  16
  17 `Pre-requisites`_
  18 --------------
  19
  20 .. note::
  21    To be able to orchestrate services in "Macro" mode, the VID ModernUI needs to be enabled.
  22    Review settings in VID container`s /usr/local/tomcat/webapps/vid/WEB-INF/conf/onap.features.properties file.
  23    Flags below must be set to "true":
  24
  25     FLAG_ENABLE_WEBPACK_MODERN_UI = true
  26
  27     FLAG_EXTENDED_MACRO_PNF_CONFIG = true
  28
  29 .. _Pre-requisites: https://docs.onap.org/projects/onap-vid/en/latest/instantiate.html#pre-requisites
  30
  31 `Access to VID portal`_
  32 --------------------
  33
  34 .. _Access to VID portal: https://docs.onap.org/projects/onap-vid/en/latest/instantiate.html#access-to-vid-portal
  35
  36 Instantiate Service in "Macro" mode
  37 -----------------------------------
  38
  39 A Service Model, which contains a PNF resource will be used to demonstrate the "Macro" orchestration mode.
  40
  41 Click "Browse SDC Service Models" and search for the service to instantiate.
  42
  43 The view show only service models in the DISTRIBUTED state.
  44
  45 .. figure:: images/browse-service-models-pnf.png
  46    :align: center
  47
  48 Select a service and click Deploy.
  49
  50 Complete the mandatory fields indicated by the red star and click "Set".
  51
  52 .. figure:: images/new-service-instance-popup-pnf.png
  53    :align: center
  54
  55 Add a new object to the service instance.
  56
  57 .. note::
  58    The blue button for adding objects to the service instance appears when you hover over the object model.
  59
  60 .. figure:: images/service-instance-pnf.png
  61    :align: center
  62
  63 Complete the mandatory fields indicated by the red star and click "Set".
  64
  65 .. note::
  66    The PNF instance name must be unique
  67
  68 .. figure:: images/new-pnf-instance.png
  69    :align: center
  70
  71 To deploy the selected configuration, click "DEPLOY" button in the top right corner.
  72
  73 .. figure:: images/service-instance-pnf-deploy.png
  74    :align: center
  75
  76 If the service instance with selected objects is deployed correctly, you will be redirected to the page where you can check the instantiation status.
  77
  78 .. figure:: images/instantiation-status.png
  79    :align: center
  80
  81 .. note::
  82    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.
  83    No additional actions are needed for VNFs/CNFs.
  84
  85
  86 Instantiation Status
  87 -----------------------------------
  88
  89 The "Instantiation Status" contains information about all deployed service instances.
  90
  91 To check detailed information, click the ellipsis on the right side of the selected service instance.
  92
  93 .. figure:: images/instantiation-status-complete.png
  94    :align: center
  95
  96 .. figure:: images/service-information.png
  97    :align: center
  98
  99
 100
 101 Deleting Service Instances previous orchestrated in "macro" model
 102 -----------------------------------------
 103
 104 To delete a previously created "Macro" instance using VID, the entire service instance must be deleted.
 105
 106 To proceed with a service instance removal, from VID Home screen:
 107
 108 - search for existing service instance
 109 - edit/view the service instance you want to delete
 110 - click on red button with white cross
 111 - confirm deletion of the service instance