From 07c28e0a81383f76f5d563f265db27519d4922f1 Mon Sep 17 00:00:00 2001 From: "stark, steven" Date: Tue, 24 Mar 2020 10:57:14 -0700 Subject: [VVP] Updating documentation for test-engine Issue-ID: VVP-393 Signed-off-by: stark, steven Change-Id: Id52cef3b5b5d8b695aaa2cf92d8ab734c66f35f3 --- README.md | 19 +- onap-client/README.md | 124 +++-- onap-client/setup.py | 2 +- ovp_testsuite/README.md | 503 ++++++++++++++++++++- .../examples/vLB/templates/base_template.env | 2 +- 5 files changed, 603 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 4640904..056f66b 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# TODO +# Test-Engine + + +## About + +This repository contains two subprojects. View the ``README`` in each subdirectory for more information about each project. + + +## onap-client + + +This project contains a python package installable via ``pip``, and provides a programmatic, cli, and templatting interface to interact with various ONAP applications. + + +## ovp_testsuite + + +This project contains the OVP VNF Lifecycle Validation code that is executed to obtain a Heat VNF OVP badge. \ No newline at end of file diff --git a/onap-client/README.md b/onap-client/README.md index bc0e932..dbc9f23 100644 --- a/onap-client/README.md +++ b/onap-client/README.md @@ -10,7 +10,8 @@ Full license text at https://creativecommons.org/licenses/by/4.0/legalcode ## About -ONAP Client is an api-client for interacting with various ONAP applications. + +ONAP Client is an api-client written in python for interacting with various ONAP applications. There are three interfaces for using the client. - cli @@ -19,8 +20,10 @@ There are three interfaces for using the client. More details regarding usage is given below. + ## Installation + Either use pip or setup.py to install. ``` @@ -31,15 +34,23 @@ $ pip install . --upgrade ### Config File + After installation, you need to create a configuration file for your ONAP installation. Use the file ``etc/config.example.yaml`` from this repo as a starter config file, and replace the values with those specific to your environment. The config file needs to be located at ``/etc/onap_client/config.yaml``. If you don't have permissions to move it there, or you have multiple ONAP environments to interact with, you can also set the environment variable ``OC_CONFIG`` to the full-path of your config file. +``` +$ export OC_CONFIG=/path/to/config.yaml +``` + + ## Usage + ### CLI + Use ``onap-client [options]`` to interact with the command-line client. The command-line options that are ONAP applications are created dynamically, and all follow the same pattern. Use ``--help`` to show more details about what options are available. ``` @@ -84,8 +95,10 @@ $ onap-client sdc --help +---------------+---------------------------------------------+---------------------+---------------------+ ``` + From here, you can invoke the SDC health check, or view the other options available for SDC. + ``` $ onap-client sdc license-model --help +-------------------------------------+----------------------------------------------------------------------------------------+---------------------------------+---------------------+ @@ -99,40 +112,9 @@ $ onap-client sdc license-model --help | | | --license-model-id | | | | | --license-model-version-id | | | | | | | -| add-entitlement-pool | Adds an entitlement pool to a license model | --license-start-date | --keys, --search | -| | | --license-end-date | | -| | | --entitlement-pool-name | | -| | | --license-model-id | | -| | | --license-model-version-id | | -| | | | | -| add-feature-group | Adds an feature group to a license model | --feature-group-name | --keys, --search | -| | | --key-group-id | | -| | | --entitlement-pool-id | | -| | | --manufacturer-reference-number | | -| | | --license-model-id | | -| | | --license-model-version-id | | -| | | | | -| add-license-agreement | Adds an license agreement to a license model | --feature-group-id | --keys, --search | -| | | --license-agreement-name | | -| | | --license-model-id | | -| | | --license-model-version-id | | -| | | | | -| submit-license-model | Submits a license model | --action | --keys, --search | -| | | --license-model-id | | -| | | --license-model-version-id | | -| | | | | -| get-license-model | Returns a license model | --license-model-id | --keys, --search | -| | | --license-model-version-id | | -| | | | | -| get-license-model-version-attribute | Returns an attribute for a license model (license-agreements, features-groups, etc...) | --license-model-id | --keys, --search | -| | | --license-model-version-id | | -| | | --attribute | | -| | | | | -| get-license-model-versions | Returns the version list for a license model | --license-model-id | --keys, --search | -| | | | | -| get-license-models | Returns the full list of license models from SDC | | --keys, --search | -| | | | | -+-------------------------------------+----------------------------------------------------------------------------------------+---------------------------------+---------------------+ +... +... +... ``` From here, there are a lot of different actions available for license-model. To invoke one, just pass the action name as well as all the required parameters. @@ -150,8 +132,10 @@ $ onap-client sdc license-model add-license-model --vendor-name "thisisatestvend ... ``` + ### Python + To use the onap-client in a script, create an instance of the Client class: ``` @@ -161,9 +145,9 @@ c = Client() ``` -Each request follows the same pattern as using the cli. You can check the required parameters by using the cli with the ``--help`` flag. A request will return a ``RequestHandler`` object. +Each request follows the same pattern as using the cli, and parameters are passed as ``**kwargs``. You can check the required parameters by using the cli with the ``--help`` flag. Each request will return a ``RequestHandler`` object. -To create a license model in the same way as shown above: +For example, to create a license model in the same way as shown above: ``` from onap_client.client.clients import Client @@ -174,11 +158,12 @@ license_model = c.sdc.license_model.add_license_model(vendor_name="MyNewVendor") status = license_model.status_code raw_api_response = license_model.response_data - ``` + ### Utility CLI + The utility CLI is more handcrafted than the other cli options. A developer has to mark a function in the codebase as a ``utility`` function for it to show up as available from the cli. These functions are more for quality of life activities. For example, to retrieve the tosca model for a service from SDC, you have to: @@ -188,6 +173,14 @@ These functions are more for quality of life activities. For example, to retriev That can be cumbersome, especially if there are a lot of services created. Instead, there's a utility function for it: +``` +$ onap-client utility get-service "testservice" +``` + + +#### View all available utility functions + + ``` $ onap-client utility --help +--------------------------+-----------------------------------------------+----------------+ @@ -208,13 +201,49 @@ $ onap-client utility --help | get-vsp | None | | | | | | +--------------------------+-----------------------------------------------+----------------+ - -$ onap-client utility get-service "testservice" ``` ### Spec-Engine CLI -The spec engine CLI is a simple templating engine that you can feed JSON files into in order to interact with various ONAP components. The structure of the JSON files is: + +The spec engine CLI is a simple templating engine that you can feed JSON files into in order to interact with ONAP applications. A JSON spec file will have various ONAP resource definitions, and by loading the file into the engine it will create the resources in ONAP. For a simple comparison, think of it like writing a heat-template, but for ONAP. + + +``` +$ onap-client spec-engine --help +usage: onap-client [-h] [--load-spec LOAD_SPEC] + [--validate-spec VALIDATE_SPEC] + [--show-resource-spec SHOW_RESOURCE_SPEC] + [--list-spec-resources] + +Spec Engine CLI + +optional arguments: + -h, --help show this help message and exit + --load-spec LOAD_SPEC + Load a local spec file into the ONAP client spec + engine. + --validate-spec VALIDATE_SPEC + Validates a local spec file for the spec engine. + --show-resource-spec SHOW_RESOURCE_SPEC + Show spec for a given resource. + --list-spec-resources + List available spec resources. +``` + + +#### Loading a spec.json file + + +``` +$ onap-client spec-engine --load-spec +``` + + +#### Creating a spec file + + +The structure of a JSON spec file is: Must be a JSON Dictionary @@ -227,7 +256,9 @@ Must be a JSON Dictionary - ``type``: value must be an available ``spec`` type (see below for how to find available spec types) - ``resource_spec``: key/value dict with input properties and values (see below for how to find required and optional properties) -To view the available ``spec`` types, use the cli. + +#### View the available ``spec`` types + ``` $ onap-client spec-engine --list-spec-resources @@ -241,7 +272,9 @@ SERVICE LICENSE_MODEL ``` -View the required and optional properties: + +#### View the required and optional properties for a spec type: + ``` $ onap-client spec-engine --show-resource-spec SERVICE_INSTANCE @@ -301,8 +334,13 @@ $ onap-client spec-engine --show-resource-spec SERVICE_INSTANCE } ``` + +#### Example spec + + Here is a complete example spec to create a service model for a VNF: + ``` { "parameters": { diff --git a/onap-client/setup.py b/onap-client/setup.py index be6077c..7806e3b 100644 --- a/onap-client/setup.py +++ b/onap-client/setup.py @@ -47,7 +47,7 @@ for file in os.listdir("etc/payloads"): setuptools.setup( name="onap-client", - version="0.2.0", + version="0.3.0", author="Steven Stark", author_email="steven.stark@att.com", description="Python API wrapper for ONAP applications", diff --git a/ovp_testsuite/README.md b/ovp_testsuite/README.md index 4640904..734974c 100644 --- a/ovp_testsuite/README.md +++ b/ovp_testsuite/README.md @@ -1 +1,502 @@ -# TODO +# VNF Lifecycle Validation (OVP Badging) + + +## About + + +This page contains instructions for executing the [VNF Lifecycle Validation](https://wiki.lfnetworking.org/display/LN/VNF+Validation+Minimum+Viable+Product) automation flow for **heat-based** VNFs. The result will be a ``.tar.gz`` file that can be used to submit to the [OVP Portal](https://vnf-verified.lfnetworking.org/#/) to obtain a certification badge for a VNF. The execution is very similar to [running the other ONAP demo VNFs](https://wiki.onap.org/display/DW/Running+the+ONAP+Demos), however there are some additional steps detailed below. + +The OVP VNF testsuite was introduced in the ONAP El Alto release, and used the existing ONAP Robot pod and framework. The code in this repository was introduced in Frankfurt. It will most likely work on ONAP El Alto deployments, however it's recommended to continue to use the original OVP testsuite for El Alto, and use the testsuite here for Frankfurt and beyond. + + +## Changes from El Alto Original Release + + +The testsuite operates the same as in El Alto, but there are a few changes you may need to be aware of before proceeding. + + +- VNF_API is no longer supported. You **MUST** use GR_API. +- The ``subscriber`` field in ``vnf-details.json`` has been replaced with ``customer``. If you are planning to re-use a ``vnf-details.json`` file from El Alto, you need to update that field. +- ONAP Robot pod and framework no longer used. +- ``log.html`` is now ``log.txt`` + + +## Prerequisites + + +- [ONAP deployed via OOM](https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_quickstart_guide.html). +- An OpenStack deployment. +- kubectl +- bash +- VNF Heat Templates +- Preload json files + + +After deploying ONAP, you need to configure ONAP with: + +- A cloud owner +- A cloud region +- A customer +- A service type +- A project name +- An owning entity +- A platform +- A line of business +- A cloud site + + +If you're not familiar with how to configure ONAP, there are guides that use [robot](https://onap.readthedocs.io/en/latest/submodules/integration.git/docs/docs_robot.html) or [direct api requests](https://wiki.onap.org/pages/viewpage.action?pageId=25431491) available to help, as well as a [guide for adding a new OpenStack site to ONAP](https://docs.onap.org/en/latest/guides/onap-user/cloud_site/openstack/index.html). + + +## Preparing the VNF + + +The vnf lifecycle validation testsuite requires the VNF to be packaged into a specific directory hierarchy, shown below. + +``` +vnf_folder +├── /templates +| └── base.yaml +| └── base.env +| └── incremental_0.yaml +| └── incremental_0.env +| └── ... +├── /preloads +| └── base_preload.json +| └── incremental_0_preload.json +| └── ... +└── vnf-details.json +``` + +- The name for ``vnf_folder`` is free-form, and can be located anywhere on your computer. The path to this folder will be passed to the testsuite as an argument. +- ``/templates`` should contain your [VVP-compliant](https://docs.onap.org/en/latest/submodules/vvp/documentation.git/docs/index.html) VNF heat templates. +- ``/preloads`` should contain a preload file for each VNF module in the format for GR_API. + - ``vnf-name``, ``vnf-type``, ``vf-module-type``, and ``vf-module-name`` should be empty strings. + - This information will be populated at runtime by the testsuite. +- ``vnf-details`` should be a json file with the information that will be used by ONAP to instantiate the VNF. The structure of vnf-details is shown below. + + +### Example VNF-Details + + +``` +{ + "vnf_name": "The Vnf Name", + "description": "Description of the VNF", + "modules": [ + { + "filename": "base.yaml", + "isBase": "true", + "preload": "base_preload.json" + }, + { + "filename": "incremental_0.yaml", + "isBase": "false", + "preload": "incremental_0.json" + }, + ... + ], + "api_type": "gr_api", + "customer": "", + "service_type": "", + "tenant_name": "", + "region_id": "", + "cloud_owner": "", + "project_name": "", + "owning_entity": "", + "platform": "", + "line_of_business": "", + "os_password": "" +} +``` + +- ``modules`` must contain an entry for each module of the VNF. Only one module can be a base module. +- ``api_type`` should match the format of the preloads that are provided in the package. +- The other information should match what was used to configure ONAP during the pre-requisite section of this guide. + + +## Running the Testsuite + + +The script ``instantiate-k8s.sh`` located in this repository is used to execute the testsuite. + + +**NOTE**: The first time running the testsuite on your K8 cluster will take longer than subsequent runs. The first execution creates a K8 pod and installs required software pre-requisites, which can take five minutes or more. Subsequent executions will re-use the same pod. + + +### Cloning and Navigating to the Testsuite + + +``` +$ git clone "https://gerrit.onap.org/r/vvp/test-engine" +$ cd test-engine/ovp_testsuite +$ ./instantiate-k8s.sh --help +./instantiate-k8s.sh [options] + +required: +-n, --namespace namespace that onap is running under. +-f, --folder path to folder containing heat templates, preloads, and vnf-details.json. + +This script executes the OVP VNF instantiation testsuite. +- It creates a container that will contain all of the installation requirements. +- It models, distributes, and instantiates a heat-based VNF. +- It copies the logs to an output directory, and creates a tarball for upload to the OVP portal. +``` + + +### Executing the Testsuite + + +``` +# Execute instantiate-k8s.sh to start the testsuite +$ ./instantiate-k8s.sh --folder /tmp/test-engine/ovp_testsuite/examples/vLB/ --namespace onap ++ check_required_parameter onap --namespace ++ '[' -z onap ']' ++ check_required_parameter /tmp/test-engine/ovp_testsuite/examples/vLB/ --folder ++ '[' -z /tmp/test-engine/ovp_testsuite/examples/vLB/ ']' ++ '[' -z /tmp/VVPQ69g/kubeconfig ']' ++ kubectl -n onap get configmap ovp-test-suite-vol +NAME DATA AGE +ovp-test-suite-vol 1 5d20h ++ '[' 0 -ne 0 ']' ++ kubectl -n onap get pod ovp-test +NAME READY STATUS RESTARTS AGE +ovp-test 1/1 Running 0 5d20h ++ '[' 0 -ne 0 ']' ++ mkdir /tmp/OVP-b3nx ++ echo '' + ++ echo 'Your output directory is /tmp/OVP-b3nx, look here for logs after the test has finished.' +Your output directory is /tmp/OVP-b3nx, look here for logs after the test has finished. +... +... +... +================================================================ +OVP Test Case has finished, generating output in /tmp/OVP-b3nx. + +--------------------Results-------------------- +Test Start Time: 1585069559 +VVP Validation Scripts: SUCCESS +ONAP Modeling and Instantiation: SUCCESS +Stack Validation: SUCCESS + +... +... +``` + + +## Results + + +Once the testsuite is finished, it will create a directory and tarball in /tmp (the name of the directory and file is shown at the end of the stdout of the script). There will be a ``results.json`` in that directory that has the ultimate outcome of the test, in the structure shown below. + + +## Log files + + +The output file will have 4 log files in it. + +``results.json``: This is high-level results file of all of the test steps, and is consumed by the OVP portal. +``report.json``: This is the output of the vvp validation scripts. +``stack_report.json``: This is the output from querying openstack to validate the heat modules. +``log.txt``: This stdout log, and contains each execution step of the testcase. + + +### results.json + +``` +{ + "vnf_checksum": "a3e66ab6790f40947d7888a45fb5552b6966553c6172538b88accea5bf330a52", + "build_tag": "eeb98797-722f-423c-bb91-7ff4d2e4d04e", + "version": "2019.12", + "test_date": "2020-03-24 10:31:57", + "duration": 1563, + "vnf_type": "heat", + "testcases_list": [ + { + "mandatory": "true", + "name": "onap-vvp.validate.heat", + "result": "SUCCESS", + "objective": "onap heat template validation", + "sub_testcase": [], + "portal_key_file": "report.json" + }, + { + "mandatory": "true", + "name": "onap-vvp.lifecycle_validate.heat", + "result": "SUCCESS", + "objective": "onap vnf lifecycle validation", + "sub_testcase": [ + { + "name": "model-and-distribute", + "result": "SUCCESS" + }, + { + "name": "instantiation", + "result": "SUCCESS" + } + ], + "portal_key_file": "log.txt" + }, + { + "mandatory": "true", + "name": "stack_validation", + "result": "SUCCESS", + "objective": "onap vnf openstack validation", + "sub_testcase": [], + "portal_key_file": "stack-validation.json" + } + ] +} +``` + + +## Cleaning Up The Testsuite + + +After executing the testsuite, you'll (hopefully) have an instantiated VNF. If you want to delete it, you can use VID BAU to login and delete the Service, VNF, and Module instance(s). + +Alternatively, you can use kubectl to login to the OVP pod that was created and delete all the VNF components from the cli. Here's how: + +First, you need to figure out the Service instance and VNF instance names that were created. These follow the naming convention ``SI`` and ``SI_VNF``. Your build string is used to create the output directory at the end of the testsuite. In the example above, the output directory was ``/tmp/OVP-b3nx``, so the build string is ``b3nx``. + +Next, you need to figure out each of your module names. These are the same as the heat stack names, but if you don't want to log into openstack to find them, they also follow a naming convention using the build_string: ``SI_VNF__``. So from the example above, the module names would be: ``SI_VNF_b3nx_base_template``, ``SI_VNF_b3nx_vdns``, ``SI_VNF_b3nx_vpkg``, ``SI_VNF_b3nx_vlb``. + +Next, login to the OVP pod and start deleting them, starting with modules first, then VNF instance, then Service Instance. **Make sure that you delete all the other modules before deleting the base module**. + +``` +# login to the OVP pod +$ kubectl -n onap exec -it ovp-test bash +bash-5.0# + +# Activate the virtualenv with the installed pre-reqs +bash-5.0# . /tmp/vvp_env/test_env/bin/activate +(test_env) bash-5.0# + +# Look at the syntax to delete a VNF Module Instance +(test_env) bash-5.0# onap-client utility delete-module-instance --help ++------------------------+----------------------------------+-------------------------+ +| name | description | parameters | ++------------------------+----------------------------------+-------------------------+ +| --help | | | +| | | | +| delete-module-instance | Delete a Module Instance from SO | | +| | | | +| | | | +| | | | +| | | | ++------------------------+----------------------------------+-------------------------+ + +(test_env) bash-5.0# onap-client utility delete-module-instance SIb3nx SI_VNFb3nx SI_VNF_b3nx_vlb GR_API +2020-03-24 18:41:40,629 { + "method": "GET", + "auth": "***********", + "url": "https://sdnc:8443/restconf/config/GENERIC-RESOURCE-API:services", + "headers": { + "Accept": "application/json", + "Content-Type": "application/json", + "X-TransactionId": "bffbee67-6071-4bb0-9b42-c54c630c51bd", + "X-FromAppId": "robot-ete" + } +} +2020-03-24 18:41:40,629 Submitting request: Get a list of all service instances +/usr/local/lib/python3.7/site-packages/urllib3/connectionpool.py:1004: InsecureRequestWarning: Unverified HTTPS request is being made to host 'sdnc'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings + InsecureRequestWarning, +2020-03-24 18:41:40,913 Request was successful +2020-03-24 18:41:40,920 { + "method": "DELETE", + "auth": "***********", + "url": "http://so:8080/onap/so/infra/serviceInstantiation/v7/serviceInstances/83f6b4b9-bf5d-4176-a931-a4a0e89d869b/vnfs/8cf4782e-24b6-462e-aac0-edf879444768/vfModules/34cfac51-862a-4455-9d0b-de775c66179d", + "headers": { + "Accept": "application/json", + "Content-Type": "application/json", + "X-FromAppId": "robot-ete" + }, + "data": " {\n \"requestDetails\": {\n \"requestInfo\": {\n \"source\": \"VID\",\n \"requestorId\": \"cs0008\"\n },\n \"modelInfo\": {\n \"modelType\": \"vfModule\",\n \"modelInvariantId\": \"633d369c-5557-4690-a920-cffe60b0808d\",\n \"modelName\": \"Vnfb3nx..vlb..module-2\",\n \"modelVersion\": \"1\"\n },\n \"requestParameters\": {\n \"testApi\": \"GR_API\"\n },\n \"cloudConfiguration\": {\n \"lcpCloudRegionId\": \"ONAPREGION\",\n \"tenantId\": \"f9daf5a9a50747429ee786ee9c2b41b3\",\n \"cloudOwner\": \"ONAPOWNER\"\n }\n }\n }" +} +2020-03-24 18:41:40,920 Submitting request: Deletes a VNF Module Instance. +2020-03-24 18:41:42,421 Request was successful +{ + "requestReferences": { + "requestId": "52944b25-6b82-4954-ba26-40f52a51c65a", + "instanceId": "34cfac51-862a-4455-9d0b-de775c66179d", + "requestSelfLink": "http://so:8080/orchestrationRequests/v7/52944b25-6b82-4954-ba26-40f52a51c65a" + } +} +``` + + +**NOTE**: When you send a delete request, it will return a ``requestId``. The ``requestId`` from above is ``52944b25-6b82-4954-ba26-40f52a51c65a``. Use this request ID to poll until the request finishes. + + +``` +(test_env) bash-5.0# onap-client utility poll-request 52944b25-6b82-4954-ba26-40f52a51c65a +2020-03-24 18:43:48,174 { + "method": "GET", + "auth": "***********", + "url": "http://so:8080/onap/so/infra/orchestrationRequests/v7/52944b25-6b82-4954-ba26-40f52a51c65a", + "headers": { + "Accept": "application/json", + "Content-Type": "application/json", + "X-TransactionId": "5027d330-b38c-4bef-9803-a3f0d5acb386", + "X-FromAppId": "robot-ete" + } +} +... +... +... + "requestStatus": { + "requestState": "COMPLETE", + "statusMessage": "STATUS: ALaCarte-VfModule-deleteInstance request was executed correctly. FLOW STATUS: Successfully completed all Building Blocks", + "percentProgress": 100, + "timestamp": "Tue, 24 Mar 2020 18:47:18 GMT" + }, +... +... +(test_env) bash-5.0# +``` + + +Continue to delete each of the modules. + + +``` +(test_env) bash-5.0# onap-client utility delete-module-instance SIb3nx SI_VNFb3nx SI_VNF_b3nx_vpkg GR_API +... +... +{ + "requestReferences": { + "requestId": "5f16ed41-ef99-4a73-972e-2d8380646fc3", + "instanceId": "16d9b141-fb31-4489-b39e-457fa3ae2a17", + "requestSelfLink": "http://so:8080/orchestrationRequests/v7/5f16ed41-ef99-4a73-972e-2d8380646fc3" + } +} +(test_env) bash-5.0# onap-client utility poll-request 5f16ed41-ef99-4a73-972e-2d8380646fc3 +... +... + "requestStatus": { + "requestState": "COMPLETE", + "statusMessage": "STATUS: ALaCarte-VfModule-deleteInstance request was executed correctly. FLOW STATUS: Successfully completed all Building Blocks", + "percentProgress": 100, + "timestamp": "Tue, 24 Mar 2020 18:48:50 GMT" + }, +... +... +(test_env) bash-5.0# onap-client utility delete-module-instance SIb3nx SI_VNFb3nx SI_VNF_b3nx_vdns GR_API +... +... +{ + "requestReferences": { + "requestId": "3e3fa519-a93d-4b5a-bc5b-ba87aff361cf", + "instanceId": "172dfaac-cbc1-4793-a487-dc3c21ce595b", + "requestSelfLink": "http://so:8080/orchestrationRequests/v7/3e3fa519-a93d-4b5a-bc5b-ba87aff361cf" + } +} +(test_env) bash-5.0# onap-client utility poll-request 3e3fa519-a93d-4b5a-bc5b-ba87aff361cf +... +... + "requestStatus": { + "requestState": "COMPLETE", + "statusMessage": "STATUS: ALaCarte-VfModule-deleteInstance request was executed correctly. FLOW STATUS: Successfully completed all Building Blocks", + "percentProgress": 100, + "timestamp": "Tue, 24 Mar 2020 18:55:45 GMT" + }, +(test_env) bash-5.0# onap-client utility delete-module-instance SIb3nx SI_VNFb3nx SI_VNF_b3nx_base_template GR_API +... +... +{ + "requestReferences": { + "requestId": "386cb6f5-019b-45a1-8813-ae80ab3324b9", + "instanceId": "ef2dffb3-c41d-4072-8634-c7be73ef3caa", + "requestSelfLink": "http://so:8080/orchestrationRequests/v7/386cb6f5-019b-45a1-8813-ae80ab3324b9" + } +} +(test_env) bash-5.0# onap-client utility poll-request 386cb6f5-019b-45a1-8813-ae80ab3324b9 +... +... + "requestStatus": { + "requestState": "COMPLETE", + "statusMessage": "STATUS: ALaCarte-VfModule-deleteInstance request was executed correctly. FLOW STATUS: Successfully completed all Building Blocks", + "percentProgress": 100, + "timestamp": "Tue, 24 Mar 2020 19:08:06 GMT" + }, +``` + + +Now, delete the VNF and Service instance. + + +``` +# View syntax to delete VNF Instance +(test_env) bash-5.0# onap-client utility delete-vnf-instance --help ++---------------------+-------------------------------+-------------------------+ +| name | description | parameters | ++---------------------+-------------------------------+-------------------------+ +| --help | | | +| | | | +| delete-vnf-instance | Delete a VNF Instance from SO | | +| | | | +| | | | +| | | | ++---------------------+-------------------------------+-------------------------+ + +# Send delete vnf instance request +(test_env) bash-5.0# onap-client utility delete-vnf-instance SIb3nx SI_VNFb3nx GR_API +... +... +{ + "requestReferences": { + "requestId": "618e02ce-be72-4722-950b-1d03754a1d2e", + "instanceId": "8cf4782e-24b6-462e-aac0-edf879444768", + "requestSelfLink": "http://so:8080/orchestrationRequests/v7/618e02ce-be72-4722-950b-1d03754a1d2e" + } +} + +(test_env) bash-5.0# onap-client utility poll-request 618e02ce-be72-4722-950b-1d03754a1d2e +... +... + "requestStatus": { + "requestState": "COMPLETE", + "statusMessage": "STATUS: ALaCarte-Vnf-deleteInstance request was executed correctly. FLOW STATUS: Successfully completed all Building Blocks", + "percentProgress": 100, + "timestamp": "Tue, 24 Mar 2020 19:15:22 GMT" + }, + +# View syntax to delete Service instance +(test_env) bash-5.0# onap-client utility delete-service-instance --help ++-------------------------+-----------------------------------+-------------------------+ +| name | description | parameters | ++-------------------------+-----------------------------------+-------------------------+ +| --help | | | +| | | | +| delete-service-instance | Delete a Service Instance from SO | | +| | | | +| | | | ++-------------------------+-----------------------------------+-------------------------+ + +# Send request to delete service instance +(test_env) bash-5.0# onap-client utility delete-service-instance SIb3nx GR_API +... +... + "requestReferences": { + "requestId": "ee8dc971-66ed-4520-81d1-a6fedd7e0a57", + "instanceId": "83f6b4b9-bf5d-4176-a931-a4a0e89d869b", + "requestSelfLink": "http://so:8080/orchestrationRequests/v7/ee8dc971-66ed-4520-81d1-a6fedd7e0a57" + } + +(test_env) bash-5.0# onap-client utility poll-request ee8dc971-66ed-4520-81d1-a6fedd7e0a57 +... +... + "requestStatus": { + "requestState": "COMPLETE", + "statusMessage": "STATUS: ALaCarte-Service-deleteInstance request was executed correctly. FLOW STATUS: Successfully completed all Building Blocks", + "percentProgress": 100, + "timestamp": "Tue, 24 Mar 2020 19:22:07 GMT" + }, +``` + +## Examples + + +In this repository is an example that you can use to try out the testcase, located in the ``examples`` directory. It uses the vLB Heat Templates that are used in various other ONAP use-cases. + diff --git a/ovp_testsuite/examples/vLB/templates/base_template.env b/ovp_testsuite/examples/vLB/templates/base_template.env index ac81b89..eec8396 100644 --- a/ovp_testsuite/examples/vLB/templates/base_template.env +++ b/ovp_testsuite/examples/vLB/templates/base_template.env @@ -16,4 +16,4 @@ parameters: # PRIVATE KEY key_name: vlb_key - pub_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCVsoLHb2/NxPxb3ZjPCsMmQg4WIP5QatlMY31lHdotxSr0xh0E3DOI6G1bS3TXWfz7HZnoY3ozkvdX0seq8PI9xWnoLrzvo9oQfFv6FFn1e0Pj62EYJ3SGTgDXEU4QjwNHa5zy71Lk2vetl9OIr29X1kPNXuvlMUar3OVHIvxROQKjsbbXFrzxD/9kpdOtl344JId3rahgomPiKzjq/RS6jXJaVMDVaQJAS/C/SwjQirO21ZJL5+YT3sHl9wheAtQAmuhSW7WKw+IzhfguIVxbgSHYQ96oqvOWQIHV41fZ+vn++8+5I3buWmlErfyRe3Vf2dLt0xhn7VqZDA+h1OgJ SS820F@Stevens-MacBook-Pro.local \ No newline at end of file + pub_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCimjj/DSIHCeC60kimJqw4QFxge/YjfnrXx76tVvm6iNfPGbwu/LzOzS0xDQSw8lcmM71Ys09OBSw9+6HqpBsKL+hDZxWYAyY/qfl0fXWirKoIZbUy6xYHDJEv9z0sMa3NG3d2jRVkANKx9rrpcM2p5GeLalyGTEibNI2ZHQL9L2qjKfHrchi3oQvkMYzj38lzUc6+Sawp/kx2iLgFKQDkRbSSNRUCiB+rmK1ZBIt0XzIogEfQCSDOQVFm4vqtga1QJOtoJzmad1oP6m9YpqPOi7DZxRt373xAdOHRmQJKk9iQhwBaNm8wHTYKUfoKh+chDeVgA/1JECIhgxcqjKUf stark@DUMMYCOMP \ No newline at end of file -- cgit 1.2.3-korg