docs/guides/onap-user/design/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2 .. International License. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5 .. _doc_guide_user_des:
   6
   7 Design Service
   8 ==============
   9
  10 The goal of the design process is to create all artifacts (models)
  11 that are required to instantiate and manage resources, services,
  12 and products on the ONAP platform.
  13
  14 Design progresses logically through a series of phases. Each phase:
  15
  16 * is organized into steps that are completed in sequence
  17
  18 * generates artifacts that are used in other phases of design
  19
  20 * is performed by multiple Design components
  21
  22 The following figure show the different phases and tools involved in
  23 Onboarding, Design and Distribution process.
  24
  25 |image1|
  26
  27 **The "Core" Design Process includes the following steps:**
  28
  29 **Pre-Onboarding**
  30     A VNF/PNF/CNF Provider delivers its descriptor, model and
  31     artefacts (e.g. HEAT template, Helm Chart), which will be validated
  32     and packaged for onboarding to ONAP
  33
  34 **(Resource)-Onboarding**
  35     In the SDC a License Model is created, the VNF/PNF/CNF package imported
  36     and a Vendor Software Product (VSP) is created
  37
  38 **VF Creation and Testing**
  39     A V(N)F, PNF or CR Model is created (a) import of a VSP or VFC
  40     (b) manual creation and import of artefacts created via external
  41     tools like the Controller Design Studio (CDS), responsible for the
  42     Controller Blueprint Design
  43     The created VF Model will be used in a Service Model
  44
  45 **Service Design**
  46     A Service Model is created as a composition of resources
  47     (e.g. V(N)Fs, PNFs,...), Policies, Workflows,...
  48     The created Service Model will be certified and handed over to
  49     the Service Distribution process
  50
  51 **Service Distribution**
  52     The Service Provider will distribute the Service Model to the
  53     Runtime Service Catalog
  54
  55 **The optional/additional Design steps are:**
  56
  57 **VNF parameter assignment templating**
  58     The objective is to automate the resolution of resources for instantiation
  59     and any config provisioning operation, such as day0, day1 or day2
  60     configuration.
  61     The Controller Blueprint archive (CBA) is a fully model-driven,
  62     intent based package needed to design self service
  63     provisioning and configuration management automation.
  64     ONAP CDS (Controller Design Studio) is the controller that will process
  65     the Controller Blueprint archive (CBA) at run-time.
  66
  67 **Policy Design**
  68     These are rules, conditions, requirements, constraints, attributes,
  69     or needs that must be provided, maintained, and/or enforced.
  70     At a lower level, Policy involves machine-readable rules enabling
  71     actions to be taken based on triggers or requests. ONAP Policy framework
  72     provides some policy models that are implemented and pre-loaded when
  73     installing ONAP.
  74
  75 **Workflow Design**
  76     The purpose of the Workflow Designer is to enable designers to define or
  77     modify workflows to support Service/Resource change management scenarios
  78     executed by the Service Orchestrator.
  79
  80 **DCAE Onboard/Design**
  81     This phase includes the Onboarding of DCAE Microservices and their
  82     Policy Models, the Service Assurance Design and Distribution to Policy
  83     and CLAMP for Closed Loop Automation Management.
  84     The DCAE Onboard/Design component contains an own Design Catalog, which is
  85     not yet integrated with the SDC Design Catalog to exchange models and
  86     artefacts.
  87
  88 The following sections focus on the different Design steps:
  89
  90 .. toctree::
  91    :maxdepth: 1
  92    :titlesonly:
  93
  94    Pre-Onboarding <./pre-onboarding/index.rst>
  95    Resource-Onboarding <./resource-onboarding/index.rst>
  96    VF Creation and Testing <./vfcreation/index.rst>
  97    Service Design <./service-design/index.rst>
  98    Service Distribution <./service-distribution/index.rst>
  99    VNF Parameter Resolution Design <./parameter_resolution/index.rst>
 100    Control Loop Design <./control-loop/index.rst>
 101    Instructions for Control Loop Design <./control-loop-design-steps/cl_design_instructions.rst>
 102
 103 The following section provide links to the projects:
 104
 105 - :ref:`Policy Design<onap-policy-parent:design-label>`
 106 - :ref:`Workflow Design<onap-sdc:workflow>`
 107 - :ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>`
 108 - :ref:`Control Loop Automation Management<onap-policy-parent:clamp-label>`
 109
 110 .. |image1| image:: media/Design-Overview.png
 111
 112
 113