aboutsummaryrefslogtreecommitdiffstats
path: root/test/postman/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/postman/README.md')
-rw-r--r--test/postman/README.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/test/postman/README.md b/test/postman/README.md
new file mode 100644
index 000000000..86a797b8f
--- /dev/null
+++ b/test/postman/README.md
@@ -0,0 +1,68 @@
+# Postman Collections
+
+## Description
+
+That repository contains 9 Postman collections and 2 environment files.
+
+They have been tested with Onap Casablanca (they are not compatible with
+ Beijing, and there is not guaranty about ONAP "master" as API definition
+ can change)
+
+You first need to import all those files into your Postman.
+![postman](./images/import.png)
+
+And you should see all the collections
+![postman](./images/collections.png)
+
+Each collection is made of several API operations
+![postman](./images/collection-detail.png)
+
+Running all those collections, in the order, from 1 to 8 will create a lot of
+objects in ONAP components :
+
+- SDC : vendor, VSP, zip file upload, VF from VSP, Service, add VF to Service
+- VID : OwningEntity, LineOfBusiness, Project, Platform
+- AAI : customer, subscription, cloud region, tenant
+- NBI : serviceOrder to add a service instance, serviceOrder to delete a service
+ instance
+
+The order is very important because a lot of API request will need the API
+ response from the previous operation.
+![postman](./images/collection-detail-test.png)
+
+It is possible to run the complete collection.
+![postman](./images/run.png)
+
+You need, a zip file that contains Heat files for a VNF.
+
+Collection 3 is about uploading that file into ONAP SDC.
+![postman](./images/zipfile.png)
+
+Before running those collections, once in Postman, you need to have a look
+at "globals" environment parameters.
+![postman](./images/globals.png)
+
+All variables that begin by "auto_" must not be change (they will be modified
+ using API response)
+All other variables must be adapted to your needs.
+In particular, you need to put your own values for cloud_region_id, tenant_name
+ and tenant_id to fit with the place where you will instantiate the VNF
+
+```yaml
+ service:freeradius
+ vf_name:integration_test_VF_freeradius
+ vsp_name:integration_test_VSP
+ vendor_name:onap_integration_vendor
+ owning_entity:integration_test_OE
+ platform:integration_test_platform
+ project:integration_test_project
+ lineofbusiness:integration_test_LOB
+ customer_name:generic
+ cloud_owner_name:OPNFV
+ cloud_region_id:RegionOne
+ tenant_name:openlab-vnfs
+ tenant_id:234a9a2dc4b643be9812915b214cdbbb
+ externalId:integration_test_BSS-001
+ service_instance_name:integration_test_freeradius_instance_001
+ listener_url:http://10.4.2.65:8080/externalapi/listener/v1/listener
+```