refactor instantiate section to be more "purpose" oriented

[doc.git] / docs / guides / onap-user / instantiate / instantiation / so1 / index.rst

diff --git a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst b/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
index 86f03bd..c7bd278 100644 (file)
--- a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
@@ -8,29 +8,82 @@
 A La Carte mode Service Instantiation via ONAP SO API
 =====================================================
 
-Using ONAP SO API in "A La Carte" mode, you need to send several requests,
-depending on the service model composition.
+Using ONAP SO API in "A La Carte" mode, the user needs to send
+a request to instantiate the service object but also for each VNF/VF-module
+and network that compose the Service.
 
-For example, if your service model is composed of 2 VNF and a Network,
-you will have to build and send :
+ONAP will instantiate resources on Cloud platforms only when user is requesting
+to instantiate VF-module or Network (openstack neutron or contrail).
 
-* a request to SO to create the "service instance" object
-* a request to SO to create the VNF 1 instance object
-* a request to SDNC to declare VNF 1 instance parameters and values
-  (SDNC preload)
-* a request to SO to create the Vf-module 1 instance object
-* a request to SO to create the VNF 2 instance object
-* a request to SDNC to declare VNF 2 instance parameters and values
-  (SDNC preload)
-* a request to SO to create the Vf-module 2 instance object
-* a request to SO to create the Network instance object
+To instantiate a VF-module, it is required to have instantiated a VNF object.
 
+To instantiate a VNF object, it is required to have instantiated
+a Service object.
 
+To instantiate a Network object, it is required to have instantiated
+a Service object.
+
+**Requests**
+    * `Request to instantiate Service object`_
+    * `Request to instantiate VNF object`_
+    * `Requests to instantiate VF-module object`_
+    * `Requests to instantiate Neutron Network object`_
+    * `Requests to instantiate a Contrail Network object`_
+
+
+Request to instantiate Service object
+-------------------------------------
 
 Example to request a service instance directly to ONAP SO
 
+::
 
-TO BE COMPLETED
+  curl -X POST \
+    http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstances/v7/serviceInstances \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-FromAppId: AAI' \
+    -H 'X-TransactionId: get_aai_subscr' \
+    -H 'cache-control: no-cache' \
+    -d '{
+    "requestDetails": {
+      "requestInfo": {
+        "instanceName": "integration_test_service_instance_001",
+        "source": "VID",
+        "suppressRollback": false,
+        "requestorId": "demo"
+      },
+      "modelInfo": {
+        "modelType": "service",
+        "modelInvariantId": "b0631a6c-ec7a-4f0c-a9ac-4423d9d67a7f",
+        "modelVersionId": "aafd5523-2cc5-4c86-957e-18bc37355f7a",
+        "modelName": "integration_test_ubuntu16",
+        "modelVersion": "1.0"
+      },
+          "cloudConfiguration": {
+              "tenantId": "3e3b55ca4c9948d1a9fa68715831c6bd",
+              "cloudOwner": "OPNFV",
+              "lcpCloudRegionId": "RegionOne"
+          },
+      "requestParameters": {
+        "userParams": [],
+        "testApi": "VNF_API",
+        "subscriptionServiceType": "integration_test_ubuntu16",
+        "aLaCarte": true
+      },
+      "subscriberInfo": {
+        "globalSubscriberId": "integration_test_customer"
+      },
+      "project": {
+        "projectName": "integration_test_project"
+      },
+      "owningEntity": {
+        "owningEntityId": "6b5b6b70-4e9a-4f6f-8b7b-cbd7cf990c6e",
+        "owningEntityName": "integration_test_OE"
+      }
+    }
+  }'
 
 
 
@@ -53,7 +106,10 @@ This will allow you to get the serviceOrder Status (completed, failed...)
     -H 'cache-control: no-cache'
 
 
-To instantiate a VNF, you need to build a complex request.
+Request to instantiate VNF object
+---------------------------------
+
+To instantiate a VNF, you need to build an other request.
 All necessary parameters are available in the Tosca service template
 generated by SDC when you defined your service model.
 
@@ -115,6 +171,10 @@ generated by SDC when you defined your service model.
   }
   }'
 
+
+Requests to instantiate VF-module object
+----------------------------------------
+
 To instantiate a VF module, you need to build two complex requests
 All necessary parameters are available in the Tosca service template
 generated by SDC when you defined your service model.
@@ -235,12 +295,15 @@ The 2nd request is to instantiate the VF module via ONAP SO
 
 
 
+Requests to instantiate Neutron Network object
+----------------------------------------------
+
 To instantiate a Neutron Network, you need to build two complex request.
 All necessary parameters are available in the Tosca service template
 generated by SDC when you defined your service model.
 
 
-1st request is the "SDNC-preload" for a network object:
+1st request is the "SDNC-preload" for a neutron network object:
 
 ::
 
@@ -303,7 +366,7 @@ generated by SDC when you defined your service model.
   }'
 
 
-2nd request is to instantiate the network via ONAP SO
+2nd request is to instantiate the neutron network via ONAP SO
 (instance name must be identical in both requests)
 
 
@@ -364,3 +427,9 @@ generated by SDC when you defined your service model.
       }]
     }
   }'
+
+
+Requests to instantiate a Contrail Network object
+-------------------------------------------------
+
+TO BE COMPLETED