diff options
Diffstat (limited to 'docs/guides/onap-user/instantiate/instantiation')
11 files changed, 0 insertions, 1110 deletions
diff --git a/docs/guides/onap-user/instantiate/instantiation/index.rst b/docs/guides/onap-user/instantiate/instantiation/index.rst deleted file mode 100644 index 9bfb6b6b3..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -Declare PNF instances: - -.. toctree:: - :maxdepth: 1 - - Declare PNF instances <./pnf_instance/index.rst> - -Instantiate a Service - -.. toctree:: - :maxdepth: 1 - - Instantiate a Service <./service_instance/index.rst> - -Instantiate a VNF: - -.. toctree:: - :maxdepth: 1 - - Instantiate a VNF <./vnf_instance/index.rst> - -Instantiate a Virtual Link: - -.. toctree:: - :maxdepth: 1 - - Instantiate a Virtual Link <./virtual_link_instance/index.rst> diff --git a/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst b/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst deleted file mode 100644 index 8c6e14d5d..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_ser_inst_nbi: - - -Service Instantiation via ONAP NBI API (TM Forum) -================================================= - -.. warning:: The ONAP :strong:`externalapi` project is :strong:`unmaintained`. - -ONAP NBI allow you to use a TM Forum standardized API (serviceOrder API). - -.. Additional info in: -.. -.. .. t o c t r e e : : -.. :maxdepth: 1 -.. :titlesonly: -.. -.. :ref:`NBI Guide<onap-externalapi-nbi:offeredapis>` - - -ONAP NBI will convert that request to ONAP SO request. - - -ServiceOrder management in NBI will support 2 modes: - -* E2E integration - NBI calls SO API to perform an End-To-end integration -* Service-level only integration - NBI will trigger only SO request at - serviceInstance level (not at VNF, not at Vf-module level and nothing will - be created on cloud platform) - -ONAP SO prerequisite: SO must be able to find a BPMN to process service -fulfillment (integrate VNF, VNF activation in SDNC, VF module) - -The choice of the mode is done by NBI depending on information retrieved -in SDC. If the serviceSpecification is within a Category "E2E Service" , -NBI will use E2E SO API, if not only API at service instance level -will be used. - -There is no difference or specific expectation in the service order API -used by NBI user. - - -Example of serviceOrder to instantiate (=add) a service based on model -with id=0d463b0c-e559-4def-8d7b-df64cfbd3159 - - -:: - - curl -X POST \ - http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/serviceOrder \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' \ - -d '{ - "externalId": "BSS_order_001", - "priority": "1", - "description": "this is a service order to instantiate a service", - "category": "Consumer", - "requestedStartDate": "", - "requestedCompletionDate": "", - "relatedParty": [ - { - "id": "JohnDoe", - "role": "ONAPcustomer", - "name": "JohnDoe" - } - ], - "orderItem": [ - { - "id": "1", - "action": "add", - "service": { - "name": "my_service_model_instance_01", - "serviceState": "active", - "serviceSpecification": { - "id": "0d463b0c-e559-4def-8d7b-df64cfbd3159" - } - } - } - ] - }' - -In the response, you will obtain the serviceOrderId value. - -Then you have the possibility to check about the serviceorder -(here after the serviceOrderId=5d06309da0e46400017b1123). - -This will allow you to get the serviceOrder Status (completed, failed...) - -:: - - curl -X GET \ - http://nbi.api.simpledemo.onap.org:30274/nbi/api/v4/serviceOrder/5d06309da0e46400017b1123 \ - -H 'Accept: application/json' \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' diff --git a/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst deleted file mode 100644 index 765dd1f79..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - - -Declare PNF instances -===================== - -PNF instances can be declared in ONAP inventory (AAI) using REST API - - -An example: - -:: - - curl -X PUT \ - https://{{ONAP_LB_IP@}}:30233/aai/v16/network/pnfs/pnf/my_pnf_instance_001 \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Cache-Control: no-cache' \ - -H 'Content-Type: application/json' \ - -H 'Postman-Token: f5e2aae0-dc1c-4edb-b9e9-a93b05aee5e8' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 999' \ - -H 'depth: all' \ - -d '{ - "pnf-name":" my_pnf_instance_001", - "equip-type":" router", - "nf-role":"primary", - "p-interfaces": { - "p-interface": [ - { - "interface-name": "ae1", - "port-description": "Link aggregate for trunk between switches" - }, - { - "interface-name": "xe-0/0/6", - "port-description": "to PNF_instance_002 trunk1" - }, - { - "interface-name": "xe-0/0/2", - "port-description": "to PNF_instance_003 trunk1" - }, - { - "interface-name": "xe-0/0/10", - "port-description": "to PNF_instance_004 trunk1" - }, - { - "interface-name": "xe-0/0/0", - "port-description": "firewall trunk" - }, - { - "interface-name": "xe-0/0/14", - "port-description": "to PNF_instance_005 trunk1" - } - ] - } - }' -k - - -It is possible to declare the location where is deployed the PNF -(called a "complex" in ONAP AAI) - -:: - - curl -X PUT \ - https:// {{ONAP_LB_IP@}}:30233/aai/v11/cloud-infrastructure/complexes/complex/my_complex_name \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Cache-Control: no-cache' \ - -H 'Content-Type: application/json' \ - -H 'Postman-Token: 43523984-db01-449a-8a58-8888871110bc' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 999' \ - -H 'depth: all' \ - -d '{ - "physical-location-type":"PoP", - "physical-location-id":"my_complex_name", - "complex-name":"Name of my Complex", - "city":"LANNION", - "postal-code":"22300", - "country":"FRANCE", - "street1":"Avenue Pierre Marzin", - "region":"Europe" - }' -k - - - -To indicate that a PNF instance is located in a complex, we create a relation - -:: - - curl -X PUT \ - https:// {{ONAP_LB_IP@}}:30233/aai/v14/network/pnfs/pnf/my_pnf_instance_001/relationship-list/relationship \ - -H 'Accept: application/json' \ - -H 'Authorization: Basic QUFJOkFBSQ==' \ - -H 'Cache-Control: no-cache' \ - -H 'Content-Type: application/json' \ - -H 'Postman-Token: 15315304-17c5-4e64-aada-bb149f1af915' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: 999' \ - -H 'depth: all' \ - -d '{ - "related-to": "complex", - "related-link": "/aai/v11/cloud-infrastructure/complexes/complex/my_complex_name" - }' -k diff --git a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst deleted file mode 100644 index 4e8dcab86..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -Service Instantiation -===================== - -**Pre-requisites** - -- The Service has been designed and distributed (see: :ref:`Service Design <doc_guide_user_des_ser-des>`) -- pre-instantiation operations have been performed - (see: :ref:`pre instantiation section <doc_guide_user_pre_ser-inst>`) - -**Possible Tools to perform Service Instantiation** - -- **via a Graphical User Interface tool** - using ONAP applications such as **ONAP VID** and **ONAP UUI** tools - -- **via any tool able to perform REST API requests** - (for example : Robot Framework, Postman, Curl...) connected - to **ONAP SO** legacy API or **ONAP extAPI/NBI** standard TMF641 API - to add/delete Service. - -**Possible methods with ONAP to instantiate a Service** - -- **A La Carte** - method requires the user to build and send - operations **for each object** to instantiate : Service, VNFs, - VFModules and Networks (in other words : once you have instantiated - the Service object, you still have to instantiate the various VNFs - or Networks that compose your Service). - To build those requests, the user needs to define/collect by himself - all necessary parameters/values. - -- **Macro** - method allows the user to build and send - **only one request to instantiate all objects** : Service, VNFs, - VFModules and Networks. Thanks to templates (see CDS Blueprint in - Design section), - ONAP will collect and assign all required parameters/values by itself. - - -.. Note:: - VID supports the "macro" flow orchestration in a ModernUI, which can be enabled by the system operator. - - **Macro** method is not (yet) available via extAPI/NBI. - -With "A La Carte" method ------------------------- - -.. toctree:: - :maxdepth: 1 - - using ONAP VID Portal <../vid1/index.rst> - using ONAP NBI REST API (TM Forum) <../nbi/index.rst> - using ONAP SO REST API <../so1/index.rst> - -With "Macro" method -------------------- - -.. toctree:: - :maxdepth: 1 - - using ONAP VID Portal <../vid2/index.rst> - using ONAP SO REST API <../so2/index.rst> diff --git a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst b/docs/guides/onap-user/instantiate/instantiation/so1/index.rst deleted file mode 100644 index af2edc8c9..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst +++ /dev/null @@ -1,465 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_ser_inst_so1: - - -A La Carte mode Service Instantiation via ONAP SO API -===================================================== - -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. - -ONAP will instantiate resources on Cloud platforms only when user is requesting -to instantiate VF-module or Network (openstack neutron or contrail). - -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 - -:: - - curl -X POST \ - 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-ONAP-PartnerName: NBI' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "requestInfo": { - "instanceName": "integration_test_service_instance_001", - "source": "VID", - "suppressRollback": false, - "requestorId": "demo" - }, - "modelInfo": { - "modelType": "service", - "modelInvariantId": "48d7ceec-7975-406c-8b96-cb3fbdbcfa33", - "modelVersionId": "33a99ef7-b5a3-4603-b21e-790582b4567e", - "modelName": "integration_test_service_ubuntu16", - "modelVersion": "1.0" - }, - "cloudConfiguration": { - "tenantId": "dd8fce79e74a4989a6be6b6c5e55acef", - "cloudOwner": "cloudOwner", - "lcpCloudRegionId": "RegionOne" - }, - "requestParameters": { - "userParams": [], - "testApi": "VNF_API", - "subscriptionServiceType": "integration_test_service_ubuntu16", - "aLaCarte": true - }, - "subscriberInfo": { - "globalSubscriberId": "integration_test_customer" - }, - "project": { - "projectName": "integration_test_project" - }, - "owningEntity": { - "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 -(here after the requestId=e3ad8df6-ea0d-4384-be95-bcb7dd39bbde). - -This will allow you to get the serviceOrder Status (completed, failed...) - -:: - - curl -X GET \ - http://so.api.simpledemo.onap.org:30277/onap/so/infra/orchestrationRequests/v6/e3ad8df6-ea0d-4384-be95-bcb7dd39bbde \ - -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' - - -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. - -:: - - curl -X POST \ - 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 ----------------------------------------- - -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. - -1st request is called a "SDNC-preload" for a VNF object and is used -to store in SDNC some VNF parameters values -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": "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 -(instance name must be identical in both requests) - -:: - - curl -X POST \ - 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" - }, - "requestParameters": { - "userParams": [], - "testApi": "VNF_API", - "usePreload": true - }, - "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": "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" - } - } - }] - } - }' - - - -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 neutron network object: - -:: - - curl -X POST \ - http://sdnc.api.simpledemo.onap.org:30202/restconf/operations/VNF-API:preload-network-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": { - "request-id": "postman001", - "notification-url": "http://so.onap.org", - "order-number": "postman001", - "request-sub-action": "SUPP", - "request-action": "PreloadNetworkRequest", - "source": "postman", - "order-version": "1.0" - }, - "network-topology-information": { - "network-policy": [], - "route-table-reference": [], - "vpn-bindings": [], - "network-topology-identifier": { - "network-role": "integration_test_net", - "network-technology": "neutron", - "service-type": "my-service-2", - "network-name": "my_network_01", - "network-type": "Generic NeutronNet" - }, - "provider-network-information": { - "is-external-network": "false", - "is-provider-network": "false", - "is-shared-network": "false" - }, - "subnets": [ - { - "subnet-name": "my_subnet_01", - "subnet-role": "OAM", - "start-address": "192.168.90.0", - "cidr-mask": "24", - "ip-version": "4", - "dhcp-enabled": "Y", - "dhcp-start-address": "", - "dhcp-end-address": "", - "gateway-address": "192.168.90.1", - "host-routes":[] - } - ] - }, - "sdnc-request-header": { - "svc-action": "reserve", - "svc-notification-url": "http://so.onap.org", - "svc-request-id": "postman001" - } - } - }' - - -2nd request is to instantiate the neutron network via ONAP SO -(instance name must be identical in both requests) - - -:: - - curl -X POST \ - 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' \ - -H 'X-FromAppId: AAI' \ - -H 'X-TransactionId: get_aai_subscr' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "requestInfo": { - "instanceName": "my_network_01", - "source": "VID", - "suppressRollback": false, - "requestorId": "demo" - }, - "modelInfo": { - "modelType": "network", - "modelInvariantId": "0070b65c-48cb-4985-b4df-7c67ca99cd95", - "modelVersionId": "4f738bed-e804-4765-8d22-07bb4d11f14b", - "modelName": "Generic NeutronNet", - "modelVersion": "1.0", - "modelCustomizationId": "95534a95-dc8d-4ffb-89c7-091e2c49b55d", - "modelCustomizationName": "Generic NeutronNet 0" - }, - "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_name", - "modelInvariantId": "11265d8c-2cc2-40e5-95d8-57cad81c18da", - "modelVersion": "1.0", - "modelVersionId": "0d463b0c-e559-4def-8d7b-df64cfbd3159" - } - } - }] - } - }' - - -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 -------------------------------------------------- - -TO BE COMPLETED diff --git a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst b/docs/guides/onap-user/instantiate/instantiation/so2/index.rst deleted file mode 100644 index 9b1bbb351..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst +++ /dev/null @@ -1,193 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - -.. _doc_guide_user_ser_inst_so2: - - -Macro mode Service Instantiation via ONAP SO API -================================================ - -Using Macro mode, you have to build and send one and only one -request to ONAP SO. - -In that request you need to indicate all object instances -that you want to be instantiated. - -Reminder : ONAP SO in Macro mode will perform the VNF parameters/values -assignment based on CDS Blueprint templates -that are supposed to be defined during Design and Onboard steps. -That means ONAP should have all information -to be able to get all necessary values by itself (there is no longer need -for a user to provide those values via the "SDNC preload" operation). - -Additional info in: - -* CDS Documentation: :ref:`cds_main-doc` -* CDS vDNS Usecase Description in `Wiki <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin>`_ - -Request Example : - -:: - - curl -X POST \ - 'http://{{k8s}}:30277/onap/so/infra/serviceInstantiation/v7/serviceInstances' \ - -H 'Content-Type: application/json' \ - -H 'cache-control: no-cache' \ - -d '{ - "requestDetails": { - "subscriberInfo": { - "globalSubscriberId": "Demonstration" - }, - "requestInfo": { - "suppressRollback": false, - "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb", - "requestorId": "adt", - "instanceName": "{{cds-instance-name}}", - "source": "VID" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "fr1", - "tenantId": "6270eaa820934710960682c506115453" - }, - "requestParameters": { - "subscriptionServiceType": "vFW", - "userParams": [ - { - "Homing_Solution": "none" - }, - { - "service": { - "instanceParams": [ - - ], - "instanceName": "{{cds-instance-name}}", - "resources": { - "vnfs": [ - { - "modelInfo": { - "modelName": "{{vnf-modelinfo-modelname}}", - "modelVersionId": "{{vnf-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-modelinfo-modelinvariantuuid}}", - "modelVersion": "1.0", - "modelCustomizationId": "{{vnf-modelinfo-modelcustomizationuuid}}", - "modelInstanceName": "{{vnf-modelinfo-modelinstancename}}" - }, - "cloudConfiguration": { - "lcpCloudRegionId": "fr1", - "tenantId": "6270eaa820934710960682c506115453" - }, - "platform": { - "platformName": "test" - }, - "lineOfBusiness": { - "lineOfBusinessName": "someValue" - }, - "productFamilyId": "a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb", - "instanceName": "{{vnf-modelinfo-modelinstancename}}", - "instanceParams": [ - { - "onap_private_net_id": "olc-private", - "onap_private_subnet_id": "olc-private", - "pub_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCwj7uJMyKiP1ogEsZv5kKDFw9mFNhxI+woR3Tuv8vjfNnqdB1GfSnvTFyNbdpyNdR8BlljkiZ1SlwJLEkvPk0HpOoSVVek/QmBeGC7mxyRcpMB2cNQwjXGfsVrforddXOnOkj+zx1aNdVGMc52Js3pex8B/L00H68kOcwP26BI1o77Uh+AxjOkIEGs+wlWNUmXabLDCH8l8IJk9mCTruKEN9KNj4NRZcaNC+XOz42SyHV9RT3N6efp31FqKzo8Ko63QirvKEEBSOAf9VlJ7mFMrGIGH37AP3JJfFYEHDdOA3N64ZpJLa39y25EWwGZNlWpO/GW5bNjTME04dl4eRyd", - "image_name": "Ubuntu 14.04", - "flavor_name":"s1.cw.small-1" - } - ], - "vfModules": [ - { - "modelInfo": { - "modelName": "{{vnf-vfmodule-0-modelinfo-modelname}}", - "modelVersionId": "{{vnf-vfmodule-0-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-vfmodule-0-modelinfo-modelinvariantuuid}}", - "modelVersion": "1", - "modelCustomizationId": "{{vnf-vfmodule-0-modelinfo-modelcustomizationuuid}}" - }, - "instanceName": "{{vnf-vfmodule-0-modelinfo-modelname}}", - "instanceParams": [ - { - "sec_group": "olc-open", - "public_net_id": "olc-net" - } - ] - }, - { - "modelInfo": { - "modelName": "{{vnf-vfmodule-1-modelinfo-modelname}}", - "modelVersionId": "{{vnf-vfmodule-1-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-vfmodule-1-modelinfo-modelinvariantuuid}}", - "modelVersion": "1", - "modelCustomizationId": "{{vnf-vfmodule-1-modelinfo-modelcustomizationuuid}}" - }, - "instanceName": "{{vnf-vfmodule-1-modelinfo-modelname}}", - "instanceParams": [ - { - "sec_group": "olc-open", - "public_net_id": "olc-net" - } - ] - }, - { - "modelInfo": { - "modelName": "{{vnf-vfmodule-2-modelinfo-modelname}}", - "modelVersionId": "{{vnf-vfmodule-2-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-vfmodule-2-modelinfo-modelinvariantuuid}}", - "modelVersion": "1", - "modelCustomizationId": "{{vnf-vfmodule-2-modelinfo-modelcustomizationuuid}}" - }, - "instanceName": "{{vnf-vfmodule-2-modelinfo-modelname}}", - "instanceParams": [ - { - "sec_group": "olc-open", - "public_net_id": "olc-net" - } - ] - }, - { - "modelInfo": { - "modelName": "{{vnf-vfmodule-3-modelinfo-modelname}}", - "modelVersionId": "{{vnf-vfmodule-3-modelinfo-modeluuid}}", - "modelInvariantUuid": "{{vnf-vfmodule-3-modelinfo-modelinvariantuuid}}", - "modelVersion": "1", - "modelCustomizationId": "{{vnf-vfmodule-3-modelinfo-modelcustomizationuuid}}" - }, - "instanceName": "{{vnf-vfmodule-3-modelinfo-modelname}}", - "instanceParams": [ - { - "sec_group": "olc-open", - "public_net_id": "olc-net" - } - ] - } - ] - } - ] - }, - "modelInfo": { - "modelVersion": "1.0", - "modelVersionId": "{{service-uuid}}", - "modelInvariantId": "{{service-invariantUUID}}", - "modelName": "{{service-name}}", - "modelType": "service" - } - } - } - ], - "aLaCarte": false - }, - "project": { - "projectName": "Project-Demonstration" - }, - "owningEntity": { - "owningEntityId": "24ef5425-bec4-4fa3-ab03-c0ecf4eaac96", - "owningEntityName": "OE-Demonstration" - }, - "modelInfo": { - "modelVersion": "1.0", - "modelVersionId": "{{service-uuid}}", - "modelInvariantId": "{{service-invariantUUID}}", - "modelName": "{{service-name}}", - "modelType": "service" - } - } - }' diff --git a/docs/guides/onap-user/instantiate/instantiation/uui/index.rst b/docs/guides/onap-user/instantiate/instantiation/uui/index.rst deleted file mode 100644 index 70d825e70..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/uui/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -e2eServiceInstance mode via ONAP UUI Portal -=========================================== - - -.. toctree:: - :maxdepth: 1 - :titlesonly: - -:ref:`usecase-ui docs platform installation user-guide<onap-usecase-ui:master_index>` diff --git a/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst deleted file mode 100644 index e3e4c5737..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -A La Carte mode Service Instantiation via ONAP VID Portal -========================================================= - -.. warning:: The ONAP :strong:`vid` project is :strong:`unmaintained`. diff --git a/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst deleted file mode 100644 index 2a1dbee4c..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -Macro mode Service Instantiation via ONAP VID Portal -==================================================== - -.. warning:: The ONAP :strong:`vid` project is :strong:`unmaintained`. diff --git a/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst deleted file mode 100644 index e12932a5d..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -Network Instantiation -===================== - -Note: in ONAP SDC, network object is called "virtual link" - -**Various possible methods are available with ONAP to instantiate a network** - -- With **A La Carte** - method, the user needs to build and send a Network instantiation - request. - - Note 1: prior to be able to send a request to instantiate - a Network, the user needs to instantiate a Service Object and then will - need to refer to that Service instance in the Network instantiate request. - - Note 2: the request to instantiate the Network object will update - ONAP AAI (inventory) and will send a request to the selected Cloud Platform - (Openstack, Azure, K8S...). - -- With **Macro** - method, the user do not need to send any - Network instantiation request. Network instantiation is being automatically - performed by ONAP when sending the request to instantiate the Service - (see: Instantiate Service). - -**Possible Tools to perform Network Instantiation** - -the user needs such a tool only if using the "A La Carte" method. - -- **via ONAP VID Graphical User Interface tool** - -- **via any tool able to perform REST API requests** - (for example : Robot Framework, Postman, Curl...) connected - to **ONAP SO** legacy API. - -With "A La Carte" method ------------------------- - -.. toctree:: - :maxdepth: 1 - - using ONAP VID Portal <../vid1/index.rst> - using ONAP SO REST API <../so1/index.rst> - -With "Macro" method ------------------------- - -Network instantiation is performed automatically when performing -Service Instantiation. diff --git a/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst deleted file mode 100644 index ccf036c2f..000000000 --- a/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2019 ONAP Contributors. All rights reserved. - - -VNF Instantiation -================= - -**Pre-requisites** - -- The VNF is part of a Service Model (see: :ref:`Service Design <doc_guide_user_des_ser-des>`) - - .. Note:: In ONAP SDC tool, VNF is named "VF" - - -**Possible methods with ONAP to instantiate a VNF** - -- With **A La Carte** - method, the user needs to build and send a VNF instantiation - request. - - Note 1: prior to be able to send a request to instantiate - a VNF, the user needs to instantiate a Service Object and then will - need to refer to that Service instance in the VNF instantiate request. - - Note 2: after having instantiated the VNF object, the user needs to - instantiate a VF-module object, refering to the previously instantiated - VNF object. - - Note 3: the request to instantiate the VF-module object will, at last, send - a request to the selected Cloud Platform (Openstack, Azure, K8S...). - -- With **Macro** - method, the user do not need to send any - VNF instantiation request. VNF instantiation is being automatically - performed by ONAP when sending the request to instantiate the Service - (see: Instantiate Service). - - -**Possible Tools to perform VNF Instantiation** - -the user needs such a tool only if using the "A La Carte" method. - -- **via ONAP VID Graphical User Interface tool** - -- **via any tool able to perform REST API requests** - (for example : Robot Framework, Postman, Curl...) connected - to **ONAP SO** legacy API. - -With "A La Carte" method ------------------------- - -.. toctree:: - :maxdepth: 1 - - using ONAP VID Portal <../vid1/index.rst> - using ONAP SO REST API <../so1/index.rst> - -With "Macro" method ------------------------- - -VNF and VF-Module instantiation are performed automatically when performing -Service Instantiation. |