Merge "Fix links to new intersphinx format."
[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/CNF Provider delivers its descriptor, model and
32     artefacts (e.g. HEAT template, Helm Chart), 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/CNF 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 ber certified and handed over to
51     the Service Distribution process
52
53 **Service Distribution**
54     The Service Provider will distribute the Service Model to the
55     Runtime Service Catalog
56
57 **The optional/additional Design steps are:**
58
59 **VNF parameter assignment templating**
60     The objective is to automate the resolution of resources for instantiation
61     and any config provisioning operation, such as day0, day1 or day2
62     configuration.
63     The Controller Blueprint archive (CBA) is the overall service design,
64     fully model-driven, intent based package needed to design self service
65     provisioning and configuration management automation.
66     ONAP CDS (Controller Design Studio) is the controller that will process
67     the Controller Blueprint archive (CBA) at run-time.
68
69 **Policy Design**
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. ONAP Policy framework
74     provides some policy models that are implemented and pre-loaded when
75     installing ONAP.
76
77 **VNF LifeCycle Command templating**
78     APPC Controller Design Tool (CDT) is used for self-service onboarding of
79     VNF’s. VNF owners can create templates and other artifacts for APPC
80     Configure command (used to apply a post-instantiation configuration)
81     as well as other life cycle commands.
82
83 **Workflow Design**
84     The purpose of the Workflow Designer is to enable designers to define or
85     modify workflows to support Service/Resource change management scenarios
86     executed by the Service Orchestrator.
87
88 **Control Loop Design**
89     This phase includes the Design of a closed loop template and associate it
90     to a Service. The template represents the theoretical flow of the CL.
91     It generates a deployment artifact that can be ingested by the DCAE in
92     order to create the needed DCAE microservices in runtime.
93     The design is done in the SDC DCAE-DS (Design Studio).
94     The DCAE Design Studio enables to define and configure
95     the monitoring flows of DCAE.
96     The configuration and deployment of a Control Loop will be done with
97     Control Loop Automation Management (CLAMP) tool.
98
99 The follwing sections will focus on the different Design steps:
100
101 .. toctree::
102    :maxdepth: 1
103    :titlesonly:
104
105    Pre-Onboarding <./pre-onboarding/index.rst>
106
107    Resource-Onboarding <./resource-onboarding/index.rst>
108
109    VF Creation and Testing <./vfcreation/index.rst>
110
111    Service Design <./service-design/index.rst>
112
113    Service Distribution <./service-distribution/index.rst>
114
115    VNF parameter resolution Design <./parameter_resolution/index.rst>
116
117 :ref:`Policy Design<onap-policy-parent:design-label>`
118
119 :ref:`VNF LifeCycle Command templating<onap-appc:master_index>`
120
121 :ref:`Workflow Design<onap-sdc:workflow>`
122
123 :ref:`Control Loop Design<onap-sdc:dcaedesigner>`
124
125 :ref:`Control Loop Automation Management<onap-clamp:master_index>`
126
127
128
129 .. |image1| image:: media/Design-Overview.png
130
131
132