docs/docs_CM_flexible_designer_orchestrator.rst

   1 .. _docs_CM_flexible_designer_orchestrator:
   2
   3 Change Management Flexible Designer and Orchestrator
   4 -----------------------------------------------------------------------------
   5
   6 Description
   7 ~~~~~~~~~~~~~~
   8
   9 The change management flexible designer and orchestrator enables a user to design a change workflow in SDC using a catalog of activities and distribute and deploy the workflow to SO for execution.
  10
  11 How to Use
  12 ~~~~~~~~~~~
  13 To use the flexible designer and orchestrator functionality, one has to execute the following steps:
  14
  15 1) Activity upload (SO to SDC)
  16
  17 2) Change workflow design and certification (in SDC)
  18
  19 3) Change workflow testing (in SDC)
  20
  21 4) Change workflow distribution and deployment (SDC to SO)
  22
  23 For steps 2-4, use the ONAP portal:
  24
  25 https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm
  26
  27 Login in designer: cs0008
  28
  29 Password for all users is: demo123456!
  30
  31 Activity upload - Source files
  32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33
  34 SO Activity Specs:
  35
  36 https://git.onap.org/so/tree/bpmn/so-bpmn-building-blocks/src/main/resources/ActivitySpec
  37
  38 Activity upload - How to use
  39 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  40
  41 Use the manual activity spec upload process for now - for every json file in ActivitySpec directory run the curl commands below
  42
  43 Deploy SO Activity Spec to SDC:
  44 curl -X POST http://sdc-wfd-be:8080/v1.0/activity-spec -H "C
  45 ontent-Type: application/json" -d @<activity name>.json
  46
  47 The output will be of the form:{"id":"...","versionId":"..."}
  48
  49 Make a note of id from the output.
  50
  51 Certify SO Activity Spec in SDC:
  52 curl -X PUT "http://sdc-wfd-be:8080/v1.0/activity-spec/<id returned on deployment>/versions/latest/actions" -H  "accept: */*" -H  "Content-Type: application/json" -d "{  \"action\": \"CERTIFY\"}"
  53
  54 Example:
  55
  56 curl -X POST http://sdc-wfd-be:8080/v1.0/activity-spec -H "C
  57 ontent-Type: application/json" -d @VNFUnsetInMaintFlagActivitySpec.json
  58
  59 Output:
  60 {"id":"fad363f616d5422b94fe2351c8b44c48","versionId":"cd6af48e3c8247d2ab7568849d"}
  61 curl -X PUT "http://sdc-wfd-be:8080/v1.0/activity-spec/fad363f616d5422b94fe2351c8b44c48/versions/latest/actions" -H  "accept: */*" -H  "Content-Type: application/json" -d "{  \"action\": \"CERTIFY\"}"
  62
  63 Change workflow design and certification
  64 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  65 1) Go to SDC on the ONAP portal. Use login with role of designer (cs0008)
  66
  67 2) Disable protection for now
  68
  69 3) Go to Workflow and click on Add a workflow. Provide a Name and Description for the new workflow. After clicking on Create, it will display a page with General, Input/Output and Composition. In Input/output, provide a NF_id as input and status as output. Save the workflow
  70
  71 4) Go to Composition and design the new workflow.
  72
  73 5) Start and End indicates the start and end of the workflow. Add an activity after start. Make it a service event and add an activity using the details option on the right. Select the Activity Spec.
  74
  75 6) Save the workflow
  76
  77 7) Certify the workflow. Once certified, the workflow design cannot be changed. If one needs to change it post certification, one can create a new version of the workflow.
  78
  79 8) Go back to Home and add a VF. Provide a name, category, description, Contact ID, vendor and vendor release for the VF. Save the VF. Go to Operation and Add a new operation. This is the step where you link the workflow to the VF.
  80
  81 9) Go to Home and add a Service. Provide a name, category, description, contact ID, project Code for the service. Save the service.  Then go to Composition, select the VF previously created. Click on submit for testing. The service is ready for testing.
  82
  83 Change workflow testing
  84 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  85
  86 1) Switch the user with tester role (jm0007)
  87
  88 2) In Home, the service would be displayed as Ready for Testing
  89
  90 3) Click on the service and then start testing.
  91
  92 4) Click on Accept and provide Certification confirmation. Now the workflow is ready for distribution.
  93
  94 Change workflow distribution and deployment
  95 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  96
  97 1) Switch the user with governor role (gv0001). Governor is responsible for approving the distribution
  98
  99 2) Click on the service name and click on Approve. Provide the distribution confirmation comment. This approves the workflow distribution.
 100
 101 3) Switch the user with operator role (op0001).
 102
 103 4) Click on the service name and then click on Distribution. Click on Distribute to distribute the workflow to SO. Then click on Monitor to check the distribution status. The CSAR along with BPMN is distributed from SDC to SO.
 104
 105 5) Once distribution is completed from SDC to SO, SO will automatically deploy the workflow. SO automatically makes the workflow ready for execution.
 106
 107 Known Issues and Resolution
 108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 109 SO has an issue with workflow validation during execution.
 110 https://jira.onap.org/browse/SO-1243
 111 We would be resolving this as a maintenance patch in Casablanca.
 112 For Casablanca, the workflow design, testing, distribution and deployment have been successfully tested.
 113
 114 SDC user guide can be found here: https://wiki.onap.org/display/DW/Design