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