Issue-ID: DOC-500
Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: Ia97f22b9b6cfe77be18b5252789e429af02e8f79
service BPMN workflow. That means it is linked to ONAP source code
and lifecycle.
service BPMN workflow. That means it is linked to ONAP source code
and lifecycle.
-**Alacarte** method required the Operator actor to build and send
+**A La Carte** method requires the Operations actor to build and send
a lot of operations. To build those requests, Operator actor needs to
define/collect by himself all VNF parameters/values.
a lot of operations. To build those requests, Operator actor needs to
define/collect by himself all VNF parameters/values.
-**Macro** method required the Operator actor to build and send only one request and,
-thanks to CDS Blueprint templates, ONAP will collect and assign
-by itself all paramters/values.
+**Macro** method required the Operations actor to build and send only one
+request and, thanks to CDS Blueprint templates, ONAP will collect and assign
+all required parameters/values by itself.
.. toctree::
:maxdepth: 2
.. toctree::
:maxdepth: 2
- using ONAP VID Portal with "A La Carte" method<./vid/index.rst>
- using ONAP UUI Portal with "e2eServiceInstance" method<./uui/index.rst>
- using ONAP NBI REST API (TM Forum) with "A La Carte" method <./nbi/index.rst>
+ using ONAP VID Portal with "A La Carte" method <./vid/index.rst>
+ using ONAP UUI Portal with "e2eServiceInstance" method <./uui/index.rst>
+ using ONAP NBI REST API (TM Forum) <./nbi/index.rst>
using ONAP SO REST API with "A La Carte" method <./so1/index.rst>
using ONAP SO REST API with "Macro" mode method <./so2/index.rst>
using ONAP SO REST API with "A La Carte" method <./so1/index.rst>
using ONAP SO REST API with "Macro" mode method <./so2/index.rst>
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2019 ONAP Contributors. All rights reserved.
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2019 ONAP Contributors. All rights reserved.
-.. _doc_guide_user_ser_inst:
+.. _doc_guide_user_ser_inst_nbi:
-Alacarte mode Service Instantiation via ONAP NBI API (TM Forum)
-===============================================================
+Service Instantiation via ONAP NBI API (TM Forum)
+=================================================
ONAP NBI allow you to use a TM Forum standardized API (serviceOrder API)
ONAP NBI allow you to use a TM Forum standardized API (serviceOrder API)
+Additional info in:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ NBI Guide <../../../../../submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.rst>
+
+
ONAP NBI will convert that request to ONAP SO request.
ONAP NBI will convert that request to ONAP SO request.
be created on cloud platform)
ONAP SO prerequisite: SO must be able to find a BPMN to process service
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
+fulfillment (integrate VNF, VNF activation in SDNC, VF module)
The choice of the mode is done by NBI depending on information retrieved
The choice of the mode is done by NBI depending on information retrieved
-in SDC. If the serviceSpecification is within a Category “E2E Service” ,
+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.
NBI will use E2E SO API, if not only API at service instance level
will be used.
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2019 ONAP Contributors. All rights reserved.
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2019 ONAP Contributors. All rights reserved.
-.. _doc_guide_user_ser_inst:
+.. _doc_guide_user_ser_inst_so1:
-AlaCarte mode Service Instantiation via ONAP SO API
-===================================================
+A La Carte mode Service Instantiation via ONAP SO API
+=====================================================
-Using ONAP SO API in "Alacarte" mode, you need to send several requests,
+Using ONAP SO API in "A La Carte" mode, you need to send several requests,
depending on the service model composition.
For example, if your service model is composed of 2 VNF and a Network,
depending on the service model composition.
For example, if your service model is composed of 2 VNF and a Network,
1st request is called a "SDNC-preload" for a VNF object and is used
to store in SDNC some VNF parameters values
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 used when instantiating
+that will be needed for the instantiation
-The 2nd request id to instantiate the VF module via ONAP SO
+The 2nd request is to instantiate the VF module via ONAP SO
(instance name must be identical in both requests)
::
curl -X POST \
(instance name must be identical in both requests)
::
curl -X POST \
- http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstances/v6/95762b50-0244-4723-8fde-35f911db9263/vnfs//vfModules \
+ 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 'Accept: application/json' \
-H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
-H 'Content-Type: application/json' \
http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstances/v6/95762b50-0244-4723-8fde-35f911db9263/networks \
-H 'Accept: application/json' \
-H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
http://so.api.simpledemo.onap.org:30277/onap/so/infra/serviceInstances/v6/95762b50-0244-4723-8fde-35f911db9263/networks \
-H 'Accept: application/json' \
-H 'Authorization: Basic SW5mcmFQb3J0YWxDbGllbnQ6cGFzc3dvcmQxJA==' \
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2019 ONAP Contributors. All rights reserved.
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2019 ONAP Contributors. All rights reserved.
-.. _doc_guide_user_ser_inst:
+.. _doc_guide_user_ser_inst_so2:
Macro mode Service Instantiation via ONAP SO API
Macro mode Service Instantiation via ONAP SO API
to be able to get all necessary values by itself (there is no longer need
for an Operator to provide "SDNC preload").
to be able to get all necessary values by itself (there is no longer need
for an Operator to provide "SDNC preload").
+Additional info in:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ CDS Documentation <../../../../../submodules/ccsdk/cds.git/docs/index.rst>
+ CDS vDNS E2E Automation <https://wiki.onap.org/display/DW/vDNS+CDS+Dublin>
+
+
:maxdepth: 1
:titlesonly:
:maxdepth: 1
:titlesonly:
- ../../../../submodules/usecase-ui.git/docs/platform/installation/user-guide/index.rst
+ ../../../../../submodules/usecase-ui.git/docs/platform/installation/user-guide/index.rst
.. Copyright 2019 ONAP Contributors. All rights reserved.
.. Copyright 2019 ONAP Contributors. All rights reserved.
-Alacarte mode Service Instantiation via ONAP VID Portal
-=======================================================
+A La Carte mode Service Instantiation via ONAP VID Portal
+=========================================================
:maxdepth: 1
:titlesonly:
:maxdepth: 1
:titlesonly:
- ../../../../submodules/vid.git/docs/humaninterfaces.rst
+ ../../../../../submodules/vid.git/docs/humaninterfaces.rst