docs/docs_CM_flexible_designer_orchestrator.rst

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