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. The design process requires
  13 input from users with multiple roles.
  14
  15 Design progresses logically through a series of phases. Each phase:
  16
  17 * is organized into steps that are completed in sequence
  18
  19 * is accessed using a different role with specific responsibilities
  20   generates artifacts that are used in other phases of design or when
  21   instantiating or monitoring virtual functions.
  22
  23 The following figure show the different phases and tools involved in
  24 Onboarding, Design and Distribution process.
  25
  26 |image1|
  27
  28 **The "Core" Design Process includes the following steps:**
  29
  30 * Pre-Onboarding
  31     A VNF/PNF Provider delivers VNF descriptor, model and
  32     artefacts (e.g. HEAT template), which will be validated
  33     and packaged for onboarding to ONAP
  34
  35 * (Resource)-Onboarding
  36     In the SDC a License Model is created, the VNF/PNF package imported
  37     and a Vendor Software Product (VSP) is created
  38
  39 * VF Creation and Testing
  40     A V(N)F, PNF or CR Model is created (a) import of a VSP or VFC
  41     (b) manual creation and import of artefacts created via external
  42     tools like the Controller Design Studio (CDS), responsible for the
  43     Controller Blueprint Design
  44     The created VF will pass a testing workflow to be used
  45     in a Service Model
  46
  47 * Service Design
  48     A Service Model is created as a composition of resources
  49     (e.g. V(N)Fs, PNFs,...), Policies, Workflows,...
  50     The created Service Model will pass a testing workflow and
  51     handed over to a Governance Approval and Distribution process
  52
  53 * Governance Approval and Distribution
  54     The Service Provider will have a specific set of policies and
  55     procedures for approving Services and deploying them in the
  56     Runtime Service Catalog
  57
  58 **The optional/additional Design steps are:**
  59
  60 * VNF parameter assignment templating
  61     The objective is to automate the resolution of resources for instantiation
  62     and any config provisioning operation, such as day0, day1 or day2
  63     configuration.
  64     The Controller Blueprint archive (CBA) is the overall service design,
  65     fully model-driven, intent based package needed to design self service
  66     provisioning and configuration management automation.
  67     ONAP CDS (Controller Design Studio) is the controller that will process
  68     the Controller Blueprint archive (CBA) at run-time.
  69
  70 * Policy Design
  71     These are rules, conditions, requirements, constraints, attributes,
  72     or needs that must be provided, maintained, and/or enforced.
  73     At a lower level, Policy involves machine-readable rules enabling
  74     actions to be taken based on triggers or requests. ONAP Policy framework
  75     provides some policy models that are implemented and pre-loaded when
  76     installing ONAP.
  77
  78 * VNF LifeCycle Command templating
  79     APPC Controller Design Tool (CDT) is used for self-service onboarding of
  80     VNF’s. VNF owners can create templates and other artifacts for APPC
  81     Configure command (used to apply a post-instantiation configuration)
  82     as well as other life cycle commands.
  83
  84 * Workflow Design
  85     The purpose of the Workflow Designer is to enable designers to define or
  86     modify workflows to support Service/Resource change management scenarios
  87     executed by the Service Orchestrator.
  88
  89 * Control Loop Design
  90     This phase includes the Design of a closed loop template and associate it
  91     to a Service. The template represents the theoretical flow of the CL.
  92     It generates a deployment artifact that can be ingested by the DCAE in
  93     order to create the needed DCAE microservices in runtime.
  94     The design is done in the SDC DCAE-DS (Design Studio).
  95     The DCAE Design Studio enables to define and configure
  96     the monitoring flows of DCAE.
  97     The configuration and deployment of a Control Loop will be done with
  98     Control Loop Automation Management (CLAMP) tool.
  99
 100 The follwing sections will focus on the different Design steps:
 101
 102 .. toctree::
 103    :maxdepth: 1
 104    :titlesonly:
 105
 106    Pre-Onboarding <./pre-onboarding/index.rst>
 107
 108    Resource-Onboarding <./resource-onboarding/index.rst>
 109
 110    VF Creation and Testing <./vfcreation/index.rst>
 111
 112    Service Design <./service-design/index.rst>
 113
 114    Governance Approval and Service Distribution <./service-distribution/index.rst>
 115
 116    VNF parameter assignment templating <../../../submodules/ccsdk/cds.git/docs/index.rst>
 117
 118    Policy Design <../../../submodules/policy/parent.git/docs/design/design.rst>
 119
 120    VNF LifeCycle Command templating <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst>
 121
 122    Workflow Design <../../../submodules/sdc.git/docs/workflow.rst>
 123
 124    Control Loop Design <../../../submodules/sdc.git/docs/dcaedesigner.rst>
 125
 126    Control Loop Automation Management <../../../submodules/clamp.git/docs/index.rst>
 127
 128
 129
 130 .. |image1| image:: media/Design-Overview.png
 131
 132
 133