docs/development/devtools/pairwise/clamp-sdc.rst

   1 .. This work is licensed under a
   2 .. Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4
   5 .. _clamp-pairwise-testing-label:
   6
   7 .. toctree::
   8    :maxdepth: 2
   9
  10 CLAMP <-> SDC
  11 ~~~~~~~~~~~~~~
  12
  13 The pairwise testing is executed against a default ONAP installation in the OOM.
  14 It briefly states the procedure to design an Automation Composition starting from service creation,
  15 adding the required ONAP component artifacts, policy and properties in the composition phase of SDC
  16 and finally distributing it to the CLAMP for Commissioning.
  17 SDC provides an interface for distributing the modeled services to the run time components.
  18
  19 The instructions below will enable to design an Automation Composition. There are different phases to the design:
  20
  21 Step 1: Design an automation composition template and associate it to a Service, the template represents the theoretical flow of the ACM.
  22
  23 Step 2: Generate a deployment artifact that can be ingested by the Policy Framework
  24
  25 Step 3: Distribute the automation composition to CLAMP, the csar is distributed to CLAMP over Dmaap
  26
  27 Step 4: Policy Distribution will internally call Automation Composition Commissioning rest endpoint
  28
  29 Step 5: Service Template is commissioned in CLAMP, and can be followed by Instantiation and state changes.
  30
  31 General Setup
  32 *************
  33
  34 The kubernetes installation allocated all policy components across multiple worker node VMs.
  35 The worker VM hosting the policy components has the following spec:
  36
  37 - 16GB RAM
  38 - 8 VCPU
  39 - 160GB Ephemeral Disk
  40
  41 The ONAP components used during the pairwise tests are:
  42
  43 - CLAMP automation composition runtime, policy participant, kubernetes participant.
  44 - SDC for running SDC components.
  45 - DMaaP for the communication between Automation Composition runtime and participants.
  46 - Policy Framework components for instantiation and commissioning of automation compositions.
  47
  48 Helpful instruction page on bringing SDC and PORTAL setup on an OOM deployment https://wiki.onap.org/display/DW/Deploy+OOM+and+SDC+%28or+ONAP%29+on+a+single+VM+with+microk8s+-+Honolulu+Setup
  49
  50 Testing procedure
  51 *****************
  52
  53 The test set focused on the following use cases:
  54
  55 - Design of participants and automation composition elements
  56 - Design of Automation Composition template including the above designed participants and automation composition element templates.
  57 - Distribution of designed template along with other artifacts as a csar to policy-distribution
  58 - Commissioning of template in automation composition runtime.
  59
  60 Configuration changes
  61 *********************
  62
  63 Following are certain configuration changes required/cross-checked
  64 1. policy-distribution configuration should include toscaAutomationCompositionDecoderConfiguration
  65 File: kubernetes/policy/components/policy-distribution/resources/config/config.json
  66
  67    - Automation composition decoders and forwards should be present. Reference: `Sample Configuration <json/pd_config.json>`
  68
  69 Design of participants and automation composition elements:
  70 -----------------------------------------------------------
  71 Different participants and automation composition elements are created in SDC dashboard with the models available for automation composition.
  72
  73 SDC provides a graphical interface for onboarding/designing resources (such as VNFs, PNFs, CNFs) and designing services composed of such resources
  74
  75 - Create as many participants as needed to present in the automation composition
  76 - Select VF, provide name of the participant. Choose Model as AUTOMATION COMPOSTIION and Category as Participant.
  77
  78   .. image:: images/sdc_create_participant.png
  79
  80 - Create as many automation composition elements as needed to present in the automation composition
  81 - Select VF, provide name of the automation composition element. Choose Model as AUTOMATION COMPOSTIION and Category as AutomationComposition Element.
  82
  83   .. image:: images/sdc_create_element.png
  84
  85 - Add properties as required for an automation composition element
  86 - Add any properties where input is needed in Inputs tab.
  87
  88   .. image:: images/sdc_element_props.png
  89
  90 - Create an automation composition
  91 - Select Service, provide name of the automation composition. Choose Model as AUTOMATION COMPOSTIION and Category as AutomationComposition.
  92
  93   .. image:: images/sdc_create_acm.png
  94
  95 - SDC Composition tab
  96 - Drag and Drop the previously created participants and automation composition elements into the Compistion pane.
  97 - Drag and Drop the policies that needs to be added to the service template.
  98
  99   .. image:: images/sdc_compose_acm.png
 100
 101 - For a pre validation, Tosca artifacts can be downloaded and verified
 102
 103   .. image:: images/sdc_tosca.png
 104
 105 - From SDC dashboard, perform a distribution of the automation composition
 106
 107   .. image:: images/sdc_distribute.png
 108
 109 - An Automation Composition is created by commissioning a Tosca template with Automation Composition definitions.
 110     This commissioned tosca service template can be further used from Policy-GUI for instantiating the Automation Composition with the state "UNINITIALISED".
 111
 112 - Instantiate the commissioned Automation Composition definitions from the Policy Gui under 'Instantiation Management'.
 113
 114   .. image:: images/create-instance.png
 115
 116 -  Verification: The automation composition is created with default state "UNINITIALISED" without errors.
 117
 118   .. image:: images/ac-instantiation.png
 119