aboutsummaryrefslogtreecommitdiffstats
path: root/test/hpa_automation/heat/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/hpa_automation/heat/README.md')
-rw-r--r--test/hpa_automation/heat/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/test/hpa_automation/heat/README.md b/test/hpa_automation/heat/README.md
new file mode 100644
index 000000000..93c6b5b59
--- /dev/null
+++ b/test/hpa_automation/heat/README.md
@@ -0,0 +1,16 @@
+## Guide for hpa_automation.py script in heat
+
+These guide describes how to run the hpa_automation.py script. It can be used to run the vFW and vDNS end to end use cases.
+
+## Prerequisites
+
+ 1. Install ONAP CLI. See [link](https://onap.readthedocs.io/en/dublin/submodules/cli.git/docs/installation_guide.html)
+ 2. Install python mysql.connector (pip install mysql-connector-python)
+ 3. Must have connectivity to the ONAP, a k8s vm already running is recommended as connectivity to the ONAP k8s network is required for the SDC onboarding section.
+ 4. Create policies for homing using the temp_resource_module_name specified in hpa_automation_config.json. Sample policies can be seen in the sample_vfw_policies directory. Be sure to specify the right path to the directory in hpa_automation_config.json
+ 5. Create Nodeport for Policy pdp using the pdp_service_expose.yaml file (copy pdp_service_expose.yaml in hpa_automation/heat to rancher and run kubectl apply -f pdp_expose.yaml)
+ 6. Put in the CSAR file to be used to create service models and specify its path in hpa_automation_config.json
+ 7. Modify the SO bpmn configmap to change the SO vnf adapter endpoint to v2. See step 4 [here](https://onap.readthedocs.io/en/casablanca/submodules/integration.git/docs/docs_vfwHPA.html#docs-vfw-hpa)
+ 8. Prepare sdnc_preload file and put in the right path to its location in hpa_automation_config.json
+ 9. Put in the right parameters for automation in hpa_automation_config.json
+ 10. Ensure the insert_policy_models_heat.py script is in the same location as the hpa_automation.py script as the automation scripts calls the insert_policy_models_heat.py script.