diff options
author | Sofia Wallin <sofia.wallin@est.tech> | 2020-11-16 08:35:19 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2020-11-16 08:35:19 +0000 |
commit | b5454a9e607a98b0bb179b900452dfa1f7d8bf8d (patch) | |
tree | 82353dbbee66e75d041373c42ecf4b11db79f0f2 /docs/guides | |
parent | c108020c11f6b59587c22f184bf6a65f0bf28508 (diff) | |
parent | 295d3210ec42389a39b9052a0ef81b7942ef2c86 (diff) |
Merge "Modify the Service Design Guide to match Guilin release"
Diffstat (limited to 'docs/guides')
14 files changed, 60 insertions, 46 deletions
diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst index 0d89bd0df..aa38a79c8 100644 --- a/docs/guides/onap-user/design/index.rst +++ b/docs/guides/onap-user/design/index.rst @@ -9,16 +9,15 @@ Design Service The goal of the design process is to create all artifacts (models) that are required to instantiate and manage resources, services, -and products on the ONAP platform. The design process requires -input from users with multiple roles. +and products on the ONAP platform. Design progresses logically through a series of phases. Each phase: * is organized into steps that are completed in sequence -* is accessed using a different role with specific responsibilities - generates artifacts that are used in other phases of design or when - instantiating or monitoring virtual functions. +* generates artifacts that are used in other phases of design + +* is performed by multiple Design components The following figure show the different phases and tools involved in Onboarding, Design and Distribution process. @@ -41,13 +40,12 @@ Onboarding, Design and Distribution process. (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 + The created VF Model will 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 ber certified and handed over to + The created Service Model will be certified and handed over to the Service Distribution process **Service Distribution** @@ -60,8 +58,8 @@ Onboarding, Design and Distribution process. The objective is to automate the resolution of resources for instantiation and any config provisioning operation, such as day0, day1 or day2 configuration. - The Controller Blueprint archive (CBA) is the overall service design, - fully model-driven, intent based package needed to design self service + The Controller Blueprint archive (CBA) is a fully model-driven, + intent based package needed to design self service provisioning and configuration management automation. ONAP CDS (Controller Design Studio) is the controller that will process the Controller Blueprint archive (CBA) at run-time. @@ -76,7 +74,7 @@ Onboarding, Design and Distribution process. **VNF LifeCycle Command templating** APPC Controller Design Tool (CDT) is used for self-service onboarding of - VNF’s. VNF owners can create templates and other artifacts for APPC + VNFs. 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. @@ -85,16 +83,13 @@ Onboarding, Design and Distribution process. 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. +**DCAE Onboard/Design** + This phase includes the Onboarding of DCAE Microservices and their + Policy Models, the Service Assurance Design and Distribution to Policy + and CLAMP for Closed Loop Automation Management. + The DCAE Onboard/Design component contains an own Design Catalog, which is + not yet integrated with the SDC Design Catalog to exchange models and + artefacts. The follwing sections will focus on the different Design steps: @@ -120,7 +115,7 @@ The follwing sections will focus on the different Design steps: :ref:`Workflow Design<onap-sdc:workflow>` -:ref:`Control Loop Design<onap-sdc:dcaedesigner>` +:ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>` :ref:`Control Loop Automation Management<onap-clamp:master_index>` diff --git a/docs/guides/onap-user/design/media/Design-Overview.png b/docs/guides/onap-user/design/media/Design-Overview.png Binary files differindex 276e53fc0..3c1eea772 100644 --- a/docs/guides/onap-user/design/media/Design-Overview.png +++ b/docs/guides/onap-user/design/media/Design-Overview.png diff --git a/docs/guides/onap-user/design/media/Design-Overview.pptx b/docs/guides/onap-user/design/media/Design-Overview.pptx Binary files differindex 64416a801..ecef26131 100644 --- a/docs/guides/onap-user/design/media/Design-Overview.pptx +++ b/docs/guides/onap-user/design/media/Design-Overview.pptx diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst index 63f588d2c..067d77a94 100644 --- a/docs/guides/onap-user/design/resource-onboarding/index.rst +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst @@ -16,11 +16,11 @@ Resource Onboarding |image0| **Steps** - * `Create a License Model`_ - * `Create a License Key Group [Optional]`_ - * `Create an Entitlement Pool`_ - * `Create a Feature Group`_ - * `Create a License Agreement`_ + * `Create a License Model [Optional]`_ + * `Create a License Key Group [Optional]`_ + * `Create an Entitlement Pool`_ + * `Create a Feature Group`_ + * `Create a License Agreement`_ * `Create a Vendor Software Product`_ * `Update VFCs in a VSP [optional]`_ * `Update a VSP [optional]`_ @@ -33,8 +33,8 @@ After updating the artifacts in a VSP, also update: .. _doc_guide_user_des_res-onb_cre-lic: -Create a License Model ----------------------- +Create a License Model [Optional] +--------------------------------- VSPs optionally require a license and entitlements to enable the service provider to track the usage. diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png Binary files differindex db56087f7..6633693d1 100644 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-entitlement-pool.png diff --git a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png Binary files differindex ed1e7ac35..557e403b5 100644 --- a/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png +++ b/docs/guides/onap-user/design/resource-onboarding/media/sdro-license-keygroup.png diff --git a/docs/guides/onap-user/design/service-design/index.rst b/docs/guides/onap-user/design/service-design/index.rst index fc290cb27..ce7fb9a3c 100644 --- a/docs/guides/onap-user/design/service-design/index.rst +++ b/docs/guides/onap-user/design/service-design/index.rst @@ -9,6 +9,8 @@ Service Design **Goal:** Add models and other artifacts required to create, configure, instantiate, and manage services. Validate and certify the services. +Besides the manual creation of a Service Model, an existing model can +be imported via a CSAR file **Tool:** SDC @@ -23,9 +25,10 @@ instantiate, and manage services. Validate and certify the services. #. `Create Service`_ #. `Create a Management Workflow [optional]`_ #. `Create a Network Callflow [optional]`_ - #. `Add Service Inputs [optional]`_ + #. `Manage Service Properties [optional]`_ #. `Update Service [optional]`_ #. `Certify Service`_ + #. `Import Service CSAR [optional]`_ .. _doc_guide_user_des_ser-cre_serv: @@ -206,10 +209,11 @@ the service model. .. _doc_guide_user_des_ser-para_in: -Add Service Inputs [optional] ------------------------------ +Manage Service Properties [optional] +------------------------------------ -Select parameters as input fields during Service instantiation. +Add new Service parameters and define as input fields +during Service instantiation. **Prerequisites:** `Create service`_ @@ -307,6 +311,31 @@ architecture contains uncertified resources. #. A Message appears, that the Service is certified. +Import Service CSAR [optional] +------------------------------ + +Note: This step can be used, when a Service Model already exists + +**Steps** + +#. From the SDC HOME page, hover over IMPORT and select *IMPORT SERVICE CSAR*. + + |image0| + +#. In the File Upload Dialog, select the csar file and press *Open*. + + |image10| + +#. In the General section, complete all fields. + + |image11| + +#. Click Create. + + A message displays when Service creation is complete. + +#. Continue with Service Design steps mentioned above + .. |image0| image:: media/sdc-home.png .. |image1| image:: media/sdc-service-workflow.png .. |image2| image:: media/design_asdccanvas_connect_elements.png @@ -316,4 +345,6 @@ architecture contains uncertified resources. .. |image6| image:: media/sdc-service-composition.png .. |image7| image:: media/sdc-service-workflow.png .. |image8| image:: media/sdc-service-properties.png -.. |image9| image:: media/sdc-service-properties-input.png
\ No newline at end of file +.. |image9| image:: media/sdc-service-properties-input.png +.. |image10| image:: media/sdc-service-import.png +.. |image11| image:: media/sdc-service-general-import.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-home.png b/docs/guides/onap-user/design/service-design/media/sdc-home.png Binary files differindex 3b14c99e0..201383e98 100644 --- a/docs/guides/onap-user/design/service-design/media/sdc-home.png +++ b/docs/guides/onap-user/design/service-design/media/sdc-home.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-general-import.png b/docs/guides/onap-user/design/service-design/media/sdc-service-general-import.png Binary files differnew file mode 100644 index 000000000..f050ff596 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-general-import.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-import.png b/docs/guides/onap-user/design/service-design/media/sdc-service-import.png Binary files differnew file mode 100644 index 000000000..bf0c8c196 --- /dev/null +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-import.png diff --git a/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png b/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png Binary files differindex 03867f954..35ba6615b 100644 --- a/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png +++ b/docs/guides/onap-user/design/service-design/media/sdc-service-workflow-design.png diff --git a/docs/guides/onap-user/design/service-distribution/index.rst b/docs/guides/onap-user/design/service-distribution/index.rst index fbd0d1b29..72730d901 100644 --- a/docs/guides/onap-user/design/service-distribution/index.rst +++ b/docs/guides/onap-user/design/service-distribution/index.rst @@ -29,8 +29,6 @@ Steps - `Distribute Service`_ - `Monitor Distribution`_ -- `Verify that the DCAE Blueprint is Deployed`_ - .. _doc_guide_user_des_ser-dis-start: @@ -79,16 +77,6 @@ Monitor Distribution #. If deploy errors are shown, the reason has to be investigated and the Service can be *Redistributed* -.. _doc_guide_user_des_ser-dis-dcae: - -Verify that the DCAE Blueprint is Deployed ------------------------------------------- - -The DCAE controller requires a blueprint (or guideline) to be available -at the site on which the first VNF is deployed. This blueprint is a -management workflow and configuration description for a given VNF, and -it must be available after completing the service distribution process -and before beginning the instantiation process. .. |image1| image:: media/sdc-service-distribution-workflow.png .. |image2| image:: media/sdc-service-distribute.png diff --git a/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribution-workflow.png b/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribution-workflow.png Binary files differindex 16578cbc2..4222f8548 100644 --- a/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribution-workflow.png +++ b/docs/guides/onap-user/design/service-distribution/media/sdc-service-distribution-workflow.png diff --git a/docs/guides/onap-user/design/vfcreation/media/sdc-home.png b/docs/guides/onap-user/design/vfcreation/media/sdc-home.png Binary files differindex 3b14c99e0..201383e98 100644 --- a/docs/guides/onap-user/design/vfcreation/media/sdc-home.png +++ b/docs/guides/onap-user/design/vfcreation/media/sdc-home.png |