diff options
Diffstat (limited to 'docs/guides/onap-user/design')
| -rw-r--r-- | docs/guides/onap-user/design/index.rst | 101 | ||||
| -rw-r--r-- | docs/guides/onap-user/design/media/Design-Overview.png | bin | 0 -> 117105 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/pre-onboarding/index.rst | 12 | ||||
| -rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/index.rst | 52 | ||||
| -rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-resource-onboarding-workflow.png | bin | 35518 -> 61714 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/resource-onboarding/media/sdro-vsp-service-workflow.png | bin | 11020 -> 10825 bytes | |||
| -rw-r--r-- | docs/guides/onap-user/design/vfcreation/index.rst | 36 | ||||
| -rw-r--r-- | docs/guides/onap-user/design/vfcreation/media/design_vf_workflow.png | bin | 11197 -> 26025 bytes |
8 files changed, 157 insertions, 44 deletions
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 |
