1 .. This work is licensed under a Creative Commons Attribution 4.0
2 International License. http://creativecommons.org/licenses/by/4.0
10 vFW In-Place Software Upgrade with Traffic Distribution Use Case
11 ----------------------------------------------------------------
15 The purpose of this work is to show In-Place Software Upgrade Traffic Distribution functionality implemented in Frankfurt release for vFW Use Case.
16 The use case is an evolution of vFW Traffic Distribution Use Case which was developed for Casablanca and Dublin releases.
17 The orchestration workflow triggers a change of the software on selected instance of the firewall. The change is proceeded with minimization of disruption of the
18 service since the firewall being upgraded must have all the traffic migrated out before the upgrade can be started. The traffic migration (redistribution) is done by
19 a traffic balancing/distribution entity (aka anchor point). The DistributeTraffic action targets the traffic balancing/distribution entity, in some cases DNS, other cases a load balancer external to the VNF instance, as examples.
20 Traffic distribution (weight) changes intended to take a VNF instance out of service are completed only when all in-flight traffic/transactions have been completed.
21 DistributeTrafficCheck command may be used to verify initial conditions of redistribution or can be used to verify the state of VNFs and redistribution itself.
22 To complete the traffic redistribution process, gracefully taking a VNF instance out-of-service/into-service, without dropping in-flight calls or sessions,
23 QuiesceTraffic/ResumeTraffic command may need to follow traffic distribution changes. The upgrade operation consist of the UpgradePreCheck operation which can used to verify
24 initial conditions for the operation like difference of the software version to the one requested, SoftwareUpgrade operation is responsible for modification of the software on
25 selected vFW instance and UpgradePostCheck LCM actions is used to verify if the software was properly installed on vFW. After the completion of the software upgrade the traffic is migrated to the
26 instance of the vFW which was before being upgraded. The workflow can be configured also in such a way to perform only singular migration of the traffic without upgrade of the software
27 what allows to experiment with the version of the workflow implemented in the previous releases. All the LCM operations are executed by APPC controller and they are implemented with Ansible protocol. In order to avoid the inconsistency in the VNFs state the Lock/Unlocks
28 mechanisms is used to prevent parallel execution of LCM actions on VNFs that are under maintenance because of the workflow that is currently executed on them.
29 The VNF application remains in an active state.
31 Traffic Distribution and In-Place Software Upgrade functionality is an outcome of Change Management project. Further details can be found on the following pages
33 - Frankfurt: https://wiki.onap.org/display/DW/Change+Management+Frankfurt+Extensions (Traffic Distribution workflow enhancements)
35 - Dublin: https://wiki.onap.org/display/DW/Change+Management+Extensions (DistributeTraffic LCM and Use Case)
37 - Casablanca https://wiki.onap.org/display/DW/Change+Management+Dublin+Extensions (Distribute Traffic Workflow with Optimization Framework)
42 .. figure:: files/dt-use-case.png
46 Figure 1 The overview of interaction of components in vFW In-Place Software Upgrade with Traffic Distribution Use Case
48 The main idea of the use case and prepared workflow is to show the interaction of different components of ONAP, including AAI, Policy, OOF, APPC for realization of scenario of software upgrade
49 of vFW instance with migration of the traffic in time of its upgrade. vFW instance was modified to have two instances of vFW with dedicated vSINKs. The general idea of interaction of ONAP components
50 is shown on Figure 1. Software Upgrade is performed on selected vFW instance. vPKG and the other vFW taking action while migration of the traffic out of vFW being upgraded. In a result of the DistributeTraffic
51 LCM action traffic flow originated from vPKG to vFW 1 and vSINK 1 is redirected to vFW 2 and vSINK 2 (as it is seen on Figure 2). Result of the change can be observed also on the vSINKs' dashboards which show
52 a current incoming traffic. After migration software is upgraded on the vFW and afterwards the traffic can be migrated back to this vFW instance. Observation of the dashboard from vSINK 1 and vSINK 2 proves workflow works properly.
54 .. figure:: files/dt-result.png
58 Figure 2 The result of traffic distribution in time of the upgrade
60 The traffic distribution sub-workflow takes as an input configuration parameters delivered by Optimization Framework and on their basis several traffic distribution LCM actions are executed by APPC in the specific workflow.
61 Further LCM actions are executed in order to present the idea of vFW In-Place Software Upgrade with Traffic Distribution. In this use case also APPC locking mechanisms is demonstrated, changes in APPC for VNFC level Ansible
62 actions support and changes for APPC Ansible automation also are used in the use case. The APPC Ansible automation scripts allows to configure LCM actions without the need to enter the CDT portal, however there is
63 possibility to do it manually and documentation describes also how to do it. In the same sense, the upload of policy types and policy instances is automated but the documentation describes how to do it manually.
65 The demonstration scripts can be used to execute two different scenarios:
67 1. Simple distribution of traffic from selected vFW instance to the other one
69 2. Upgrade of the software on selected vFW instance. Both are preceded with shared phase of identification of VF-modules for reconfiguration what is done with help of Optimization Framework.
74 Whole vFW In-Place Software Upgrade with Traffic Distribution use case can be decomposed into following workflows:
76 1. High level workflow (simplified workflow on Figure 3 and more detailed on Figure 4)
78 .. figure:: files/vfwdt-workflow-general.png
82 Figure 3 The In-Place Software Upgrade with Traffic Distribution general workflow
84 * Identification of vFW instances (**I**) for migration of the traffic (source and destination) and identification of vPKG instance (anchor point) which would be responsible for reconfiguration of the traffic distribution. This operation id performed by Optimization Framework, HAS algorithm in particular
86 * Before any operation is started workflow Locks (**II-IV**) with APPC all the VNFs involved in the procedure: vFW 1, vFW 2 and vPKG. In fact this is the vFW being upgraded, vFW which will be used to migrate traffic to and vPKG which performs the traffic distribution procedure. The VNFs needs to be locked in order to prevent the execution of other LCM actions in time of the whole workflow execution. Workflow checks state of the Lock on each VNF (**II**)(**1-6**), if the Locs are free (**III**)(**7**) the Locs are being acquired (**IV**)(**8-14**). If any Lock Check or Lock fails (**7, 14**), workflow is stopped.
88 * Depending on the workflow type different (Traffic Distribution or In-Place Software Upgrade with Traffic Distribution) LCM action are executed by APPC (**V**). All with Ansible protocol and with VNF and VF-modules identified before by Optimization Framework or the input parameters like selected vFW VNF instance. Workflows are conditional and will not be performed if the preconditions were not satisfied. In case of failure of LCM operation any other actions are canceled.
90 * At the end workflow Unlocks with APPC the previously Locked VNFs (**VI**)(**15-21**). This operations is performed always even when some steps before were not completed. The purpose is to not leave VNFs in locked state (in maintenance status) as this will prevent future execution of LCM actions or workflows on them. The locks are being automatically released after longer time.
92 .. figure:: files/vfwdt-general-workflow-sd.png
96 Figure 4 The In-Place Software Upgrade with Traffic Distribution detailed workflow
98 2. Identification of VF-modules candidates for migration of traffic (detailed workflow is shown on Figure 5)
100 .. figure:: files/vfwdt-identification-workflow-sd.png
104 Figure 5 Identification of VF-Module candidates for migration of traffic
106 - Workflow sends placement request to Optimization Framework (**1**) specific information about the vPKG and vFW-SINK models and VNF-ID of vFW that we want to upgrade.
107 Optimization Framework role is to find the vFW-SINK VNF/VF-module instance where traffic should be migrated to in time of the upgrade and vPKG which will be associated with this vFW.
108 Although in our case the calculation is very simple, the mechanism is ready to work for instances of services with VNF having houndreds of VF-modules spread accross different cloud regions.
110 - Optimization Framework takes from the Policy Framework policies (**2-3**) for VNFs and for relations between each other (in our case there is checked ACTIVE status of vFW-SINK and vPKG VF-modules and the Region to which they belong)
112 - Optimization Framework, base on the information from the policies and service topology information taken from A&AI (**4-11**), offers traffic distribution anchor and destination candidates' pairs (**12-13**) (pairs of VF-modules data with information about their V-Servers and their network interfaces). This information is returned to the workflow script (**14**).
114 - Information from Optimization Framework can be used to construct APPC LCM requests for DistributeTrafficCheck, DistributeTraffic, UpgradePreCheck, SoftwareUpgrade and UpgradePostCheck commands. This information is used to fill CDT templates with proper data for further Ansible playbooks execution. Script generates also here CDT templates for LCM actions which can be uploaded automatically to APPC DB.
116 3. The Traffic Distribution sub-workflow (simplified workflow on Figure 6 and more detailed on Figure 7)
118 .. figure:: files/vfwdt-workflow-traffic.png
122 Figure 6 The Traffic Distribution general workflow
124 - In the first DistributeTrafficCheck LCM request on vPGN VNF/VF-Module APPC, over Ansible, checks if already configured destination of vPKG packages is different than already configured one (**I-III**)(**1-8**). If not workflow is stopped (**9**).
126 - Next, APPC performs the DistributeTraffic action (**IV**)(**10-17**). If operation is completed properly traffic should be redirected to vFW 2 and vSINK 2 instance. If not, workflow is stopped (**18**).
128 - Finally, APPC executes the DistributeTrafficCheck action (**V**) on vFW 1 in order to verify that it does not receive any traffic anymore (**19-26**) and on vFW 2 in order to verify that it receives traffic forwarded from vFW 2 (**28-35**). Workflow is stopped with failed state (**37**) if one of those conditions was not satisfied (**27, 36**)
130 .. figure:: files/vfwdt-td-workflow-sd.png
134 Figure 7 The Traffic Distribution detailed workflow
136 4. The In-Place Software Upgrade with Traffic Distribution sub-workflow (simplified workflow on Figure 8 and more detailed on Figure 9)
138 .. figure:: files/vfwdt-workflow-upgrade.png
142 Figure 8 The In-Place Software Upgrade general workflow
144 - Firstly there is performed the UpgradePreCheck LCM operation on selected vFW instance (**I**)(**1-8**). The Ansible script executed by the APPC checks if the software version is different than the one indicated in workflow's input. If it is the same the workflow is stopped (**9**).
146 - When software of selected vFW instance needs to be upgraded (**II**) then the traffic migration procedure needs to be performed (**III** - see sub-workflow 3). If migration of traffic fails workflow is stopped.
148 - Next APPC performs over Ansible procedure of in place software upgrade. In our case this is simple refresh of the software packages on VM in order to simulate some upgrade process. Successful completion of the script should set the version of the software to the one from the upgrade request. If action fails workflow is stopped without further rollback (**18**).
150 - Afterwards, APPC performs the UpgradePostCheck LCM action (**IV**)(**19-26**). The script verifies if the version of software is the same like requested before in the upgrade. If not, workflow is stopped without further rollback (**27**).
152 - Finally, when software upgrade is completed traffic migration procedure needs to be performed again (**VI**) to migrate traffic back to upgraded before vFW instance (see sub-workflow 3). If migration of traffic fails workflow is stopped and rollback is no being performed.
154 .. figure:: files/vfwdt-upgrade-workflow-sd.png
158 Figure 9 The In-Place Software Upgrade detailed workflow
163 In order to setup the scenario and to test workflows with APPC LCM APIs in action you need to perform the following steps:
165 1. Create an instance of vFWDT (vPKG , 2 x vFW, 2 x vSINK) – dedicated for the traffic migration tests
167 #. Gather A&AI facts for use case configuration
169 #. Install Software Upgrade and Traffic Distribution workflow packages
171 #. Configure Optimization Framework for Traffic Distribution candidates gathering
173 #. Configure vPKG and vFW VNFs in APPC CDT tool
175 #. Configure Ansible Server to work with vPKG and vFW VMs
177 #. Execute Traffic Distribution or In-Place Upgrade Workflows
179 You will use the following ONAP K8s VMs or containers:
181 - ONAP Rancher Server – workflow setup and its execution
183 - APPC MariaDB container – setup Ansible adapter for vFWDT VNFs
185 - APPC Ansible Server container – setup of Ansible Server, configuration of playbook and input parameters for LCM actions
187 .. note:: In all occurrences *K8S_NODE_IP* constant is the IP address of any K8s Node of ONAP OOM installation which hosts ONAP pods i.e. k8s-node-1 and *K8S-RANCHER-IP* constant is the IP address of K8S Rancher Server
189 vFWDT Service Instantiation
190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
192 In order to test workflows a dedicated vFW instance must be prepared. It differs from a standard vFW instance by having an additional VF-module with a second instance of vFW and a second instance of vSINK. Thanks to that when a service instance is deployed there are already available two instances of vFW and vSINK that can be used for migration of traffic from one vFW instance to the other one – there is no need to use the ScaleOut function to test workflows what simplifies preparations for tests.
194 In order to instantiate vFWDT service please follow the procedure for standard vFW with following changes. You can create such service manually or you can use robot framework. For manual instantiation:
196 1. Please use the following HEAT templates:
198 https://github.com/onap/demo/tree/master/heat/vFWDT
200 2. Create Virtual Service in SDC with composition like it is shown on Figure 10
202 .. figure:: files/vfwdt-service.png
206 Figure 10 Composition of vFWDT Service
208 3. Use the following payload files in the SDNC-Preload phase during the VF-Module instantiation
210 - :download:`vPKG preload example <files/vpkg-preload.json>`
212 - :download:`vFW/SNK 1 preload example <files/vfw-1-preload.json>`
214 - :download:`vFW/SNK 2 preload example <files/vfw-2-preload.json>`
216 .. note:: Use public-key that is a pair for private key files used to log into ONAP OOM Rancher server. It will simplify further configuration
218 .. note:: vFWDT has a specific configuration of the networks – different than the one in original vFW use case (see Figure 11). Two networks must be created before the heat stack creation: *onap-private* network (10.0.0.0/16 typically) and *onap-external-private* (e.g. "10.100.0.0/16"). The latter one should be connected over a router to the external network that gives an access to VMs. Thanks to that VMs can have a floating IP from the external network assigned automatically in a time of stacks' creation. Moreover, the vPKG heat stack must be created before the vFW/vSINK stacks (it means that the VF-module for vPKG must be created as a first one). The vPKG stack creates two networks for the vFWDT use case: *protected* and *unprotected*; so these networks must be present before the stacks for vFW/vSINK are created.
220 .. figure:: files/vfwdt-networks.png
224 Figure 11 Configuration of networks for vFWDT service
226 4. Go to *robot* folder in Rancher server (being *root* user)
228 Go to the Rancher node and locate *demo-k8s.sh* script in *oom/kubernetes/robot* directory. This script will be used to run heatbridge procedure which will update A&AI information taken from OpenStack
230 5. Run robot *heatbridge* in order to upload service topology information into A&AI
234 ./demo-k8s.sh onap heatbridge <stack_name> <service_instance_id> <service> <oam-ip-address>
238 - <stack_name> - HEAT stack name from: OpenStack -> Orchestration -> Stacks
239 - <service_instance_id> - is service_instance_id which you can get from VID or AAI REST API
240 - <service> - in our case it should be vFWDT but may different (vFW, vFWCL) if you have assigned different service type in SDC
241 - <oam-ip-address> - it is the name of HEAT input which stores ONAP management network name
243 Much easier way to create vFWDT service instance is to trigger it from the robot framework. Robot automates creation of service instance and it runs also heatbridge. To create vFWDT this way:
245 1. Go to *robot* folder in Rancher server (being *root* user)
247 Go to the Rancher node and locate *demo-k8s.sh* script in *oom/kubernetes/robot* directory. This script will be used to run instantiate vFWDT service
249 2. Run robot scripts for vFWDT instantiation
253 ./demo-k8s.sh onap init
254 ./ete-k8s.sh onap instantiateVFWDTGRA
257 .. note:: You can verify the status of robot's service instantiation process by going to https://K8S_NODE_IP:30209/logs/ (login/password: test/test)
259 After successful instantiation of vFWDT service go to the OpenStack dashboard and project which is configured for VNFs deployment and locate vFWDT VMs. Choose one and try to ssh into one them to prove that further ansible configuration action will be possible
263 ssh -i <rancher_private_key> ubuntu@<VM-IP>
266 .. note:: The same private key file is used to ssh into Rancher server and VMs created by ONAP
268 Preparation of Workflow Script Environment
269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
271 1. Enter over ssh Rancher server using root user
275 ssh -i <rancher_private_key> root@<K8S-RANCHER-IP>
277 2. Clone onap/demo repository
281 git clone --single-branch --branch frankfurt "https://gerrit.onap.org/r/demo"
283 3. Enter vFWDT tutorial directory
287 cd demo/tutorials/vFWDT
290 what should show following folders
294 root@sb01-rancher:~/demo/tutorials/vFWDT# ls
295 get_secret.sh playbooks policies preloads workflow
298 .. note:: Remember vFWDT tutorial directory `~/demo/tutorials/vFWDT` for the further use
300 4. Install python dependencies
304 sudo apt-get install python3-pip
305 pip3 install -r workflow/requirements.txt --user
307 Gathering Scenario Facts
308 ------------------------
309 In order to configure CDT tool for execution of Ansible playbooks and for execution of workflows we need following A&AI facts for vFWDT service
311 - **vnf-id** of generic-vnf vFW instance that we want to migrate traffic out from
312 - **vnf-type** of vPKG VNF - required to configure CDT for Distribute Traffic LCMs
313 - **vnf-type** of vFW-SINK VNFs - required to configure CDT for Distribute Traffic and Software Upgrade LCMs
315 Gathering facts from VID Portal
316 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
318 1. Enter the VID portal
322 https://K8S_NODE_IP:30200/vid/welcome.htm
324 2. In the left hand menu enter **Search for Existing Service Instances**
326 3. Select proper subscriber from the list and press **Submit** button. When service instance of vFWDT Service Type appears Click on **View/Edit** link
328 .. note:: The name of the subscriber you can read from the robot logs if your have created vFWDT instance with robot. Otherwise this should be *Demonstration* subscriber
330 4. For each VNF in vFWDT service instance note its *vnf-id* and *vnf-type*
332 .. figure:: files/vfwdt-vid-vpkg.png
336 Figure 12 vnf-type and vnf-id for vPKG VNF
338 .. figure:: files/vfwdt-vid-vnf-1.png
342 Figure 13 vnf-type and vnf-id for vFW-SINK 1 VNF
344 .. figure:: files/vfwdt-vid-vnf-2.png
348 Figure 14 vnf-type and vnf-id for vFW-SINK 2 VNF
350 Gathering facts directly from A&AI
351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
353 1. Enter OpenStack dashboard on which vFWDT instance was created and got to **Project->Compute->Instances** and read VM names of vPKG VM and 2 vFW VMs created in vFWDT service instance
355 2. Open Postman or any other REST client
357 3. In Postman in General Settings disable *SSL Certificate verification*
359 4. You can use also following Postman Collection for AAI :download:`AAI Postman Collection <files/vfwdt-aai-postman.json>`
361 5. Alternatively create Collection and set its *Authorization* to *Basic Auth* type with login/password: AAI/AAI
363 6. Create new GET query for *tenants* type with following link and read *tenant-id* value
367 https://K8S_NODE_IP:30233/aai/v14/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/RegionOne/tenants/
369 .. note:: *CloudOwner* and *Region* names are fixed for default setup of ONAP
371 7. Create new GET query for *vserver* type with following link replacing <tenant-id> with value read before and <vm-name> with vPKG VM name read from OpenStack dashboard
375 https://K8S_NODE_IP:30233/aai/v14/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/RegionOne/tenants/tenant/<tenant-id>/vservers/?vserver-name=<vm-name>
377 Read from the response (relationship with *generic-vnf* type) vnf-id of vPKG VNF
379 .. note:: If you do not receive any vserver candidate it means that heatbridge procedure was not performed or was not completed successfully. It is mandatory to continue this tutorial
381 8. Create new GET query for *generic-vnf* type with following link replacing <vnf-id> with value read from previous GET response
385 https://K8S_NODE_IP:30233/aai/v14/network/generic-vnfs/generic-vnf/<vnf-id>
387 9. Repeat this procedure also for 2 vFW VMs and note their *vnf-type* and *vnf-id*
389 Configuration of ONAP Environment
390 ---------------------------------
391 This sections show the steps necessary to configure Policies, CDT and Ansible server what is required for execution of APPC LCM actions in the workflow script
393 Configuration of Policies for Optimization Framework
394 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
395 We need to upload neccessary optimization policy rules required for the demo. The policies are required for the Optimization Framework and they guide OOF how to determine
396 vFW and vPGN instances used in the Traffic Distribution workflow.
398 1. Push the policies into the PDP
400 In order to push policies into the PDP it is required to execute already prepared *uploadPolicies.sh* script that prepares policy upload requests and automatically sends them to the Policy PDP pod
404 root@sb01-rancher:~/demo/tutorials/vFWDT# ls policies/rules/
405 QueryPolicy_vFW_TD.json affinity_vFW_TD.json uploadPolicies.sh dt-policies.sh vnfPolicy_vFW_TD.json vnfPolicy_vPGN_TD.json
407 When necessary, you can modify policy json files. Script will read these files and will build new PDP requests based on them. To create or update policies execute the script in the following way
411 ./policies/rules/uploadPolicies.sh
413 Testing Gathered Facts on Workflow Script
414 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
416 Having collected *vnf-id* and *vnf-type* parameters we can execute Traffic Distribution Workflow Python script. It works in two modes. First one executes ony initial phase where AAI and OOF
417 is used to collect neccessary information for configuration of APPC and for further execution phase. The second mode performs also second phase which executes APPC LCM actions.
419 At this stage we will execute script in the initial mode to generate some configuration helpful in CDT and Ansible configuration.
421 1. Enter vFWDT tutorial directory on Rancher server (already created in `Preparation of Workflow Script Environment`_). In the *workflow* folder you can find workflow script used to gather necessary configuration and responsible for execution of the LCM actions. It has following syntax
425 python3 workflow.py <VNF-ID> <RANCHER_NODE_IP> <K8S_NODE_IP> <IF-CACHE> <IF-VFWCL> <INITIAL-ONLY> <CHECK-STATUS> <VERSION>
427 - <VNF-ID> - vnf-id of vFW VNF instance that traffic should be migrated out from
428 - <RANCHER_NODE_IP> - External IP of ONAP Rancher Node i.e. 10.12.5.160 (If Rancher Node is missing this is NFS node)
429 - <K8S_NODE_IP> - External IP of ONAP K8s Worker Node i.e. 10.12.5.212
430 - <IF-CACHE> - If script should use and build OOF response cache (cache it speed-ups further executions of script)
431 - <IF-VFWCL> - If instead of vFWDT service instance vFW or vFWCL one is used (should be False always)
432 - <INITIAL-ONLY> - If only configuration information will be collected (True for initial phase and False for full execution of workflow)
433 - <CHECK-STATUS> - If APPC LCM action status should be verified and FAILURE should stop workflow (when False FAILED status of LCM action does not stop execution of further LCM actions)
434 - <VERSION> - New version of vFW - for tests '1.0' or '2.0'. Ignore when you want to test traffic distribution workflow
436 2. Execute there workflow script with following parameters
440 python3 workflow.py <VNF-ID> <RANCHER_NODE_IP> <K8S_NODE_IP> True False True True 2.0
442 3. The script at this stage should give simmilar output
446 Executing workflow for VNF ID '909d396b-4d99-4c6a-a59b-abe948873303' on Rancher with IP 10.0.0.10 and ONAP with IP 10.12.5.217
448 OOF Cache True, is CL vFW False, only info False, check LCM result True
450 New vFW software version 2.0
452 Starting OSDF Response Server...
454 vFWDT Service Information:
456 "vf-module-id": "0dce0e61-9309-449a-8e3e-f001635aaab1",
458 "global-customer-id": "DemoCust_ccc04407-1740-4359-b3c4-51bbcb62d9f6",
459 "service-type": "vFWDT",
460 "service-instance-id": "ab37d391-95c6-4844-b7c3-23d111bfa2ce"
463 "model-version-id": "f7fc17ba-48b9-456b-acc1-f89f31eda8cc",
464 "vnf-type": "vFWDT 2019-05-20 21:10:/vFWDT_vFWSNK b463aa83-b1fc 0",
465 "model-invariant-id": "0dfe8d6d-21c1-42f6-867a-1867cebb7751",
466 "vnf-name": "Ete_vFWDTvFWSNK_ccc04407_1"
469 "model-version-id": "0f8a2467-af44-4d7c-ac55-a346dcad9e0e",
470 "vnf-type": "vFWDT 2019-05-20 21:10:/vFWDT_vPKG a646a255-9bee 0",
471 "model-invariant-id": "75e5ec48-f43e-40d2-9877-867cf182e3d0",
472 "vnf-name": "Ete_vFWDTvPKG_ccc04407_0"
478 vofwl01pgn4407 ansible_ssh_host=10.0.210.103 ansible_ssh_user=ubuntu
480 vofwl01vfw4407 ansible_ssh_host=10.0.110.1 ansible_ssh_user=ubuntu
481 vofwl02vfw4407 ansible_ssh_host=10.0.110.4 ansible_ssh_user=ubuntu
483 The result should have almoast the same information for *vnf-id's* of both vFW VNFs. *vnf-type* for vPKG and vFW VNFs should be the same like those collected in previous steps.
484 Ansible Inventory section contains information about the content Ansible Inventor file that will be configured later on `Configuration of Ansible Server`_. The first phase of the workflow script will generate also the CDT artifacts which can be used for automatic configuration of the CDT tool - they can be ignored for manual CDT configuration.
486 Configuration of VNF in the APPC CDT tool
487 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
489 .. note:: Automated procedure can be found at the end of the section
491 Following steps aim to configure DistributeTraffic LCM action for our vPKG and vFW-SINK VNFs in APPC CDT tool.
493 1. Enter the Controller Design Tool portal
497 https://K8S_NODE_IP:30289/index.html
499 2. Click on *MY VNFS* button and login to CDT portal giving i.e. *demo* user name
501 3. Click on the *CREATE NEW VNF TYPE* button
503 .. figure:: files/vfwdt-create-vnf-type.png
507 Figure 15 Creation of new VNF type in CDT
509 4. Enter previously retrieved VNF Type for vPKG VNF and press the *NEXT* button
511 .. figure:: files/vfwdt-enter-vnf-type.png
515 Figure 16 Creation of new VNF type in CDT
517 5. For already created VNF Type (if the view does not open itself) click the *View/Edit* button. In the LCM action edit view in the first tab please choose:
519 - *DistributeTraffic* as Action name
521 - *ANSIBLE* as Device Protocol
523 - *Y* value in Template dropdown menu
525 - *admin* as User Name
527 - *8000* as Port Number
530 .. figure:: files/vfwdt-new-lcm-ref-data.png
534 Figure 17 DistributeTraffic LCM action editing
536 6. Go to the *Template* tab and in the editor paste the request template of LCM actions for vPKG VNF type
538 For DistributeTraffic and DistributeTrafficCheck LCMs
543 "InventoryNames": "VM",
544 "PlaybookName": "${book_name}",
545 "AutoNodeList": true,
547 "ConfigFileName": "../traffic_distribution_config.json",
548 "vnf_instance": "vfwdt"
551 "traffic_distribution_config.json": "${file_parameter_content}"
557 For DistributeTraffic and DistributeTrafficCheck LCMs
562 "InventoryNames": "VM",
563 "PlaybookName": "${book_name}",
564 "AutoNodeList": true,
566 "ConfigFileName": "../config.json",
567 "vnf_instance": "vfwdt",
568 "new_software_version": "${new-software-version}",
569 "existing_software_version": "${existing-software-version}"
572 "config.json": "${file_parameter_content}"
578 The meaning of selected template parameters is following:
580 - **EnvParameters** group contains all the parameters that will be passed directly to the Ansible playbook during the request's execution. *vnf_instance* is an obligatory parameter for VNF Ansible LCMs. In our case for simplification it has predefined value
581 - **InventoryNames** parameter is obligatory if you want to have NodeList with limited VMs or VNFCs that playbook should be executed on. It can have value *VM* or *VNFC*. In our case *VM* value means that NodeList will have information about VMs on which playbook should be executed. In this use case this is always only one VM
582 - **AutoNodeList** parameter set to True indicates that template does not need the NodeList section specific and it will be generated automatically base on information from AAI - this requires proper data in the vserver and vnfc objects associated with VNFs
583 - **PlaybookName** must be the same as the name of playbook that was uploaded before to the Ansible server.
584 - **FileParameters** sections contains information about the configuration files with their content necessary to execute the playbook
587 .. figure:: files/vfwdt-create-template.png
591 Figure 18 LCM DistributeTraffic request template
593 7. Afterwards press the *SYNCHRONIZE WITH TEMPLATE PARAMETERS* button. You will be moved to the *Parameter Definition* tab. The new parameters will be listed there.
595 .. figure:: files/vfwdt-template-parameters.png
599 Figure 19 Summary of parameters specified for DistributeTraffic LCM action.
601 .. note:: For each parameter you can define its: mandatory presence; default value; source (Manual/A&AI). For our case modification of this settings is not necessary
603 8. Finally, go back to the *Reference Data* tab and click *SAVE ALL TO APPC*.
605 .. note:: Remember to configure DistributeTraffic and DistributeTrafficCheck actions for vPKG VNF type and UpgradeSoftware, UpgradePreCheck, UpgradePostCheck and DistributeTrafficCheck actions for vFW-SINK
607 9. Configuration of CDT tool is also automated and all steps above can be repeated with script *configure_ansible.sh*
609 Enter vFWDT tutorial directory `Preparation of Workflow Script Environment`_ on Rancher server, make sure that *onap.pem* file is in *playbooks* directory and run
613 ./playbooks/configure_ansible.sh
615 Configuration of Ansible Server
616 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
618 .. note:: Automated procedure can be found at the end of the section
620 After an instantiation of the vFWDT service the Ansible server must be configured in order to allow it a reconfiguration of vPKG VM.
622 1. Copy from Rancher server private key file used for vFWDT VMs' creation and used for access to Rancher server into the :file:`/opt/ansible-server/Playbooks/onap.pem` file
626 sudo kubectl cp <path/to/file>/onap.pem onap/`kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep appc-ansible`:/opt/ansible-server/Playbooks/
628 .. note:: The private key file must be the same like configured at this stage `vFWDT Service Instantiation`_
630 2. Enter the Rancher server and then enter the APPC Ansible server container
634 kubectl exec -it -n onap `kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep appc-ansible` -- sh
636 3. Give the private key file a proper access rights
640 cd /opt/ansible-server/Playbooks/
642 chown ansible:ansible onap.pem
644 4. Edit the :file:`/opt/ansible-server/Playbooks/Ansible\ \_\ inventory` file including all the hosts of vFWDT service instance used in this use case.
645 The content of the file is generated by workflow script `Testing Gathered Facts on Workflow Script`_
650 vofwl01pgn4407 ansible_ssh_host=10.0.210.103 ansible_ssh_user=ubuntu
652 vofwl01vfw4407 ansible_ssh_host=10.0.110.1 ansible_ssh_user=ubuntu
653 vofwl02vfw4407 ansible_ssh_host=10.0.110.4 ansible_ssh_user=ubuntu
655 .. note:: Names of hosts and their IP addresses will be different. The names of the host groups are the same like 'vnfc-type' attributes configured in the CDT templates
657 5. Configure the default private key file used by Ansible server to access hosts over ssh
661 vi /etc/ansible/ansible.cfg
666 host_key_checking = False
667 private_key_file = /opt/ansible-server/Playbooks/onap.pem
670 .. note:: This is the default private key file. In the `/opt/ansible-server/Playbooks/Ansible\ \_\ inventory` different key could be configured but APPC in time of execution of playbook on Ansible server creates its own dedicated inventory file which does not have private key file specified. In consequence, this key file configured is mandatory for proper execution of playbooks by APPC
673 6. Test that the Ansible server can access over ssh vFWDT hosts configured in the ansible inventory
677 ansible –i Ansible_inventory vpgn,vfw-sink –m ping
680 7. Download the LCM playbooks into the :file:`/opt/ansible-server/Playbooks` directory
682 Exit Ansible server pod and enter vFWDT tutorial directory `Preparation of Workflow Script Environment`_ on Rancher server. Afterwards, copy playbooks into Ansible server pod
686 sudo kubectl cp playbooks/vfw-sink onap/`kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep appc-ansible`:/opt/ansible-server/Playbooks/
687 sudo kubectl cp playbooks/vpgn onap/`kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep appc-ansible`:/opt/ansible-server/Playbooks/
689 8. Configuration of ansible server is also automated and all steps above can be repeated with script *configure_ansible.sh* introduced in the previous section
691 9. After the configuration of Ansible server with script the structure of `/opt/ansible-server/Playbooks` directory should be following
695 /opt/ansible-server/Playbooks $ ls -R
697 ansible.cfg Ansible_inventory configure_ansible.sh onap.pem server.py upgrade.sh vfw-sink vpgn
705 ./vfw-sink/latest/ansible:
706 distributetrafficcheck upgradepostcheck upgradeprecheck upgradesoftware
708 ./vfw-sink/latest/ansible/distributetrafficcheck:
711 ./vfw-sink/latest/ansible/upgradepostcheck:
714 ./vfw-sink/latest/ansible/upgradeprecheck:
717 ./vfw-sink/latest/ansible/upgradesoftware:
726 ./vpgn/latest/ansible:
727 distributetraffic distributetrafficcheck
729 ./vpgn/latest/ansible/distributetraffic:
732 ./vpgn/latest/ansible/distributetrafficcheck:
736 Configuration of APPC DB for Ansible
737 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
739 .. note:: Automated procedure can be found at the end of the section
741 For each VNF that uses the Ansible protocol you need to configure *PASSWORD* and *URL* field in the *DEVICE_AUTHENTICATION* table. This step must be performed after configuration in CDT which populates data in *DEVICE_AUTHENTICATION* table.
743 1. Read APPC DB password
745 Enter vFWDT tutorial directory `Preparation of Workflow Script Environment`_ on Rancher server.
749 ./get_secret.sh `kubectl get secrets | grep appc-db-root-pass`
751 2. Enter the APPC DB container
755 kubectl exec -it -n onap `kubectl get pods -o go-template --template '{{range .items}}{{.metadata.name}}{{"\n"}}{{end}}' | grep appc-db-0` -- sh
757 3. Enter the APPC DB CLI
763 4. Execute the following SQL commands
767 MariaDB [(none)]> use sdnctl;
768 MariaDB [sdnctl]> UPDATE DEVICE_AUTHENTICATION SET URL = 'http://appc-ansible-server:8000/Dispatch' WHERE WHERE PROTOCOL LIKE 'ANSIBLE' AND URL IS NULL;
769 MariaDB [sdnctl]> UPDATE DEVICE_AUTHENTICATION SET PASSWORD = 'admin' WHERE PROTOCOL LIKE 'ANSIBLE' AND PASSWORD IS NULL;
770 MariaDB [sdnctl]> select * from DEVICE_AUTHENTICATION WHERE PROTOCOL LIKE 'ANSIBLE';
772 Result should be similar to the following one:
776 +--------------------------+------------------------------------------------------+----------+------------------------+-----------+----------+-------------+------------------------------------------+
777 | DEVICE_AUTHENTICATION_ID | VNF_TYPE | PROTOCOL | ACTION | USER_NAME | PASSWORD | PORT_NUMBER | URL |
778 +--------------------------+------------------------------------------------------+----------+------------------------+-----------+----------+-------------+------------------------------------------+
779 | 118 | vFWDT 2020-04-21 17-26-/vFWDT_vFWSNK 1faca5b5-4c29 1 | ANSIBLE | DistributeTrafficCheck | admin | admin | 8000 | http://appc-ansible-server:8000/Dispatch |
780 | 121 | vFWDT 2020-04-21 17-26-/vFWDT_vFWSNK 1faca5b5-4c29 1 | ANSIBLE | UpgradeSoftware | admin | admin | 8000 | http://appc-ansible-server:8000/Dispatch |
781 | 124 | vFWDT 2020-04-21 17-26-/vFWDT_vFWSNK 1faca5b5-4c29 1 | ANSIBLE | UpgradePreCheck | admin | admin | 8000 | http://appc-ansible-server:8000/Dispatch |
782 | 127 | vFWDT 2020-04-21 17-26-/vFWDT_vFWSNK 1faca5b5-4c29 1 | ANSIBLE | UpgradePostCheck | admin | admin | 8000 | http://appc-ansible-server:8000/Dispatch |
783 | 133 | vFWDT 2020-04-21 17-26-/vFWDT_vPKG 8021eee9-3a8f 0 | ANSIBLE | DistributeTraffic | admin | admin | 8000 | http://appc-ansible-server:8000/Dispatch |
784 | 136 | vFWDT 2020-04-21 17-26-/vFWDT_vPKG 8021eee9-3a8f 0 | ANSIBLE | DistributeTrafficCheck | admin | admin | 8000 | http://appc-ansible-server:8000/Dispatch |
785 +--------------------------+------------------------------------------------------+----------+------------------------+-----------+----------+-------------+------------------------------------------+
787 6 rows in set (0.00 sec)
789 4. Configuration of APPC DB is also automated and all steps above can be repeated with script *configure_ansible.sh* introduced in the previous sections
795 Since all the configuration of components of ONAP is already prepared it is possible to enter second phase of workflows execution -
796 the execution of APPC LCM actions with configuration resolved before by OptimizationFramework.
802 In order to run workflows execute following commands from the vFWDT tutorial directory `Preparation of Workflow Script Environment`_ on Rancher server.
804 For Traffic Distribution workflow run
809 python3 workflow.py 909d396b-4d99-4c6a-a59b-abe948873303 10.12.5.217 10.12.5.63 True False False True
812 The order of executed LCM actions for Traffic Distribution workflow is following:
814 1. CheckLock on vPKG, vFW-1 and vFW-2 VMs
815 2. Lock on vPKG, vFW-1 and vFW-2 VMs
816 3. DistributeTrafficCheck on vPKG VM - ansible playbook checks if traffic destinations specified by OOF is not configured in the vPKG and traffic does not go from vPKG already.
817 If vPKG send already traffic to destination the playbook will fail and workflow will break.
818 4. DistributeTraffic on vPKG VM - ansible playbook reconfigures vPKG in order to send traffic to destination specified before by OOF.
819 5. DistributeTrafficCheck on vFW-1 VM - ansible playbook checks if traffic is not present on vFW from which traffic should be migrated out. If traffic is still present after 30 seconds playbook fails
820 6. DistributeTrafficCheck on vFW-2 VM - ansible playbook checks if traffic is present on vFW from which traffic should be migrated out. If traffic is still not present after 30 seconds playbook fails
821 7. Lock on vPKG, vFW-1 and vFW-2 VMs
824 For In-Place Software Upgrade with Traffic Distribution workflow run
829 python3 workflow.py 909d396b-4d99-4c6a-a59b-abe948873303 10.12.5.217 10.12.5.63 True False False True 2.0
832 The order of executed LCM actions for In-Place Software Upgrade with Traffic Distribution workflow is following:
834 1. CheckLock on vPKG, vFW-1 and vFW-2 VMs
835 2. Lock on vPKG, vFW-1 and vFW-2 VMs
836 3. UpgradePreCheck on vFW-1 VM - checks if the software version on vFW is different than the one requested in the workflow input
837 4. DistributeTrafficCheck on vPKG VM - ansible playbook checks if traffic destinations specified by OOF is not configured in the vPKG and traffic does not go from vPKG already.
838 If vPKG send already traffic to destination the playbook will fail and workflow will break.
839 5. DistributeTraffic on vPKG VM - ansible playbook reconfigures vPKG in order to send traffic to destination specified before by OOF.
840 6. DistributeTrafficCheck on vFW-1 VM - ansible playbook checks if traffic is not present on vFW from which traffic should be migrated out. If traffic is still present after 30 seconds playbook fails
841 7. DistributeTrafficCheck on vFW-2 VM - ansible playbook checks if traffic is present on vFW from which traffic should be migrated out. If traffic is still not present after 30 seconds playbook fails
842 8. UpgradeSoftware on vFW-1 VM - ansible playbook modifies the software on the vFW instance and sets the version of the software to the specified one in the request
843 9. UpgradePostCheck on vFW-1 VM - ansible playbook checks if the software of vFW is the same like the one specified in the workflows input.
844 10. DistributeTraffic on vPKG VM - ansible playbook reconfigures vPKG in order to send traffic to destination specified before by OOF (reverse configuration).
845 11. DistributeTrafficCheck on vFW-2 VM - ansible playbook checks if traffic is not present on vFW from which traffic should be migrated out. If traffic is still present after 30 seconds playbook fails
846 12. DistributeTrafficCheck on vFW-1 VM - ansible playbook checks if traffic is present on vFW from which traffic should be migrated out. If traffic is still not present after 30 seconds playbook fails
847 13. Unlock on vPKG, vFW-1 and vFW-2 VMs
850 For both workflows when everything is fine with both workflows change of the traffic should be observed on following dashboards (please turn on automatic reload of graphs). The observed traffic pattern for upgrade scenario should be similar to the one presented in Figure 2
854 http://vSINK-1-IP:667/
855 http://vSINK-2-IP:667/
860 Expected result of Traffic Distribution workflow execution, when everything is fine, is following:
864 Distribute Traffic Workflow Execution:
865 WORKFLOW << Migrate vFW Traffic Conditionally >>
866 APPC LCM << CheckLock >> [Check vPGN Lock Status]
868 APPC LCM << CheckLock >> [Check vFW-1 Lock Status]
870 APPC LCM << CheckLock >> [Check vFW-2 Lock ]
872 APPC LCM << Lock >> [Lock vPGN]
874 APPC LCM << Lock >> [Lock vFW-1]
876 APPC LCM << Lock >> [Lock vFW-2]
878 APPC LCM << DistributeTrafficCheck >> [Check current traffic destination on vPGN]
880 APPC LCM << DistributeTrafficCheck >> [Status]
885 WORKFLOW << Migrate Traffic and Verify >>
886 APPC LCM << DistributeTraffic >> [Migrating source vFW traffic to destination vFW]
888 APPC LCM << DistributeTraffic >> [Status]
898 APPC LCM << DistributeTrafficCheck >> [Checking traffic has been stopped on the source vFW]
900 APPC LCM << DistributeTrafficCheck >> [Status]
905 APPC LCM << DistributeTrafficCheck >> [Checking traffic has appeared on the destination vFW]
907 APPC LCM << DistributeTrafficCheck >> [Status]
911 APPC LCM << Unlock >> [Unlock vPGN]
913 APPC LCM << Unlock >> [Unlock vFW-1]
915 APPC LCM << Unlock >> [Unlock vFW-2]
919 In case we want to execute operation and one of the VNFs is locked because of other operation being executed:
923 Distribute Traffic Workflow Execution:
924 WORKFLOW << Migrate vFW Traffic Conditionally >>
925 APPC LCM << CheckLock >> [Check vPGN Lock Status]
927 Traceback (most recent call last):
928 File "workflow.py", line 1235, in <module>
929 sys.argv[6].lower() == 'true', sys.argv[7].lower() == 'true', new_version)
930 File "workflow.py", line 1209, in execute_workflow
931 _execute_lcm_requests({"requests": lcm_requests, "description": "Migrate vFW Traffic Conditionally"}, onap_ip, check_result)
932 File "workflow.py", line 101, in wrap
933 ret = f(*args, **kwargs)
934 File "workflow.py", line 1007, in _execute_lcm_requests
935 raise Exception("APPC LCM << {} >> FAILED".format(req['input']['action']))
936 Exception: APPC LCM << CheckLock >> FAILED
939 In case of failure the result can be following:
943 Distribute Traffic Workflow Execution:
944 WORKFLOW << Migrate vFW Traffic Conditionally >>
945 APPC LCM << CheckLock >> [Check vPGN Lock Status]
947 APPC LCM << CheckLock >> [Check vFW-1 Lock Status]
949 APPC LCM << CheckLock >> [Check vFW-2 Lock ]
951 APPC LCM << Lock >> [Lock vPGN]
953 APPC LCM << Lock >> [Lock vFW-1]
955 APPC LCM << Lock >> [Lock vFW-2]
957 APPC LCM << DistributeTrafficCheck >> [Check current traffic destination on vPGN]
959 APPC LCM << DistributeTrafficCheck >> [Status]
961 APPC LCM <<DistributeTrafficCheck>> [FAILED - FAILED]
962 WORKFLOW << Migrate Traffic and Verify >> SKIP
963 APPC LCM << Unlock >> [Unlock vPGN]
965 APPC LCM << Unlock >> [Unlock vFW-1]
967 APPC LCM << Unlock >> [Unlock vFW-2]
971 .. note:: When CDT and Ansible is configured properly Traffic Distribution Workflow can fail when you pass as a vnf-id argument the ID of vFW VNF which does not handle traffic at the moment. To solve that pass the VNF ID of the other vFW VNF instance. Because of the same reason you cannot execute twice in a row workflow for the same VNF ID if first execution succeeds.