Committer promotion - Andreas Geissler
[doc.git] / 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 * Controller Blueprint Design
61     The Controller Blueprint is the overall service design, fully model-driven,
62     intent based package needed for self service provisioning and configuration
63     management automation. The framework to automate the resolution of resources
64     for instantiation and any config provisioning operation,
65     such as day0, day1 or day2 configuration.
66     It provides a tool called Controller Design Studio
67
68 * Policy Design
69     The Policy Creation component deals with policies.
70     These are rules, conditions, requirements, constraints, attributes,
71     or needs that must be provided, maintained, and/or enforced.
72     At a lower level, Policy involves machine-readable rules enabling
73     actions to be taken based on triggers or requests.
74
75 * APPC Controller Design
76     APPC Controller Design Tool (CDT) is used for self-service onboarding of
77     VNF’s. VNF owners can create templates and other artifacts for APPC
78     Configure command (used to apply a post-instantiation configuration)
79     as well as other life cycle commands.
80
81 * Workflow Design
82     The purpose of the Workflow Designer is to enable designers to define or
83     modify workflows to support Service/Resource change management scenarios
84     executed by the Service Orchestrator.
85
86 * Control Loop Design
87     This phase includes the Design of a closed loop template and associate it
88     to a Service. The template represents the theoretical flow of the CL.
89     It generates a deployment artifact that can be ingested by the DCAE in
90     order to create the needed DCAE microservices in runtime.
91     The design is done in the SDC DCAE-DS (Design Studio).
92     The DCAE Design Studio enables to define and configure
93     the monitoring flows of DCAE.
94     The configuration and deployment of a Control Loop will be done with 
95     Control Loop Automation Management (CLAMP) tool.
96
97 The follwing sections will focus on the different Design steps:
98
99 .. toctree::
100    :maxdepth: 1
101    :titlesonly:
102
103    Pre-Onboarding <./pre-onboarding/index.rst>
104
105    Resource-Onboarding <./resource-onboarding/index.rst>
106
107    VF Creation and Testing <./vfcreation/index.rst>
108
109    Service Design <./service-design/index.rst>
110
111    Governance Approval and Service Distribution <./service-distribution/index.rst>
112
113    Controller Blueprint Design <../../../submodules/ccsdk/cds.git/docs/index.rst>
114
115    Policy Design <../../../submodules/policy/parent.git/docs/design/design.rst>
116
117    APPC Controller Design <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst>
118
119    Workflow Design <../../../submodules/sdc.git/docs/workflow.rst>
120
121    Control Loop Design <../../../submodules/sdc.git/docs/dcaedesigner.rst>
122
123    Control Loop Automation Management <../../../submodules/clamp.git/docs/index.rst>
124
125
126
127 .. |image1| image:: media/Design-Overview.png
128
129
130