url = ../ccsdk/parent
branch = .
ignore = dirty
-[submodule "docs/submodules/ccsdk/platform/blueprints.git"]
- path = docs/submodules/ccsdk/platform/blueprints.git
- url = ../ccsdk/platform/blueprints
- branch = .
- ignore = dirty
-[submodule "docs/submodules/ccsdk/platform/nbapi.git"]
- path = docs/submodules/ccsdk/platform/nbapi.git
- url = ../ccsdk/platform/nbapi
- branch = .
- ignore = dirty
[submodule "docs/submodules/ccsdk/platform/plugins.git"]
path = docs/submodules/ccsdk/platform/plugins.git
url = ../ccsdk/platform/plugins
branch = .
ignore = dirty
-[submodule "docs/submodules/ccsdk/storage/esaas.git"]
- path = docs/submodules/ccsdk/storage/esaas.git
- url = ../ccsdk/storage/esaas
- branch = .
- ignore = dirty
-[submodule "docs/submodules/ccsdk/storage/pgaas.git"]
- path = docs/submodules/ccsdk/storage/pgaas.git
- url = ../ccsdk/storage/pgaas
- branch = .
- ignore = dirty
[submodule "docs/submodules/ccsdk/utils.git"]
path = docs/submodules/ccsdk/utils.git
url = ../ccsdk/utils
url = ../vid
branch = .
ignore = dirty
-[submodule "docs/submodules/vid/asdcclient.git"]
- path = docs/submodules/vid/asdcclient.git
- url = ../vid/asdcclient
- branch = .
- ignore = dirty
[submodule "docs/submodules/usecase-ui.git"]
path = docs/submodules/usecase-ui.git
url = ../usecase-ui
url = ../aai/event-client
branch = .
ignore = dirty
-[submodule "docs/submodules/ui/dmaapbc.git"]
- path = docs/submodules/ui/dmaapbc.git
- url = ../ui/dmaapbc
- branch = .
- ignore = dirty
[submodule "docs/submodules/optf/osdf.git"]
path = docs/submodules/optf/osdf.git
url = ../optf/osdf
: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>
--- /dev/null
+.. 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
--- /dev/null
+.. 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>
--- /dev/null
+.. 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
--- /dev/null
+.. 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
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
-Design
-======
+.. _doc_guide_user_des:
+
+Design Service
+==============
The goal of the design process is to create all artifacts (models)
that are required to instantiate and manage resources, services,
generates artifacts that are used in other phases of design or when
instantiating or monitoring virtual functions.
-Design includes the following topics:
+The following figure show the different phases and tools involved in
+Onboarding, Design and Distribution process.
+
+|image1|
+
+**The "Core" Design Process includes the following steps:**
+
+* Pre-Onboarding
+ A VNF/PNF Provider delivers VNF descriptor, model and
+ artefacts (e.g. HEAT template), which will be validated
+ and packaged for onboarding to ONAP
+
+* (Resource)-Onboarding
+ In the SDC a License Model is created, the VNF/PNF package imported
+ and a Vendor Software Product (VSP) is created
+
+* VF Creation and Testing
+ A V(N)F, PNF or CR Model is created (a) import of a VSP or VFC
+ (b) manual creation and import of artefacts created via external
+ tools like the Controller Design Studio (CDS), responsible for the
+ Controller Blueprint Design
+ The created VF will pass a testing workflow to be used
+ in a Service Model
+
+* Service Design
+ A Service Model is created as a composition of resources
+ (e.g. V(N)Fs, PNFs,...), Policies, Workflows,...
+ The created Service Model will pass a testing workflow and
+ handed over to a Governance Approval and Distribution process
+
+* Governance Approval and Distribution
+ The Service Provider will have a specific set of policies and
+ procedures for approving Services and deploying them in the
+ Runtime Service Catalog
+
+**The optional/additional Design steps are:**
+
+* Controller Blueprint Design
+ The Controller Blueprint is the overall service design, fully model-driven,
+ intent based package needed for self service provisioning and configuration
+ management automation. The framework to automate the resolution of resources
+ for instantiation and any config provisioning operation,
+ such as day0, day1 or day2 configuration.
+ It provides a tool called Controller Design Studio
+
+* Policy Design
+ The Policy Creation component deals with policies.
+ These are rules, conditions, requirements, constraints, attributes,
+ or needs that must be provided, maintained, and/or enforced.
+ At a lower level, Policy involves machine-readable rules enabling
+ actions to be taken based on triggers or requests.
+
+* APPC Controller Design
+ APPC Controller Design Tool (CDT) is used for self-service onboarding of
+ VNF’s. VNF owners can create templates and other artifacts for APPC
+ Configure command (used to apply a post-instantiation configuration)
+ as well as other life cycle commands.
+
+* Workflow Design
+ The purpose of the Workflow Designer is to enable designers to define or
+ modify workflows to support Service/Resource change management scenarios
+ executed by the Service Orchestrator.
+
+* Control Loop Design
+ This phase includes the Design of a closed loop template and associate it
+ to a Service. The template represents the theoretical flow of the CL.
+ It generates a deployment artifact that can be ingested by the DCAE in
+ order to create the needed DCAE microservices in runtime.
+ The design is done in the SDC DCAE-DS (Design Studio).
+ The DCAE Design Studio enables to define and configure
+ the monitoring flows of DCAE.
+ The configuration and deployment of a Control Loop will be done with
+ Control Loop Automation Management (CLAMP) tool.
+
+The follwing sections will focus on the different Design steps:
.. toctree::
:maxdepth: 1
Governance Approval and Service Distribution <./service-distribution/index.rst>
- Control Loop Design <./control-loop/index.rst>
+ Controller Blueprint Design <../../../submodules/ccsdk/cds.git/docs/index.rst>
+
+ Policy Design <../../../submodules/policy/parent.git/docs/design/design.rst>
+
+ APPC Controller Design <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst>
+
+ Workflow Design <../../../submodules/sdc.git/docs/workflow.rst>
+
+ Control Loop Design <../../../submodules/sdc.git/docs/dcaedesigner.rst>
+
+ Control Loop Automation Management <../../../submodules/clamp.git/docs/index.rst>
+
+
+
+.. |image1| image:: media/Design-Overview.png
+
-* `Policy Design <https://wiki.onap.org/x/SYAP>`_
-* `SDC Artifacts List <https://wiki.onap.org/x/LYAP>`_
**Prerequisites:** Obtain Heat/ENV files and other files required for
onboarding. The requirements are found in the following document.
-.. toctree::
- :maxdepth: 1
- :titlesonly:
- Heat requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.rst>
+`Heat requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/Heat/index.html>`_
#. Put the Heat, ENV, nested Heat, and other files used by get-file in templates
in a directory.
VNF and PNF packages have to follow the requirements described in:
-.. toctree::
- :maxdepth: 1
- :titlesonly:
+`VNF and PNF Modeling Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/index.html>`_
- VNF and PNF Modeling Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter5/index.rst>
- ONAP Management Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter7/index.rst>
+`ONAP Management Requirements <../../../../submodules/vnfrqts/requirements.git/docs/Chapter7/index.html>`_
For Validation of VNF and PNF packages the tools delivered by VNFSDK can be
used:
Resource Onboarding
===================
**Goal:** Add models and other artifacts required to create, configure,
- instantiate, and manage a VF and, optionally, a VFC.
+ instantiate, and manage a VF/PNF and, optionally, a VFC.
**Tool:** SDC
* `Update a VSP [optional]`_
After updating the artifacts in a VSP, also update:
- * the VF created from the VSP
- * any services that include the VF
+ * the VF/PNF created from the VSP
+ * any services that include the VF/PNF
|image1|
#. Click *Submit* to add the license model to the catalog. A success message
displays.
#. After creating a license, complete `Create a Vendor Software Product`_ to
- add the VSP required for the associated VF.
+ add the VSP required for the associated VF/PNF.
Create a License Key Group [Optional]
-------------------------------------
--------------------------------
Create one or more Vendor Software Products (VSPs) as the building blocks
-for VFs.
+for VFs/PNFs.
.. note::
For interim saving while creating a VSP, click |image2|
**Prerequisites:**
* `Create a License Model`_
-* Existing VNF HEAT package or VNF/PNF CSAR/Zip package
+* VNF HEAT package or VNF/PNF CSAR/Zip package is available.
+
+ See :ref:`sdc_onboarding_package_types` for a description
+ of the onboarding package types.
+* If the package is a secure package then :ref:`pre-install the corresponding Root Certificate in SDC <doc_guide_user_des_res-onb_pre-install_root_certificate>`.
#. From the SDC HOME page, click *ONBOARD*.
#. Hover over Add and select New Vendor Software Product.
as required.
#. In Software Product Attachments (right pane), click *Select file*.
#. In case of a VNF HEAT file: Locate the Heat .zip package and click *Open*.
+
In case of a VNF or PNF CSAR file: Locate the VNF or PNF csar/.zip package
and click *Open*.
#. SDC validates the files in the package. After successful validation, SDC
Update a VSP [optional]
-----------------------
-Upload a new Heat package to a VSP. Afterward, update the VF and service.
+Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and service.
**Prerequisites:** Add one or more VSPs
(see `Create a Vendor Software Product`_).
.. note::
If the Heat template contains errors, contact the Certification Group for
guidance on how to proceed.
-
#. Click *Check In* to save changes.
#. Click *Submit* to add the VSP to the catalog.
A success message is displayed. If the VSP attachments contain errors, an
error message is displayed instead. Fix the issue(s) and re-submit.
#. After updating the VSP:
- #. Upload the VSP to the VF
- (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
- #. Update the VF version in services that include the VF (see step 4
+
+ #. Upload the VSP to the Vf/PNF
+ (see steps 3 to 5 in :ref:`doc_guide_user_des_vf-cre`).
+ #. Update the VF/PNF version in services that include the VF/PNF (see step 4
in :ref:`doc_guide_user_des_ser-des`).
+.. _doc_guide_user_des_res-onb_pre-install_root_certificate:
+
+Pre-Install Root Certificate in SDC [only needed for secure package]
+--------------------------------------------------------------------
+SDC supports the onboarding of packages that are secured according to security option 2 in ETSI NFV-SOL 004v2.6.1.
+
+During onboarding, SDC will validate the authenticity and integrity of a secure package. To enable this validation,
+the root certificate corresponding to the certificate included in the package needs to be available to SDC.
+This is currently done by uploading the root certificate to the following default directory location::
+
+ /dockerdata-nfs/{{ .Release.Name }}/sdc/onbaording/cert
+
+.. note::
+ The directory listed above is mapped to the following directory in the onboarding pod (sdc-onboarding-be)
+ ::
+
+ /var/lib/jetty/cert
+
+ so it is also possible to copy the root certificate directly to this directory in the pod.
+
+The location where the root certificate is uploaded is configurable. The relevant parameters are described in
+the *cert* block in the following values file::
+
+ <path_to_oom_kubernetes>/sdc/charts/sdc-onboarding-be/values.yaml
+
.. |image0| image:: media/sdro-resource-onboarding-workflow.png
.. _doc_guide_user_des_vf-cre:
-VF Creation and Testing
-=======================
-**Goal**: Using VSPs, create one or more VFs as the building blocks for a
-service. Validate and certify the VFs.
+VF/PNF Creation and Testing
+===========================
+**Goal**: Using VSPs, create one or more VFs/PNFs as the building blocks for a
+service. Validate and certify the VFs/PNFs.
**ONAP Component**: SDC
|image2|
-#. From the *Import VF* box, expand a VSP name and click the *Import VSP* icon.
+#. From the *Import VSP* box, expand a VSP name and click the *Import VSP* icon.
|image3|
#. In the General section, complete all fields.
- .. note:: Use the letters "VF" or "PNF" in the name to indicate that the
+ .. note:: Use the letters "VF" or "PNF" in the name to indicate the
component type.
#. Click *Create*.
#. [Optional] At any time before submitting the VF/PNF for testing, click
these options to update VF/PNF information:
- .. note:: These tasks can be done only before submitting the VF for testing.
+ .. note:: These tasks can be done only before submitting the VF/PNF for testing.
- **Icon** change the icon associated with the VF/PNF (vendor-supplied icons
are preferred)
Update a VF/PNF [optional]
--------------------------
-- Update the VSP and other artifacts in a VF.
-- Upload a new version the VSP to the VF whenever the VSP is updated (see steps
- 3 to 5). Other reasons for updating a VF include:
+- Update the VSP and other artifacts in a VF/PNF.
+- Upload a new version the VSP to the VF/PNF whenever the VSP is updated (see steps
+ 3 to 5). Other reasons for updating a VF/PNF include:
- - artifact changes at the VF level that need be uploaded, for example,
+ - artifact changes at the VF/PNF level that need be uploaded, for example,
changes to ENV values (see step 6)
**Prerequisites:**
**Steps**
-#. From the SDC HOME page, click *CATALOG* and search for a VF.
+#. From the SDC HOME page, click *CATALOG* and search for a VF/PNF.
#. In the General section, click *Check Out*.
The Select VSP field is displays.
#. In the Select VSP field, click *Browse*.
- The Import VF box displays and shows the VSP that was used to create the VF.
+ The Import VSP box displays and shows the VSP that was used to create the VF/PNF.
#. Expand the VSP field and click.
#. Click *Check In* to save changes.
-#. After updating the VF:
+#. After updating the VF/PNF:
- - Submit the VF for testing (see `Submit for testing`_).
- - Update the VF version in any service that contains the VF
+ - Submit the VF/PNF for testing (see `Submit for testing`_).
+ - Update the VF/PNF version in any service that contains the VF/PNF
(see step 4 in Update a service [optional]).
.. _doc_guide_user_des_vf-cre_sub-tst:
#. Sign in to SDC as a *Tester*.
#. From the HOME page, select *Ready For Testing* under Active Projects.
-#. In the right pane, click the VF.
+#. In the right pane, click the VF/PNF.
#. Click *Start Testing*.
-#. Test the VF.
+#. Test the VF/PNF.
#. When testing is complete, click *Accept*.
.. |image1| image:: media/design_vf_workflow.png
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>
.. 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.
.. 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>
-Declare PNF instances in ONAP
-=============================
+Declare PNF instances
+=====================
PNF instances can be declared in ONAP inventory (AAI) using REST API
--- /dev/null
+.. 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>
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"
+ }
+ }
+ }'
-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.
}
}'
+
+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.
+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:
::
}'
-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)
}]
}
}'
+
+
+Requests to instantiate a Contrail Network object
+-------------------------------------------------
+
+TO BE COMPLETED
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.
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:
--- /dev/null
+.. 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.
--- /dev/null
+.. 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.
-Subproject commit 5b77b6489dfb644a901e2640615a32d78f533351
+Subproject commit 4c231d800a0cba774f6bbcaa6ddb40a572d0fe4d
-Subproject commit 2e2c16806c4effa2a0484fc9ab69ffea69bd9b84
+Subproject commit bb92400545015f0e0070f41afdf4c5d5537c1406
-Subproject commit 2a970a1e00d49aca2f8c74705275d552e12794b9
+Subproject commit e0c8997a73eac90e5519c90a78a1c919cff26af8
-Subproject commit da2fd730ddb9a21965ac77829fd2bbd50c36c43c
+Subproject commit 9250f693a978f30a6c91dbdff5e49cf12a8277ab
-Subproject commit c8783f0346c69d00ca686a07cb418db751598bb2
+Subproject commit 1eeaac9181f1215316c556b7595b57a315ec5041
-Subproject commit dd4df9816a939cb816966a7fcae17687fd17c892
+Subproject commit 9035495b03de1814d811f3a0c23959f55853616d
-Subproject commit 93876b9e564e9d47ebe25245f315eb7342421c54
+Subproject commit 7c52dea0791617bd0093f6bb59030365a3a29643
-Subproject commit dfe5205bf91864febb2a69d33ede23f3824bb9ed
+Subproject commit 6fa3015125978bac1e255293cb98a472682f28db
-Subproject commit 8a71ae1abd086046b913fc4a645d5b691e51f018
+Subproject commit 70638d1eb225acbc61e00ddbf9356aef38e8f143
-Subproject commit 395fe0a547b1213fb0e17c901d7681d8833208ad
+Subproject commit 9dc7bdbbd46f2e3016617b6d0a1ad394d5771439
-Subproject commit 17552add980d7907f1a906ef8d25adf6121b2343
+Subproject commit c74f6af8d7b72eeeee7ceedbf82fc8cecef1ae3d
-Subproject commit 0586da4e5172ea4508b62698ded43c6c59eb7d6d
+Subproject commit 826ef89012695a7cc5b8ebbf38c7a10b9fbe9da0
+++ /dev/null
-Subproject commit 0bb45f0d88abb94cadfcc462f31bc8c7453be204
+++ /dev/null
-Subproject commit 989fb459830c7a069433410870f8c1c6559b72ef
-Subproject commit d7275e776cbfa0484d82700bdabf47da91b46114
+Subproject commit 556b233513db587f5d3982628dbca200fd3a9e2a
+++ /dev/null
-Subproject commit 988a69e42e01727cd0aa9296457ea23693a2eb09
+++ /dev/null
-Subproject commit 3b99f1c33173e4c68bd59e5cc88e8239cdeab38b
-Subproject commit e50b344c0491e313c0fff96b37f673388d87cad2
+Subproject commit c3a2bbc077e0d605477b1ff9d6f5590182c8a1b1
-Subproject commit 0ce38c26f68efa97f7d16ec9bbba5888982d97ba
+Subproject commit f9e2ceeae29504505f631086e612fad4e1e16979
-Subproject commit 1bafec84c1e0f02f6bd1574166d403e4e67406d8
+Subproject commit bc5b3da250c303c18c15be99ebceb5b789e9492a
-Subproject commit 7451e2791e623a92dbb5ec34674676bb8981ba19
+Subproject commit e0a428511253eaded34a8d34aeac8d3631065538
-Subproject commit 98572b78fcce9ff28fa7429c9265812bd1e78bf2
+Subproject commit 1c11dffada48c31491f2583f0d28ccecb4b4891b
-Subproject commit b8b578883baa14084e316bd232d8c62ef9b84a1c
+Subproject commit 26a7eb9dea0fb9726d696422f8de54a8ac198994
-Subproject commit 67b3d8b885cbbf0826162480fda027c2f8121358
+Subproject commit 5578af7e4d0347428f3cb1ac12d0ffd1dab7b1cf
-Subproject commit 6b05f46fb4ed5cf086fcbd416a4f619819f86735
+Subproject commit 806fd910c5f752595df6f6ed71a3a537e5411244
-Subproject commit 2f3caa5c27d339c6a371d6e5f9d81519e919d96c
+Subproject commit 995fd6e9bb0368ebbf87f38bd207c4a818443991
-Subproject commit 653a0699b6b89705b8e8223747b7a0e4be8b52f9
+Subproject commit 09a49ea562aed689f7200802ab1143efda581a3e
-Subproject commit 27e1d60f2f01f01c6be4fad6cfde94b8effac3f8
+Subproject commit 5ffa7da0d64771c9d06b99f1319abd5f3a92475a
-Subproject commit 7701ebe1b67fd0196168172bf4106a31931728ee
+Subproject commit 68a426d25eb3bc8c571247654f86531bbc043d2e
-Subproject commit 149a9fb31eab12a86d28f73aaa2ba4a05343e0fe
+Subproject commit 51df70ea00e53e93f4fc337b3e9f4bfd28cf7b5d
-Subproject commit abf6e1719ac0ddbbe0e86e82de6db47d3d744b2e
+Subproject commit 0d3d414b1e62c0c3b1423be9ccd46a720430db8c
-Subproject commit a3da3591ee2af222b98ea62b7ad1c7d2ce1c95e6
+Subproject commit f923c6bc0c7c33fe69347c4e6a929cd8045263a7
-Subproject commit 848132168436d54862ebc9ee008cc1a034e6a11d
+Subproject commit aa7445448861c403c082b20a372c4d5abb35e0ee
-Subproject commit 71a2a9c8b8c77cee67571549a06c96ceb3781077
+Subproject commit 644c005d9f434ec5400e8f74b7456dfc419f74b0
-Subproject commit b360bab7259e7bdba6b1169b56243bda1127bbf0
+Subproject commit cbc9312bdf4b10fe546aca2d7991228cf0b765df
-Subproject commit 38f74ca0461931a1f1d5fefd0dd91900c57a81ee
+Subproject commit 86fe16201c5ce7682db873caeafbbb28f0f4dd0e
-Subproject commit 23b8ca32cbc95021ef194918ab48567df398ff1f
+Subproject commit e4edbe1fc17b5be2c3d6f7eb7be72b5289c3a7aa
-Subproject commit 8d79b30fed898ede2b551a579e3564cb196f707b
+Subproject commit 05d1e18373779df333d1f1fa30cc4891a8da59a4
-Subproject commit eec1111aacc4d49e52acf7fa7fb7cf7640e42800
+Subproject commit 6b09bcaf2cea9abd3151dcf5dcd159ce684fc479
-Subproject commit e4849d9e08f994766856d16160ffbd011dd1b109
+Subproject commit a08923546e09dc830100f32743667c0f48287f7e
-Subproject commit c45208e505b860dcb3fd1025056b17a1982c50b2
+Subproject commit 0131effd6aec0e8f2c6fd1b9be485b68b47fc58a
-Subproject commit 92febb7abd1e6dfe89633d3d92cd70fabf5f0434
+Subproject commit d3a21890b38fa9f79d071477a0c75f72ee748a76
-Subproject commit 7fd4a6ee280b40916d5438b4bd4e2c5a8e043f13
+Subproject commit 2f5f116faa66414da147618ba137e6efd394e166
-Subproject commit 73248465fc2867a3dd1a6494afb6b0774c9028f2
+Subproject commit 7ce177cd99096772ff42ef89d8820070c687fd9b
-Subproject commit 6feb7526a98c43eafc8c3a23cddaf8caa37734f7
+Subproject commit 4d8b50e2a87095d737db72f454f7520ff97f4ec5
-Subproject commit cad897335db0c7912782482fa71932cc2b4ce421
+Subproject commit 527fe8bdac1f1c7c59738c598996dc8c842a22e3
-Subproject commit 759ea36d4c2f5eb65a6a42eb7c3bff92e28961ee
+Subproject commit 517e1d7a4729272350268f4e92b6b178bf2cafe2
-Subproject commit 955897c6ca9304506938c4160ab21cecfc606407
+Subproject commit 9e76f37d775c1312e56d020361426455e2e91a70
-Subproject commit 5f7ee971d8558b00c5c4e2182d63a5b8bb9b994d
+Subproject commit 82acc47d6afad5f6d27f5bf6e927249be9da0a5a
-Subproject commit e1829deb67e1e028ad02c383db86ff654bfcbe06
+Subproject commit 18aff1a38583891cbcddca7242e2326b80d88a8d
-Subproject commit 785c77ae295b287678d4842269222c31b3e4c330
+Subproject commit 86bac35dfead00265a18944528b635a16ab96263
+++ /dev/null
-Subproject commit 60382c78c8a88ee5b5aa1c7e2d6cb4e32eddc10f
-Subproject commit af979cd7eb90c47b8376c856ac221a8fb38489c3
+Subproject commit 41e56dbbd558084d1b30afc8f6d13c58351defdc
-Subproject commit 90ff2d952a983ffe99a02a66e6e9701979b2a842
+Subproject commit c19faa3168f39fc4a1b239485d2bbf9e724da829
-Subproject commit 9d87963588ef92348c37fb25047c1cf595d178b7
+Subproject commit 96adce9ff461501694dbc4ddf097b88c8695c3e8
-Subproject commit 0f54454a7f6a26b42aa78c228d63a74f9a619a78
+Subproject commit 6defdf50b9de3795118a0652cfad0b8dabf3a497
+++ /dev/null
-Subproject commit c4fe8aff6c5984df5ff4bf1482d8a213030509e7
-Subproject commit f332de2925d947c2c6450a5b45cd2e15be3c2962
+Subproject commit f3f44bd70be6214ff9e41330d11021b7d68b9d7d
-Subproject commit d63906f565efeed7b69df821ff544dd4da2a919d
+Subproject commit 726fd64acda27c2d1eca946284c69ba646b97cba
-Subproject commit 59ff2477199487b67e75d016f288f0d81186e10a
+Subproject commit b857497690e83a04ff496edb2a0ec582ac67e394
-Subproject commit 4fd0e98f62594198ba240265634a3302c3d257ef
+Subproject commit 2d314a01d7f46ccefc18b89f9b661ff15bccc0d7
-Subproject commit bf29a4651bff59e27df10caffb14eedb0fbb3900
+Subproject commit 97e4fc1a526984c82720a3a6bed5419450fff567
Code Review / doc.git / commitdiff
