vFW CNF CDS usecase automation scripts update

[demo.git] / heat / vFW_CNF_CDS / automation / README.md

diff --git a/heat/vFW_CNF_CDS/automation/README.md b/heat/vFW_CNF_CDS/automation/README.md
index a37ec9d..41eb4f0 100755 (executable)
--- a/heat/vFW_CNF_CDS/automation/README.md
+++ b/heat/vFW_CNF_CDS/automation/README.md
@@ -1,20 +1,24 @@
-# vFW_CNF_CDS use case automation
+# CNF automation
 
 0. Make sure you have python 3.8.x installed and default interpreter, what is required by onap-pythonsdk
 1. Install required packages with pipenv `pipenv install`
 2. Run virtual environment `pipenv shell`. In case of problems use `--fancy` option
    
    **In case of problems with pipenv:** `venv` can be used as well. In that case, please install all required python packages in correct version according the list in `Pipfile`
-3. Add kubeconfig file for k8s cluster that will host vFW
+3. Add kubeconfig file for k8s cluster that will host your CNF
    - `artifacts/cluster_kubeconfig`
 4. Prepare onboarding packages `cd ../templates/ && make && cd ../automation/`
 5. Modify `config.py`:
    - NATIVE - enables native helm orchestration path in SO
-   - CLOUD_REGION
+   - SKIP_POST_INSTANTIATION - whether post instantiation configuration should be run
+   - MACRO_INSTANTIATION - instantiation method used: macro or a'la carte
+   - K8S_NAMESPACE - k8s namespace to use for deployment of CNF
+   - K8S_VERSION - version of the k8s cluster
+   - K8S_REGION - name of the k8s region from the CLOUD_REGIONS 
+   - CLOUD_REGIONS - configuration of k8s or Openstack regions
    - GLOBAL_CUSTOMER_ID
    - VENDOR
    - SERVICENAME
-   - CUSTOMER_RESOURCE_DEFINITIONS - add list of CRDs to be installed on non KUD k8s cluster
    - VNF_PARAM_LIST - list of parameters to pass for VNF creation process
    - VF_MODULE_PARAM_LIST - list of parameters to pass for VF Module creation
 6. __Important:__ Before running python scripts, some settings for `onapsdk` with information about ONAP endpoints (and socks) have to be exported. 
@@ -22,8 +26,8 @@
    ```shell
    (automation) ubuntu@onap:~/automation$ export ONAP_PYTHON_SDK_SETTINGS="onap_settings"
    ```
-7. Run script `python create_k8s_region.py` in order to create **k8s cloud region**
-8. Onboard **vFW** `python onboard.py`
-9. Instantiate **vFW** `python instantiate.py`
-10. Once test is done, **vFW** service instance can be deleted with `python delete.py` command
+7. Run script `python create_cloud_regions.py` in order to create **k8s or openstack cloud region**
+8. Onboard CNF `python onboard.py`
+9. Instantiate CNF `python instantiate.py`
+10. Once test is done, CNF service instance can be deleted with `python delete.py` command