updates for ElAlto in User-Guides

Issue-ID: DOC-566

Signed-off-by: Rene_Robert <rene.robert@orange.com>
Change-Id: Ib5a0509a4a9e8a63a473040a2a4757264bd3b24a

diff --git a/docs/guides/onap-user/cloud_site/openstack/index.rst b/docs/guides/onap-user/cloud_site/openstack/index.rst
index d7df9e6..8688ff3 100644 (file)
--- a/docs/guides/onap-user/cloud_site/openstack/index.rst
+++ b/docs/guides/onap-user/cloud_site/openstack/index.rst
@@ -318,6 +318,38 @@ Check the Cloud Site creation in ONAP AAI:
     -H 'cache-control: no-cache' -k
 
 
+Associate an Availability zone to a Cloud site in ONAP AAI:
+
+::
+
+  curl -X PUT \
+    https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/MyCompanyName/INTEGRATION_CENTER/availability-zones/availability-zone/brittany \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic QUFJOkFBSQ==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-FromAppId: AAI' \
+    -H 'X-TransactionId: get_aai_subscr' \
+    -H 'cache-control: no-cache' \
+    -d '{
+      "availability-zone-name": "brittany",
+      "hypervisor-type": "KVM"
+  }'
+
+
+Check the operation:
+
+::
+
+  curl -X GET \
+    https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/MyCompanyName/INTEGRATION_CENTER/availability-zones \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic QUFJOkFBSQ==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-FromAppId: AAI' \
+    -H 'X-TransactionId: 808b54e3-e563-4144-a1b9-e24e2ed93d4f' \
+    -H 'cache-control: no-cache'
+
+
 
 STEP 3 : Register the Cloud Site in ONAP Multicloud
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst b/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
index 4e2314d..af2edc8 100644 (file)
--- a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
@@ -39,12 +39,11 @@ Example to request a service instance directly to ONAP SO
 ::
 
   curl -X POST \
-    http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstances/v7/serviceInstances \
+    http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/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 'X-ONAP-PartnerName: NBI' \
     -H 'cache-control: no-cache' \
     -d '{
     "requestDetails": {
@@ -56,20 +55,20 @@ Example to request a service instance directly to ONAP SO
       },
       "modelInfo": {
         "modelType": "service",
-        "modelInvariantId": "b0631a6c-ec7a-4f0c-a9ac-4423d9d67a7f",
-        "modelVersionId": "aafd5523-2cc5-4c86-957e-18bc37355f7a",
-        "modelName": "integration_test_ubuntu16",
+        "modelInvariantId": "48d7ceec-7975-406c-8b96-cb3fbdbcfa33",
+        "modelVersionId": "33a99ef7-b5a3-4603-b21e-790582b4567e",
+        "modelName": "integration_test_service_ubuntu16",
         "modelVersion": "1.0"
       },
           "cloudConfiguration": {
-              "tenantId": "3e3b55ca4c9948d1a9fa68715831c6bd",
-              "cloudOwner": "OPNFV",
+              "tenantId": "dd8fce79e74a4989a6be6b6c5e55acef",
+              "cloudOwner": "cloudOwner",
               "lcpCloudRegionId": "RegionOne"
           },
       "requestParameters": {
         "userParams": [],
         "testApi": "VNF_API",
-        "subscriptionServiceType": "integration_test_ubuntu16",
+        "subscriptionServiceType": "integration_test_service_ubuntu16",
         "aLaCarte": true
       },
       "subscriberInfo": {
@@ -79,14 +78,13 @@ Example to request a service instance directly to ONAP SO
         "projectName": "integration_test_project"
       },
       "owningEntity": {
-        "owningEntityId": "6b5b6b70-4e9a-4f6f-8b7b-cbd7cf990c6e",
-        "owningEntityName": "integration_test_OE"
+        "owningEntityId": "8874891f-5120-4b98-b452-46284513958d",
+        "owningEntityName": "OE-Generic"
       }
     }
   }'
 
 
-
 In the response, you will obtain the serviceOrderId value.
 
 Then you have the possibility to check about the SO request
@@ -116,60 +114,62 @@ generated by SDC when you defined your service model.
 ::
 
   curl -X POST \
-  http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstances/v6/95762b50-0244-4723-8fde-35f911db9263/vnfs \
-  -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": {
-      "productFamilyId": "0d463b0c-e559-4def-8d7b-df64cfbd3159",
-      "instanceName": "my_service_vnf_instance_001",
-      "source": "VID",
-      "suppressRollback": false,
-      "requestorId": "test"
-    },
-  "modelInfo": {
-    "modelType": "vnf",
-    "modelInvariantId": "4e66bb92-c597-439e-822d-75aaa69b13d4",
-      "modelVersionId": "3b6ba59c-287c-449e-a1da-2db49984a087",
-      "modelName": "my_service_VF",
-      "modelVersion": "1.0",
-      "modelCustomizationId": "",
-      "modelCustomizationName": ""
-    },
-    "requestParameters": {
-      "userParams": [],
-      "aLaCarte": true,
-    "testApi": "VNF_API"
-    },
-    "cloudConfiguration": {
-      "lcpCloudRegionId": "my_cloud_site",
-      "tenantId": "5906b9b8fd9642df9ba1c9e290063439"
-    },
-    "lineOfBusiness": {
-      "lineOfBusinessName": "test_LOB"
-    },
-    "platform": {
-      "platformName": "test_platform"
-    },
-    "relatedInstanceList": [{
-      "relatedInstance": {
-        "instanceId": "95762b50-0244-4723-8fde-35f911db9263",
-        "modelInfo": {
-          "modelType": "service",
-          "modelName": "my-service-model",
-          "modelInvariantId": "11265d8c-2cc2-40e5-95d8-57cad81c18da",
-          "modelVersion": "1.0",
-          "modelVersionId": "0d463b0c-e559-4def-8d7b-df64cfbd3159"
+    http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances/7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722/vnfs \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-ONAP-PartnerName: NBI' \
+    -H 'cache-control: no-cache' \
+    -d '{
+    "requestDetails": {
+      "requestInfo": {
+        "instanceName": "integration_test_vnf_instance_002",
+        "source": "VID",
+        "suppressRollback": false,
+        "requestorId": "test",
+      "productFamilyId": "1234"
+      },
+    "modelInfo": {
+      "modelType": "vnf",
+      "modelInvariantId": "661a34ce-6f76-4ebf-ad94-814a9fc8a2aa",
+        "modelVersionId": "7e7d453c-0085-4df2-b4b5-91281ea2e710",
+        "modelName": "integration_test_VF_ubuntu16_2",
+        "modelVersion": "1.0",
+        "modelCustomizationId": "342c14b4-8a24-46dd-a8c3-ff39dd7949e9",
+        "modelCustomizationName": "integration_test_VF_ubuntu16_2 0"
+      },
+      "requestParameters": {
+        "userParams": [],
+        "aLaCarte": true,
+      "testApi": "VNF_API"
+      },
+      "cloudConfiguration": {
+        "lcpCloudRegionId": "RegionOne",
+        "cloudOwner": "cloudOwner",
+        "tenantId": "dd8fce79e74a4989a6be6b6c5e55acef"
+      },
+      "lineOfBusiness": {
+        "lineOfBusinessName": "integration_test_LOB"
+      },
+      "platform": {
+        "platformName": "integration_test_platform"
+      },
+      "relatedInstanceList": [{
+        "relatedInstance": {
+          "instanceId": "7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722",
+          "modelInfo": {
+            "modelType": "service",
+            "modelName": "integration_test_service_ubuntu16",
+            "modelInvariantId": "48d7ceec-7975-406c-8b96-cb3fbdbcfa33",
+            "modelVersion": "1.0",
+            "modelVersionId": "33a99ef7-b5a3-4603-b21e-790582b4567e"
+          }
         }
-      }
-    }]
+      }]
+    }
   }
-  }'
+
+  '
 
 
 Requests to instantiate VF-module object
@@ -186,43 +186,43 @@ that will be needed for the instantiation
 ::
 
   curl -X POST \
-  https://sdnc.api.simpledemo.onap.org:30267/restconf/operations/VNF-API:preload-vnf-topology-operation \
-  -H 'Accept: application/json' \
-  -H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \
-  -H 'Content-Type: application/json' \
-  -H 'X-FromAppId: API client' \
-  -H 'X-TransactionId: 0a3f6713-ba96-4971-a6f8-c2da85a3176e' \
-  -H 'cache-control: no-cache' \
-  -d '{
-    "input": {
-        "request-information": {
-            "notification-url": "onap.org",
-            "order-number": "1",
-            "order-version": "1",
-            "request-action": "PreloadVNFRequest",
-            "request-id": "test"
-        },
-        "sdnc-request-header": {
-            "svc-action": "reserve",
-            "svc-notification-url": "http:\/\/onap.org:8080\/adapters\/rest\/SDNCNotify",
-            "svc-request-id": "test"
-        },
-        "vnf-topology-information": {
-            "vnf-assignments": {
-                "availability-zones": [],
-                "vnf-networks": [],
-                "vnf-vms": []
-            },
-            "vnf-parameters": [],
-            "vnf-topology-identifier": {
-                "generic-vnf-name": "my_service_vnf_instance_001",
-                "generic-vnf-type": "",
-                "service-type": "95762b50-0244-4723-8fde-35f911db9263",
-                "vnf-name": "my_service_vfmodule_001",
-                "vnf-type": ""
-            }
-        }
-    }
+    https://sdnc.api.simpledemo.onap.org:30267/restconf/operations/VNF-API:preload-vnf-topology-operation \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-FromAppId: API client' \
+    -H 'X-TransactionId: 0a3f6713-ba96-4971-a6f8-c2da85a3176e' \
+    -H 'cache-control: no-cache' \
+    -d '{
+      "input": {
+          "request-information": {
+              "notification-url": "onap.org",
+              "order-number": "1",
+              "order-version": "1",
+              "request-action": "PreloadVNFRequest",
+              "request-id": "test"
+          },
+          "sdnc-request-header": {
+              "svc-action": "reserve",
+              "svc-notification-url": "http:\/\/onap.org:8080\/adapters\/rest\/SDNCNotify",
+              "svc-request-id": "test"
+          },
+          "vnf-topology-information": {
+              "vnf-assignments": {
+                  "availability-zones": [],
+                  "vnf-networks": [],
+                  "vnf-vms": []
+              },
+              "vnf-parameters": [],
+              "vnf-topology-identifier": {
+                  "generic-vnf-name": "integration_test_vnf_instance_002",
+                  "generic-vnf-type": "integration_test_VF_ubuntu16_2 0",
+                  "service-type": "7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722",
+                  "vnf-name": "integration_test_vfmodule_002",
+                  "vnf-type": "IntegrationTestVfUbuntu162..base_ubuntu16..module-0"
+              }
+          }
+      }
   }'
 
 The 2nd request is to instantiate the VF module via ONAP SO
@@ -231,66 +231,66 @@ The 2nd request is to instantiate the VF module via ONAP SO
 ::
 
   curl -X POST \
-  http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstances/v6/95762b50-0244-4723-8fde-35f911db9263/vnfs/vfModules \
-  -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": "my_vfmodule_001",
-      "source": "VID",
-      "suppressRollback": false,
-      "requestorId": "test"
+    http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances/7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722/vnfs/9764c2af-e4b0-413d-80cd-b65014ea0926/vfModules \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-ONAP-PartnerName: NBI' \
+    -H 'cache-control: no-cache' \
+    -d '{
+    "requestDetails": {
+      "requestInfo": {
+        "instanceName": "integration_test_vfmodule_002",
+        "source": "VID",
+        "suppressRollback": false,
+        "requestorId": "test"
+      },
+    "modelInfo": {
+      "modelType": "vfModule",
+      "modelInvariantId": "273bef63-1f26-4b14-91e0-003fa203ead2",
+      "modelVersionId": "7cdf75de-ff3c-4a7d-a7e0-ecbc00693e8e",
+      "modelName": "IntegrationTestVfUbuntu162..base_ubuntu16..module-0",
+      "modelVersion": "1",
+      "modelCustomizationId": "470956aa-b739-4cdd-b114-7ce032f65b18",
+      "modelCustomizationName": "IntegrationTestVfUbuntu162..base_ubuntu16..module-0"
     },
-  "modelInfo": {
-    "modelType": "vfModule",
-    "modelInvariantId": "",
-    "modelVersionId": "",
-    "modelName": "",
-    "modelVersion": "1",
-    "modelCustomizationId": "",
-    "modelCustomizationName": ""
-  },
-  "requestParameters": {
-    "userParams": [],
-    "testApi": "VNF_API",
-    "usePreload": true
-  },
-    "cloudConfiguration": {
-      "lcpCloudRegionId": "my_cloud_site",
-      "tenantId": "5906b9b8fd9642df9ba1c9e290063439"
+    "requestParameters": {
+      "userParams": [],
+      "testApi": "VNF_API",
+      "usePreload": true
     },
-    "relatedInstanceList": [{
-      "relatedInstance": {
-        "instanceId": "95762b50-0244-4723-8fde-35f911db9263",
-        "modelInfo": {
-          "modelType": "service",
-          "modelName": "my-service-model",
-          "modelInvariantId": "11265d8c-2cc2-40e5-95d8-57cad81c18da",
-          "modelVersion": "1.0",
-          "modelVersionId": "0d463b0c-e559-4def-8d7b-df64cfbd3159"
+      "cloudConfiguration": {
+        "lcpCloudRegionId": "RegionOne",
+        "cloudOwner": "cloudOwner",
+        "tenantId": "dd8fce79e74a4989a6be6b6c5e55acef"
+      },
+      "relatedInstanceList": [{
+        "relatedInstance": {
+          "instanceId": "7d550d9e-e1c4-4a21-a2bb-1c3ced8a8722",
+          "modelInfo": {
+            "modelType": "service",
+            "modelName": "integration_test_service_ubuntu16",
+            "modelInvariantId": "48d7ceec-7975-406c-8b96-cb3fbdbcfa33",
+            "modelVersion": "1.0",
+            "modelVersionId": "33a99ef7-b5a3-4603-b21e-790582b4567e"
+          }
         }
-      }
-    },
-    {
-      "relatedInstance": {
-        "instanceId": "",
-        "modelInfo": {
-          "modelType": "vnf",
-          "modelName": "my_service_model_VF",
-          "modelInvariantId": "4e66bb92-c597-439e-822d-75aaa69b13d4",
-          "modelVersion": "1.0",
-          "modelVersionId": "3b6ba59c-287c-449e-a1da-2db49984a087",
-          "modelCustomizationId": "",
-          "modelCustomizationName": ""
+      },
+      {
+        "relatedInstance": {
+          "instanceId": "9764c2af-e4b0-413d-80cd-b65014ea0926",
+          "modelInfo": {
+            "modelType": "vnf",
+            "modelName": "integration_test_VF_ubuntu16_2",
+            "modelInvariantId": "661a34ce-6f76-4ebf-ad94-814a9fc8a2aa",
+            "modelVersion": "1.0",
+            "modelVersionId": "7e7d453c-0085-4df2-b4b5-91281ea2e710",
+            "modelCustomizationId": "342c14b4-8a24-46dd-a8c3-ff39dd7949e9",
+            "modelCustomizationName": "integration_test_VF_ubuntu16_2 0"
+          }
         }
-      }
-    }]
-  }
+      }]
+    }
   }'
 
 
@@ -373,7 +373,7 @@ generated by SDC when you defined your service model.
 ::
 
   curl -X POST \
-  http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstances/v6/95762b50-0244-4723-8fde-35f911db9263/networks \
+  http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstantiation/v7/95762b50-0244-4723-8fde-35f911db9263/networks \
   -H 'Accept: application/json' \
   -H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
   -H 'Content-Type: application/json' \
@@ -386,8 +386,7 @@ generated by SDC when you defined your service model.
           "instanceName": "my_network_01",
           "source": "VID",
           "suppressRollback": false,
-          "requestorId": "demo",
-          "productFamilyId": "b9ac88f7-0e1b-462d-84ac-74c3c533217c"
+          "requestorId": "demo"
       },
       "modelInfo": {
           "modelType": "network",
@@ -429,6 +428,37 @@ generated by SDC when you defined your service model.
   }'
 
 
+It is then possible to get information about that network from AAI:
+replace {{virtual_link_UUID}} by the UUID of the virtual link
+
+
+::
+
+  curl -X GET \
+    https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/network/l3-networks/l3-network/{{virtual_link_UUID}} \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic QUFJOkFBSQ==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-FromAppId: AAI' \
+    -H 'X-TransactionId: get_aai_subscr' \
+    -H 'cache-control: no-cache'
+
+
+And also about subnet:
+
+::
+
+  curl -X GET \
+    https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/network/l3-networks/l3-network/{{virtual_link_UUID}}/subnets \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic QUFJOkFBSQ==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-FromAppId: AAI' \
+    -H 'X-TransactionId: get_aai_subscr' \
+    -H 'cache-control: no-cache'
+
+
+
 Requests to instantiate a Contrail Network object
 -------------------------------------------------
 

diff --git a/docs/guides/onap-user/instantiate/pre_instantiation/index.rst b/docs/guides/onap-user/instantiate/pre_instantiation/index.rst
index ca9af13..6a48702 100644 (file)
--- a/docs/guides/onap-user/instantiate/pre_instantiation/index.rst
+++ b/docs/guides/onap-user/instantiate/pre_instantiation/index.rst
@@ -38,7 +38,40 @@ Those informations will be available to all service instantiation
 (you only need to declare them once in ONAP)
 
 
-Example for "Owning Entity" named "Test"
+Example for "Owning Entity" named "OE-Generic"
+
+For Owning_Entity, it is important to declare the information in AAI
+with a UUID value for "owning-entity-id". That value will be necessary
+to instantiate a service with SO using GR_API.
+
+::
+
+  curl -X PUT \
+    https://aai.api.sparky.simpledemo.onap.org:30233/aai/v13/business/owning-entities/owning-entity/8874891f-5120-4b98-b452-46284513958d \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic QUFJOkFBSQ==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-FromAppId: AAI' \
+    -H 'X-TransactionId: get_aai_subscr' \
+    -H 'cache-control: no-cache' \
+    -d '{
+      "owning-entity-name": "OE-Generic",
+      "owning-entity-id": "8874891f-5120-4b98-b452-46284513958d"
+  }'
+
+::
+
+  curl -X GET \
+    https://aai.api.sparky.simpledemo.onap.org:30233/aai/v16/business/owning-entities \
+    -H 'Accept: application/json' \
+    -H 'Authorization: Basic QUFJOkFBSQ==' \
+    -H 'Content-Type: application/json' \
+    -H 'X-FromAppId: AAI' \
+    -H 'X-TransactionId: get_aai_subscr' \
+    -H 'cache-control: no-cache'
+
+
+To declare the Owning Entity in VID:
 
 ::
 
@@ -48,9 +81,10 @@ Example for "Owning Entity" named "Test"
     -H 'Content-Type: application/json' \
     -H 'cache-control: no-cache' \
     -d '{
-      "options": ["Test"]
+      "options": ["OE-Generic"]
   }'
 
+
 Example for "platform" named "Test_Platform"
 
 ::