docs/docs_CM_flexible_designer_orchestrator.rst

   1 .. _docs_CM_flexible_designer_orchestrator:
   2
   3 .. contents::
   4    :depth: 3
   5 ..
   6
   7 Dublin Workflow Designer Release Notes
   8 ======================================
   9
  10 The Workflow Editor was developed in the Beijing release by Amdocs and
  11 is available in SDC for users to create workflows.
  12
  13 NOTE: For the Dublin release only FlowCompleteActivity, Set/UnSet
  14 InMaint Flags Building Blocks were tested. Testing for the other
  15 Building Blocks for an InPlaceSWUpdate will be tested in the El Alto
  16 release.
  17
  18 Building Blocks Available
  19 --------------------------
  20
  21 The following building blocks will be visible in the SDC Workflow
  22 Designer Editor. Those that were tested are marked with an “\*”. Those
  23 that are unmarked were not tested.
  24
  25 -  VNFSetInMaintFlagActivity  \*
  26
  27 -  VNFUnsetInMaintFlagActivity  \*
  28
  29 -  FlowCompleteActivity \*
  30
  31 -  VNFCheckInMaintFlagActivity
  32
  33 -  PauseForManualTaskActivity
  34
  35 -  VNFCheckClosedLoopDisabledFlagActivity
  36
  37 -  VNFCheckPserversLockedFlagActivity
  38
  39 -  VNFHealthCheckActivity
  40
  41 -  VnfInPlaceSoftwareUpdate
  42
  43 -  VNFLockActivity
  44
  45 -  VNFQuiesceTrafficActivity
  46
  47 -  VNFResumeTrafficActivity
  48
  49 -  VNFSetClosedLoopDisabledFlagActivity
  50
  51 -  VNFSnapShotActivity
  52
  53 -  VNFStartActivity
  54
  55 -  VNFStopActivity
  56
  57 -  VNFUnlockActivity
  58
  59 -  VNFUnsetClosedLoopDisabledFlagActivity
  60
  61 -  VNFUpgradeBackupActivity
  62
  63 -  VNFUpgradePostCheckActivity
  64
  65 -  VNFUpgradePreCheckActivity
  66
  67 -  VNFUpgradeSoftwareActivity
  68
  69 -  DistributeTrafficActivity Check Release Notes for this BB
  70
  71 -  DistributeTrafficCheckActivity   Check Release Notes for this BB
  72
  73 Pre-Workflow Execution
  74 ----------------------
  75
  76 1. Users must ensure that the required Ansible scripts are available and
  77    loaded the appropriate Ansible server prior to attempting to execute
  78    a workflow. Building blocks for InPlaceSWUpgrade that require Ansible
  79    Scripts include:
  80
  81 -  VNFUpgradePreCheck,
  82
  83 -  VNFUpgradeSoftware,
  84
  85 -  VNFUpgradePostCheck,
  86
  87 1. If a building block exists in SO and is not showing up in the SDC
  88    Workflow Designer (WFD), activities can be manually uploaded by
  89    following instructions in the Change Managmenet Extension Release
  90    Notes for CasaBlanca. This was tested and SO is expected to
  91    automatically push the activities/BuildingBlocks (BBs) to SDC.
  92
  93 2. User must create a workflow, attach it to the vNF model. It is
  94    recommended that they test it in a test environment prior to
  95    executing in a production environment.
  96
  97 3. NOTE: The workflow distribution mechanism was working until after
  98    Dublin code freeze in the test environment. Since we are not sure if
  99    something broke, we are including instructions in to manually upload
 100    the WF to SO. The Steps to upload a BPMN directly to SO are:
 101
 102     | - populate\_wfd\_tbl.sh ,
 103     | - workflow\_template.xml
 104     | - workflowtbl.sql
 105     | It is recommended that the user cleanup the workflow tables. The
 106       Sqls to do so are in
 107     | -<cleanup\_rerun.txt.>.
 108
 109     Here are the steps to populate the wfd tables
 110
 111     A. Create an absolute path directory
 112
 113     This will be the directory where the files and the scripts reside
 114     for populating the WFD tables.
 115
 116     Eg: /home/uid/workflows
 117
 118     B. Save the following files into the directory created in step 1
 119     (eg:/home/uid/workflows)
 120
 121     populate\_wfd\_tbl.sh ,
 122
 123     workflow\_template.xml ,
 124
 125     WorkflowSample.bpmn,
 126
 127     workflowtbl.sql
 128
 129     C. Change the user, password, and db in populate\_wfd\_tbl.sh
 130
 131     EG: mysql -u<user> -p<password> -D<schema>
 132
 133     In the script right now we used user=root, password=password,
 134     schema=catalogdb
 135
 136
 137
 138     D. Create your workflow bpmn (WorkflowSample.bpmn provided as a
 139     sample)
 140
 141     Attributes from the workflow bpmn created for testing are used in
 142     the workflow\_template.xml file so that the related WFD tables are
 143     populated.
 144
 145     E. Edit the Workflow\_template.xml based on your workflow bpm that
 146     you have created.
 147
 148     Template is populated with sample values as examples.
 149
 150     <?xml version="1.0" encoding="UTF-8"?>
 151
 152     <workflow-template>
 153
 154       <workflow ARTIFACT\_UUID="a90f8eaa-7c20-422f-8c81-aacbca6fb9e7"
 155     ARTIFACT\_NAME="workflowSample.bpmn" NAME="workflowSample.bpmn"
 156     OPERATION\_NAME="inPlaceSoftwareUpdate"
 157
 158       VERSION="1.0" DESCRIPTION="Workflow Artifact Description" BODY=""
 159     RESOURCE\_TARGET="VNF" SOURCE="SDC" TIMEOUT\_MINUTES="120"
 160
 161       ARTIFACT\_CHECKSUM="ZjUzNjg1NDMyMTc4MWJmZjFlNDcyOGQ0Zjc1YWQwYzQ\\u003d">
 162
 163       </workflow>
 164
 165     //VNF to be used
 166
 167       <vnf NAME="abcd-abcd-abcd-abcd-abcd" VERSION="1.0"/>
 168
 169     //list the activities you are designed in the workflow bpmn and the
 170     sequence order.
 171
 172       <activity\_spec\_sequence NAME="VNFSetInMaintFlagActivity"
 173     VERSION="1.0" SEQUENCE="1"/>
 174
 175       <activity\_spec\_sequence NAME="VNFUnsetInMaintFlagActivity"
 176     VERSION="1.0" SEQUENCE="2"/>
 177
 178       <activity\_spec\_category NAME="VNF"/>
 179
 180     </workflow-template>
 181
 182
 183
 184     F.  => ./populate\_wfd\_tbl.sh <directory with absolute path that we
 185     have created in step 1>
 186
 187     Eg:=> ./populate\_wfd\_tbl.sh '/home/uid/workflows'
 188
 189 1. There is a correction in the code to connect the WF to the vNF in the
 190    SO table, however, due to environment issues, it was not tested prior
 191    to code freeze. We do expect it to work, however, in the event that
 192    it does not, the user needs manually update the SO database to link
 193    the WF to the vNF by following these instructions.
 194
 195    a. Login to dev-mariadb-galera-mariadb-galera-0 pod
 196
 197    b. mysql -ucataloguser -pcatalog123
 198
 199    c. use catalogdb;
 200
 201    d. select id from workflow where name = '<your workflow name>;
 202
 203    e. insert into vnf\_resource\_to\_workflow
 204       (‘VNF\_RESOURCE\_MODEL\_UUID’, ‘WORKFLOW\_ID’)VALUES (‘<model uuid
 205       of your VNF Resource>’,<workflow id obtained in the query in step
 206       4>);
 207
 208 Workflow Initiation
 209 -------------------
 210
 211 After creating a workflow, attaching it to the vNF model and
 212 distributing the model, the workflow can now be initiated at the VID
 213 interface by: (Note – a vNF of the same model version must also be
 214 instantiated)
 215
 216 1. Go to VID and Select “vNF Changes” from the left menu.
 217
 218 2. Select the “+ New” icon at the top of the window.
 219
 220    a. Enter the fields displayed by VID. As selections are made, other
 221       fields will appear. Any field where the entry “box” turns red when
 222       selected, is mandatory.
 223
 224    b. Target Model is displayed but not needed for InPlaceSWUpdate or
 225       Configupdate WFs
 226
 227    c. A configuration file must be uploaded to execute the ConfigUpdate
 228       WF. This input is not used for InPlaceSWUpdate.
 229
 230    d. Operations Timeout is a mandatory field.
 231
 232    e. Existing and New SW Version fields are mandatory for
 233       InPlaceSWUpdate.
 234
 235 3. Available vNF dropdown
 236
 237    a. To select more than one vNF instance, just select the desired
 238       instances from the dropdown list. You may select one or many.
 239
 240    b. To delete a selected vNF instance, click the “X” to the left of
 241       that instance.
 242
 243    c. To exit the vNF instance selection mode, click in the blank space
 244       on the Pop-Up. DO NOT click outside the Pop-Up as this is
 245       equivalent to clicking <Cancel>.
 246
 247 4. If the workflow desired is not displayed when clicking on the
 248    Workflow “Box”, it means that the workflow is either not attached to
 249    the vNF Model Version of the selected instance or the vNF Modell has
 250    not been distributed and deployed in SO. Go back to steps 3-5 of the
 251    previous section to correct.
 252
 253 5. Once all fields are populated, select <Confirm> at the bottom of the
 254    pop-up window to execute the workflow.
 255
 256 6. To cancel your selections, click <Cancel> at the bottom of the pop-up
 257    window.
 258
 259 Workflow Status
 260 ---------------
 261
 262 Once the workflow is initiated, the user can view status of the workflow
 263 by Selecting the Active and Completed TABS.
 264
 265 1. Click the Refresh icon above and to the right of the status table
 266    being viewed to refresh the data.
 267
 268 2. Click the icon in the status column to view specific status about the
 269    workflow in that row.
 270
 271    a. Red icon indicates a failure or issue.
 272
 273    b. Green icon indicates in Progress or successful completion.
 274
 275 Pause for Manual Task Building Block Handling
 276 ---------------------------------------------
 277
 278 Descoped from Dublin. To be tested in El Alto.
 279
 280 Native (Hard Coded) SO Workflows
 281 --------------------------------
 282
 283 The user will also see Native (Hard Coded) workflows along with
 284 workflows they create for the selected vNF type in the dropdown menu on
 285 the VID screen when initiating a workflow. These require ansible scripts
 286 and are available to test with your particular vNF. Only Scale out was
 287 part of the Dublin release. The others were not part of the release but
 288 are available to test with your vNF. Please refer to the Scale out
 289 release notes for further information.
 290
 291 https://onap.readthedocs.io/en/latest/submodules/integration.git/docs/docs_scaleout.html#docs-scaleout