diff options
Diffstat (limited to 'docs/guides')
22 files changed, 535 insertions, 96 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 28a808ba5..a77984456 100644 --- a/docs/guides/onap-user/design/index.rst +++ b/docs/guides/onap-user/design/index.rst @@ -2,8 +2,10 @@ .. 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, @@ -18,7 +20,81 @@ Design progresses logically through a series of phases. Each phase: 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 @@ -34,8 +110,21 @@ Design includes the following topics: 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>`_ diff --git a/docs/guides/onap-user/design/media/Design-Overview.png b/docs/guides/onap-user/design/media/Design-Overview.png Binary files differnew file mode 100644 index 000000000..f94724e1e --- /dev/null +++ b/docs/guides/onap-user/design/media/Design-Overview.png diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index b11fa5c0c..5bfc8d4cc 100644 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -82,11 +82,8 @@ MANIFEST file. These steps are performed outside SDC. **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. @@ -124,12 +121,9 @@ Validate xNF Package (VNF/PNF) 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: diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst index 56f6b6e18..a25983856 100644 --- a/docs/guides/onap-user/design/resource-onboarding/index.rst +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst @@ -7,7 +7,7 @@ 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 @@ -26,8 +26,8 @@ Resource Onboarding * `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| @@ -69,7 +69,7 @@ click |image2| #. 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] ------------------------------------- @@ -151,7 +151,7 @@ Create a Vendor Software Product -------------------------------- 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| @@ -159,7 +159,11 @@ for VFs. **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. @@ -183,6 +187,7 @@ for VFs. 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 @@ -251,7 +256,7 @@ on the Components tab. 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`_). @@ -273,17 +278,42 @@ Upload a new Heat package to a VSP. Afterward, update the VF and service. .. 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 diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png Binary files differindex dcc3104e4..123cd6a4a 100644 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png Binary files differindex 5a5ad9496..7528c8a44 100644 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png diff --git a/docs/guides/onap-user/design/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst index 1ca46bca1..e3e259c06 100644 --- a/docs/guides/onap-user/design/vfcreation/index.rst +++ b/docs/guides/onap-user/design/vfcreation/index.rst @@ -4,10 +4,10 @@ .. _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 @@ -40,13 +40,13 @@ Create a VF/PNF by VSP import |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*. @@ -66,7 +66,7 @@ Create a VF/PNF by VSP import #. [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) @@ -145,11 +145,11 @@ Create a VF/PNF manually 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:** @@ -159,13 +159,13 @@ Update a VF/PNF [optional] **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. @@ -182,10 +182,10 @@ Update a VF/PNF [optional] #. 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: @@ -227,9 +227,9 @@ Test the design and artifacts of a VF/PNF. #. 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 diff --git a/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png b/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png Binary files differindex d3e831229..d57365f51 100644 --- a/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png +++ b/docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png 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. |
