docs/docs_CM_flexible_designer_orchestrator.rst

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