summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-developer/apiref/index.rst10
-rw-r--r--docs/guides/onap-user/configure/change_config/index.rst11
-rw-r--r--docs/guides/onap-user/configure/index.rst18
-rw-r--r--docs/guides/onap-user/configure/pnf_connect/index.rst18
-rw-r--r--docs/guides/onap-user/configure/vnf_connect/index.rst17
-rw-r--r--docs/guides/onap-user/design/index.rst4
-rw-r--r--docs/guides/onap-user/index.rst2
-rw-r--r--docs/guides/onap-user/instantiate/index.rst19
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/index.rst39
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst4
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst63
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/so1/index.rst105
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/so2/index.rst7
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst54
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst63
m---------docs/submodules/aaf/authz.git0
m---------docs/submodules/aai/aai-common.git0
m---------docs/submodules/appc.git0
m---------docs/submodules/appc/deployment.git0
m---------docs/submodules/ccsdk/apps.git0
m---------docs/submodules/ccsdk/cds.git0
m---------docs/submodules/ccsdk/dashboard.git0
m---------docs/submodules/ccsdk/distribution.git0
m---------docs/submodules/ccsdk/features.git0
m---------docs/submodules/ccsdk/parent.git0
m---------docs/submodules/ccsdk/platform/blueprints.git0
m---------docs/submodules/ccsdk/platform/nbapi.git0
m---------docs/submodules/ccsdk/storage/esaas.git0
m---------docs/submodules/ccsdk/storage/pgaas.git0
m---------docs/submodules/clamp.git0
m---------docs/submodules/cli.git0
m---------docs/submodules/dmaap/datarouter.git0
m---------docs/submodules/dmaap/messagerouter/messageservice.git0
m---------docs/submodules/externalapi/nbi.git0
m---------docs/submodules/integration.git0
m---------docs/submodules/logging-analytics.git0
m---------docs/submodules/logging-analytics/pomba/pomba-audit-common.git0
m---------docs/submodules/modeling/modelspec.git0
m---------docs/submodules/multicloud/azure.git0
m---------docs/submodules/multicloud/framework.git0
m---------docs/submodules/multicloud/k8s.git0
m---------docs/submodules/oom.git0
m---------docs/submodules/optf/has.git0
m---------docs/submodules/optf/osdf.git0
m---------docs/submodules/osa.git0
m---------docs/submodules/policy/engine.git0
m---------docs/submodules/policy/parent.git0
m---------docs/submodules/portal.git0
m---------docs/submodules/sdc.git0
m---------docs/submodules/sdc/jtosca.git0
m---------docs/submodules/sdc/sdc-tosca.git0
m---------docs/submodules/sdc/sdc-workflow-designer.git0
m---------docs/submodules/sdnc/oam.git0
m---------docs/submodules/so.git0
m---------docs/submodules/ui/dmaapbc.git0
m---------docs/submodules/usecase-ui.git0
m---------docs/submodules/vfc/nfvo/lcm.git0
m---------docs/submodules/vid.git0
m---------docs/submodules/vid/asdcclient.git0
m---------docs/submodules/vnfrqts/requirements.git0
m---------docs/submodules/vnfsdk/model.git0
61 files changed, 380 insertions, 54 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index 4c0140529..c79d38bab 100644
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -69,3 +69,13 @@ SDK
:titlesonly:
VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.rst>
+
+
+Some ONAP Postman collections
+-----------------------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ Some ONAP Postman collections <../../../submodules/integration.git/docs/docs_postman.rst>
diff --git a/docs/guides/onap-user/configure/change_config/index.rst b/docs/guides/onap-user/configure/change_config/index.rst
new file mode 100644
index 000000000..b03d30f02
--- /dev/null
+++ b/docs/guides/onap-user/configure/change_config/index.rst
@@ -0,0 +1,11 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+
+
+Change Configure
+================
+The following guides are provided to describe tasks that a user of
+ONAP may need to perform to change a VNF configuration.
+
+TO BE COMPLETED \ No newline at end of file
diff --git a/docs/guides/onap-user/configure/index.rst b/docs/guides/onap-user/configure/index.rst
new file mode 100644
index 000000000..d44da30f8
--- /dev/null
+++ b/docs/guides/onap-user/configure/index.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+
+
+Configure Service, VNF, PNF
+===========================
+The following guides are provided to describe tasks that a user of
+ONAP may need to perform to configure a PNF or a VNF.
+
+Configuration includes the following topics:
+
+.. toctree::
+ :maxdepth: 1
+
+ Connect PNF to ONAP <./pnf_connect/index.rst>
+ Connect VNF to ONAP <./vnf_connect/index.rst>
+ Change PNF/VNF configuration <./change_config/index.rst>
diff --git a/docs/guides/onap-user/configure/pnf_connect/index.rst b/docs/guides/onap-user/configure/pnf_connect/index.rst
new file mode 100644
index 000000000..311bf911e
--- /dev/null
+++ b/docs/guides/onap-user/configure/pnf_connect/index.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+
+
+ONAP and PNF connection configuration
+=====================================
+
+The following guides are provided to describe tasks that a user of
+ONAP may need to perform to allow a PNF to communicate with ONAP.
+
+Pre-requisites
+--------------
+- PNF provides the appropriate API to perform the espected operations
+- ONAP and PNF are interconnected via a network
+- any firewall between ONAP and PNF is correctly configured
+
+TO BE COMPLETED
diff --git a/docs/guides/onap-user/configure/vnf_connect/index.rst b/docs/guides/onap-user/configure/vnf_connect/index.rst
new file mode 100644
index 000000000..2e09b2aeb
--- /dev/null
+++ b/docs/guides/onap-user/configure/vnf_connect/index.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
+
+
+ONAP and VNF connection configuration
+=====================================
+The following guides are provided to describe tasks that a user of
+ONAP may need to perform to allow a VNF to communicate with ONAP
+
+Pre-requisites
+--------------
+- VNF provides the appropriate API to perform the espected operations
+- ONAP and VNF are interconnected via a network
+- any firewall between ONAP and VNF is correctly configured
+
+TO BE COMPLETED
diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst
index 615535850..a77984456 100644
--- a/docs/guides/onap-user/design/index.rst
+++ b/docs/guides/onap-user/design/index.rst
@@ -4,8 +4,8 @@
.. _doc_guide_user_des:
-Design
-======
+Design Service
+==============
The goal of the design process is to create all artifacts (models)
that are required to instantiate and manage resources, services,
diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst
index 79a3faadc..f25f3a7ba 100644
--- a/docs/guides/onap-user/index.rst
+++ b/docs/guides/onap-user/index.rst
@@ -18,5 +18,7 @@ an instance of ONAP.
cloud_site/index.rst
design/index.rst
instantiate/index.rst
+ configure/index.rst
onapcli.rst
Verified Use Cases <../../submodules/integration.git/docs/docs_usecases.rst>
+ Using ONAP Rest API with Postman <../../submodules/integration.git/docs/docs_postman.rst>
diff --git a/docs/guides/onap-user/instantiate/index.rst b/docs/guides/onap-user/instantiate/index.rst
index 21177b59a..fb14e698e 100644
--- a/docs/guides/onap-user/instantiate/index.rst
+++ b/docs/guides/onap-user/instantiate/index.rst
@@ -3,29 +3,16 @@
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-Instantiate
-===========
+Instantiate Service, PNF, VNF, Network
+======================================
The following guides are provided to describe tasks that a user of
ONAP may need to perform when instantiating a service.
Instantiation includes the following topics:
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
Pre-instantiation operations <./pre_instantiation/index.rst>
Instantiation operation(s) <./instantiation/index.rst>
-
-
-**e2eServiceInstance** method is a hard-coded approach with dedicated/specific
-service BPMN workflow. That means it is linked to ONAP source code
-and lifecycle.
-
-**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 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 455bdf070..0d2981b4d 100644
--- a/docs/guides/onap-user/instantiate/instantiation/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/index.rst
@@ -2,27 +2,40 @@
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2019 ONAP Contributors. All rights reserved.
-.. _doc_guide_user_ser_inst:
+Declare PNF instances:
-Service Instantiation methods
-=============================
+.. toctree::
+ :maxdepth: 1
+ Declare PNF instances <./pnf_instance/index.rst>
-Declare PNF instances:
+Instantiate a Service
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
+
+ Instantiate a Service <./service_instance/index.rst>
+
+
+Instantiate a VNF:
+
+.. toctree::
+ :maxdepth: 1
+
+ Instantiate a VNF <./vnf_instance/index.rst>
+
+Configure a VNF:
+
+.. toctree::
+ :maxdepth: 1
+
+ Configure a VNF <./vnf_configure/index.rst>
- Declare PNF instances <./pnf_instance/index.rst>
-Instantiate a Service:
+Instantiate a Virtual Link:
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- 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>
+ Instantiate a Virtual Link <./virtual_link_instance/index.rst>
diff --git a/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst
index 7fbfdbe79..765dd1f79 100644
--- a/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/pnf_instance/index.rst
@@ -4,8 +4,8 @@
-Declare PNF instances in ONAP
-=============================
+Declare PNF instances
+=====================
PNF instances can be declared in ONAP inventory (AAI) using REST API
diff --git a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst
new file mode 100644
index 000000000..b23a90f33
--- /dev/null
+++ b/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst
@@ -0,0 +1,63 @@
+.. 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: Service Design)
+- pre-instantiation operations have been performed
+ (see: pre instantiation section)
+
+**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: **Macro** method is not (yet) available via ONAP VID
+ nor via extAPI/NBI
+
+With "A La Carte" method
+------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ using ONAP VID Portal <../vid/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 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
index 86f03bdd3..c7bd27880 100644
--- 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
diff --git a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst b/docs/guides/onap-user/instantiate/instantiation/so2/index.rst
index 02a5f70d3..9e2f9f98f 100644
--- a/docs/guides/onap-user/instantiate/instantiation/so2/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/so2/index.rst
@@ -8,7 +8,8 @@
Macro mode Service Instantiation via ONAP SO API
================================================
-Using Macro mode, you have to build and send only one request to ONAP SO
+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.
@@ -16,9 +17,9 @@ 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 has all information
+That means ONAP should have all information
to be able to get all necessary values by itself (there is no longer need
-for an Operator to provide "SDNC preload").
+for a user to provide those values via the "SDNC preload" operation).
Additional info in:
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
new file mode 100644
index 000000000..0fb9f1147
--- /dev/null
+++ b/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst
@@ -0,0 +1,54 @@
+.. 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 <../vid/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
new file mode 100644
index 000000000..822118f00
--- /dev/null
+++ b/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst
@@ -0,0 +1,63 @@
+.. 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: Service Design)
+
+ 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 <../vid/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.
diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git
-Subproject aca17303a5c5df832b4c73acf8d818cd2c85bdd
+Subproject ca0be7643ac60cac5cc9e967a3c39a3bc9a2ccb
diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git
-Subproject c19785ed19245a586dc8f271713ae59248fd8f8
+Subproject fff2d1af7b401d6334c4b09868597dcc6c054e2
diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git
-Subproject aead9be9cd5aad06f30f15a8c99d68a7108971c
+Subproject 972397fd9860d9c19a5d2c66d082e431d827c7a
diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git
-Subproject 5300156eb4c8065f32800946f791e93bb1db0ef
+Subproject 9035495b03de1814d811f3a0c23959f55853616
diff --git a/docs/submodules/ccsdk/apps.git b/docs/submodules/ccsdk/apps.git
-Subproject f4df41d8ec1321d50b93368a407ad5c34688904
+Subproject 025c4a0d54daa3eb66886daec9495a8635ffbf4
diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git
-Subproject 8d3f825da365b672731e07c2b4560a67ec287a6
+Subproject d9034b6d720df4718b8d455949c17051ecae055
diff --git a/docs/submodules/ccsdk/dashboard.git b/docs/submodules/ccsdk/dashboard.git
-Subproject 1f6974b83c94c9760128ff7f02b713c0ec82787
+Subproject 70638d1eb225acbc61e00ddbf9356aef38e8f14
diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git
-Subproject a56617de3c395d12fb013de468d14f3a0d769c2
+Subproject 458a85ec8dab60092a91208030ef2b31b3e545d
diff --git a/docs/submodules/ccsdk/features.git b/docs/submodules/ccsdk/features.git
-Subproject d45b32fd84aed39798426423919115f8295813a
+Subproject ed0e6be174e1445b6c47a69dccf25a642f17bdd
diff --git a/docs/submodules/ccsdk/parent.git b/docs/submodules/ccsdk/parent.git
-Subproject 352397d2713999b0020d96eaab300b2efb7d518
+Subproject 0bbf3f4f7ee0ec5c0f09e6d07bc301622e51fc6
diff --git a/docs/submodules/ccsdk/platform/blueprints.git b/docs/submodules/ccsdk/platform/blueprints.git
deleted file mode 160000
-Subproject 0bb45f0d88abb94cadfcc462f31bc8c7453be20
diff --git a/docs/submodules/ccsdk/platform/nbapi.git b/docs/submodules/ccsdk/platform/nbapi.git
deleted file mode 160000
-Subproject 989fb459830c7a069433410870f8c1c6559b72e
diff --git a/docs/submodules/ccsdk/storage/esaas.git b/docs/submodules/ccsdk/storage/esaas.git
deleted file mode 160000
-Subproject 988a69e42e01727cd0aa9296457ea23693a2eb0
diff --git a/docs/submodules/ccsdk/storage/pgaas.git b/docs/submodules/ccsdk/storage/pgaas.git
deleted file mode 160000
-Subproject 3b99f1c33173e4c68bd59e5cc88e8239cdeab38
diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git
-Subproject 54fea7fe473270ba67e9053ef08a0be46c6416c
+Subproject 13e8958238c4e7e870c04cca5035ba6d41b3788
diff --git a/docs/submodules/cli.git b/docs/submodules/cli.git
-Subproject d53b78f51ed1a37f13163fe0ffd77ebd1c7f6f6
+Subproject f249983a7cca64628f24a73092e813d2b4c18af
diff --git a/docs/submodules/dmaap/datarouter.git b/docs/submodules/dmaap/datarouter.git
-Subproject a60d80ff7bfae8a152c950486d9a1877628e13a
+Subproject 632e4aaf606ca99ddc5a5cba11deb5e2ee2a90c
diff --git a/docs/submodules/dmaap/messagerouter/messageservice.git b/docs/submodules/dmaap/messagerouter/messageservice.git
-Subproject 67b3d8b885cbbf0826162480fda027c2f812135
+Subproject d0f5883e6b2a615f12a2abd88dbf674ae1a6983
diff --git a/docs/submodules/externalapi/nbi.git b/docs/submodules/externalapi/nbi.git
-Subproject 9856ecbcee2c3714d0038cbbd6b7fbd6a2556a5
+Subproject 98c392025b759d2ccc11f0d564331af4b5290ae
diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git
-Subproject e466145e1c1e359a388f3bd2e15130941ac76c1
+Subproject 6cec5272c3887bf998c56c5243f7ee6ee964e3f
diff --git a/docs/submodules/logging-analytics.git b/docs/submodules/logging-analytics.git
-Subproject cdcf2e46defa561b40ab2ccc47866a6c26b553d
+Subproject cf9f837c619d2213665826a3ecb6f5c3c4f4ecc
diff --git a/docs/submodules/logging-analytics/pomba/pomba-audit-common.git b/docs/submodules/logging-analytics/pomba/pomba-audit-common.git
-Subproject 5825588251d7a8422242878ddd4a7e4d38c8a6f
+Subproject 307eeee5bbc8838b345cde07c71c8c8fbbd5895
diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git
-Subproject 149a9fb31eab12a86d28f73aaa2ba4a05343e0f
+Subproject 51df70ea00e53e93f4fc337b3e9f4bfd28cf7b5
diff --git a/docs/submodules/multicloud/azure.git b/docs/submodules/multicloud/azure.git
-Subproject fe9304306bb9ca809950eda7df35654d3e8dcd3
+Subproject f923c6bc0c7c33fe69347c4e6a929cd8045263a
diff --git a/docs/submodules/multicloud/framework.git b/docs/submodules/multicloud/framework.git
-Subproject 848132168436d54862ebc9ee008cc1a034e6a11
+Subproject 5a2620962e6d2a572586de8da72a5a767683413
diff --git a/docs/submodules/multicloud/k8s.git b/docs/submodules/multicloud/k8s.git
-Subproject 09dffa6d151b046a87edcb91a46449cabc66532
+Subproject 845cdd2aa5d790e57b0b2999180df4abc6724bf
diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git
-Subproject 82779227eacce73d628ab779bb5b4a520b8ee46
+Subproject f3f773c1fab370a10d2d66eb4bcbd9a89a52ba1
diff --git a/docs/submodules/optf/has.git b/docs/submodules/optf/has.git
-Subproject d21350b31eb300b37c89c6dcc04a89229d34af8
+Subproject 6b09bcaf2cea9abd3151dcf5dcd159ce684fc47
diff --git a/docs/submodules/optf/osdf.git b/docs/submodules/optf/osdf.git
-Subproject ba5f7f0c456ef1804805302a813d964993b4682
+Subproject fd0a0ffc54d41029cbc8645b5702b36dead428d
diff --git a/docs/submodules/osa.git b/docs/submodules/osa.git
-Subproject c45208e505b860dcb3fd1025056b17a1982c50b
+Subproject 0131effd6aec0e8f2c6fd1b9be485b68b47fc58
diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git
-Subproject db6dc041db0aa8fbc5379299979dbd1d446ccc8
+Subproject 80133d27f21e27c8da4b3e8d635fb2c05f2f772
diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git
-Subproject 0f079d2fa0cc68c3a682e0e0f73511dd576066b
+Subproject 3a3086180abb951a2e0a919d4a38895b53ff332
diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git
-Subproject f44b09b30d206b4b714971fd38599e8c8697cad
+Subproject 4b7993a3e61c9afea0674ec6a81fb1bcb13c818
diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git
-Subproject 610ff24fb145dc64e73a12d51901446b7b8be24
+Subproject d3d4e1d4df881ee382ba5ea6eddaeb36c077fc4
diff --git a/docs/submodules/sdc/jtosca.git b/docs/submodules/sdc/jtosca.git
-Subproject d0d5690f13b9c794044bfe6bd7ac87557dd3dce
+Subproject 527fe8bdac1f1c7c59738c598996dc8c842a22e
diff --git a/docs/submodules/sdc/sdc-tosca.git b/docs/submodules/sdc/sdc-tosca.git
-Subproject 3bc744e849fff5f599746f9035449b1940bdcdc
+Subproject eb17f55341e7e46a63b1f45127cd4e97a7936f4
diff --git a/docs/submodules/sdc/sdc-workflow-designer.git b/docs/submodules/sdc/sdc-workflow-designer.git
-Subproject 5f7ee971d8558b00c5c4e2182d63a5b8bb9b994
+Subproject 3e103b792f9507d7e690c53dd2fabdd60d984c1
diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git
-Subproject ae2694d30df3a7f62324ec7e617d23f187debcb
+Subproject d73fe57f9e6a420ccf8f91cf188e8162ab881a0
diff --git a/docs/submodules/so.git b/docs/submodules/so.git
-Subproject 15c7bc833ae91ed2590370dd001d5361149aef9
+Subproject d652e65a43f3236abc30d55b040e13716aefe3a
diff --git a/docs/submodules/ui/dmaapbc.git b/docs/submodules/ui/dmaapbc.git
deleted file mode 160000
-Subproject 60382c78c8a88ee5b5aa1c7e2d6cb4e32eddc10
diff --git a/docs/submodules/usecase-ui.git b/docs/submodules/usecase-ui.git
-Subproject 8efaf0a28dc2b26be9871ccfd1a376e34b372bb
+Subproject 4dd1133ef94b2135fa12cbbc653c3b8669b3765
diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git
-Subproject 5a67813844dd4831a1a68f739e03a073473f320
+Subproject cace8dc13a79959d0ad045113d0e0db96c3ea9b
diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git
-Subproject 95ea3bac38467090417056254ef6e4b3165e27d
+Subproject c939ac9eba0dba965fd0e61839676d8906ffeee
diff --git a/docs/submodules/vid/asdcclient.git b/docs/submodules/vid/asdcclient.git
deleted file mode 160000
-Subproject c4fe8aff6c5984df5ff4bf1482d8a213030509e
diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git
-Subproject a3e1f009032c64fb27ed6ba1997d668d36c95db
+Subproject 35e9f91d0671464a23c0e3cb5fa46895b32f64a
diff --git a/docs/submodules/vnfsdk/model.git b/docs/submodules/vnfsdk/model.git
-Subproject 4fd0e98f62594198ba240265634a3302c3d257e
+Subproject 2d314a01d7f46ccefc18b89f9b661ff15bccc0d