summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2019-07-16 20:49:19 +0000
committerGerrit Code Review <gerrit@onap.org>2019-07-16 20:49:19 +0000
commit507ba131f9dc36c39fa7a4f458e9738c2e8340ef (patch)
tree79e2ccd84c7fa0018d192504671e49d66c1942cc /docs
parentb531ff04251263107886e23ef6235c8a6935b206 (diff)
parent7789a22fff5a82688c96813bbcd0238bcd141f52 (diff)
Merge "Updated late coming comments to Patch 91089 and added links"
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-user/instantiate/index.rst8
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/index.rst6
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/nbi/index.rst19
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/so1/index.rst20
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/so2/index.rst12
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/uui/index.rst2
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/vid/index.rst8
7 files changed, 47 insertions, 28 deletions
diff --git a/docs/guides/onap-user/instantiate/index.rst b/docs/guides/onap-user/instantiate/index.rst
index 03d90a580..21177b59a 100644
--- a/docs/guides/onap-user/instantiate/index.rst
+++ b/docs/guides/onap-user/instantiate/index.rst
@@ -22,10 +22,10 @@ Instantiation includes the following topics:
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.
-**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.
diff --git a/docs/guides/onap-user/instantiate/instantiation/index.rst b/docs/guides/onap-user/instantiate/instantiation/index.rst
index dcbe153da..455bdf070 100644
--- a/docs/guides/onap-user/instantiate/instantiation/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/index.rst
@@ -21,8 +21,8 @@ Instantiate a Service:
.. 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>
diff --git a/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst b/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst
index 696232517..96bbc3a8d 100644
--- a/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/nbi/index.rst
@@ -2,14 +2,23 @@
.. 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)
+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.
@@ -21,10 +30,10 @@ ServiceOrder management in NBI will support 2 modes:
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
-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.
diff --git a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst b/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
index 860f50295..86f03bdd3 100644
--- a/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/so1/index.rst
@@ -2,13 +2,13 @@
.. 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,
@@ -121,7 +121,7 @@ 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 used when instantiating
+that will be needed for the instantiation
::
@@ -165,13 +165,13 @@ that will be used when instantiating
}
}'
-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 \
- 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' \
@@ -309,7 +309,7 @@ generated by SDC when you defined your service model.
::
-curl -X POST \
+ curl -X POST \
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==' \
@@ -362,5 +362,5 @@ curl -X POST \
}
}
}]
- }
-}'
+ }
+ }'
diff --git a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst b/docs/guides/onap-user/instantiate/instantiation/so2/index.rst
index 314fef10f..02a5f70d3 100644
--- a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/so2/index.rst
@@ -2,7 +2,7 @@
.. 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
@@ -20,6 +20,16 @@ That means ONAP has all information
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>
+
+
Request Example :
::
diff --git a/docs/guides/onap-user/instantiate/instantiation/uui/index.rst b/docs/guides/onap-user/instantiate/instantiation/uui/index.rst
index dd57c0891..fa57be271 100644
--- a/docs/guides/onap-user/instantiate/instantiation/uui/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/uui/index.rst
@@ -11,4 +11,4 @@ e2eServiceInstance mode via ONAP UUI Portal
: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
diff --git a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid/index.rst
index 78b4e4c03..307ceb981 100644
--- a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/vid/index.rst
@@ -3,11 +3,11 @@
.. 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
+=========================================================
-. toctree::
+.. toctree::
:maxdepth: 1
:titlesonly:
- ../../../../submodules/vid.git/docs/humaninterfaces.rst
+ ../../../../../submodules/vid.git/docs/humaninterfaces.rst