c3460841fb6829bffda324c1a5a29e7dab5485c2
[dcaegen2.git] / docs / sections / design-components / DCAE-MOD / Roles.rst
1 =====
2 Roles
3 =====
4
5
6 Here is master list of all roles involved in ECOMP with DCAE:
7
8 -  System engineer
9
10 -  Component developer/expert - components are also referred to as
11    micro-services but include collectors, analytics
12
13 -  Designer
14
15 -  Tester
16
17 -  Operations
18
19 -  Platform developer
20
21 -  Manager
22
23
24 System engineer
25 ---------------
26
27 Person who knows the high-level technical requirements for DCAE's
28 upcoming release cycle and dictates the development needs.  This person
29 is responsible for the service assurance flows.  This person expresses
30 the nodes and connections of a flow at a high level in a new graph or an
31 existing graph and assigns nodes to component developer/experts to be
32 implemented.
33
34 This person must know:
35
36 -  What newly added flows should look like at a high level
37
38 -  What changes that are needed to existing flows
39
40 -  Target environments/sites/locations that need the flows at what SLA
41
42 -  Data requirements e.g. volume, rate, format, retention
43
44 This person creates a top-level representation of the flow and assigns
45 the pieces to developers or experts for implementation.
46
47
48 Component developer/expert
49 --------------------------
50
51 Person who is responsible for defining an assigned node's subgraph. 
52 This person can be:
53
54 -  A developer who might be onboarding a new component or a new version
55    of an existing component to fulfill the system engineer's
56    requirements
57
58 -  A domain expert who selects a suitable existing component, wires and
59    configures.  This expert knows the intricacies of a class of
60    components (e.g. Acumos machine learning).
61
62 Developers
63 ----------
64
65 They must know:
66
67 -  The target DCAE runtime and can develop a component to successfully
68    run on the runtime
69
70 -  The DCAE onboarding process for components including the development
71    testing procedure
72
73 -  Best practices of data flow management (data provenance?)
74
75 -  Lifecycle of DCAE components specifically impact of changes to
76    existing running instances globally
77
78 -  The resource requirement of the developed component
79
80 Experts
81 -------
82  
83 They must know:
84
85 -  The target DCAE runtime
86
87 -  The technical capabilities of a set of components in order to best
88    select
89
90 -  The technical needs of the set of components in order to properly
91    configure and connect
92
93 Designer
94 --------
95
96
97 Person who is responsible for connecting remote nodes to flows and
98 configuring all nodes in a flow in the context of the flow and in the
99 context of the greater graph.  An example of the former is connecting a
100 flow with a collector to a black boxed vMME.  An example of the latter
101 is assigning the threshold to a threshold-crossing-analytics component
102 when it is connected to a specific VES collector who is connected to a
103 specific vMME.
104
105 This person knows:
106
107 -  The VNFs to monitor and the technical details to correctly connect
108    with them
109
110 -  Enough about the capability of a component and understands the
111    characteristics and requirements of a flow to properly
112    assign designer_editable configuration parameters
113
114 This person has the ability to promote flows through the development
115 process (i.e. FTL to IST to ETE) and will coordinate with testers to
116 make sure the progression happens.
117
118 Tester
119 ------
120
121 Person who is responsible for testing a promoted new flow or newly
122 edited flow.  Once the designer has promoted a flow to a tester's
123 environment, the tester will have ready access to the deployment
124 artifacts necessary to apply the runtime changes that will reflect the
125 flow design and verify the resulting functionality matches to the system
126 engineer's expectations.
127
128 Person knows and owns a DCAE runtime.
129
130 Read access to the design tool would be useful for troubleshooting.
131
132
133 Operations
134 ----------
135
136 Person who is responsible that DCAE both platform and service assurance
137 flows are all operational in production environments and locations. 
138 Once a flow has been fully certified, the required deployment artifact
139 is provided to operations and operations is responsible for applying the
140 runtime changes to reflect the flow design.
141
142 Person knows and owns a DCAE runtime.
143
144 Read access to the design tool would be useful for troubleshooting.
145
146
147
148 Manager
149 -------
150
151
152 Person who are accountable to the business of the successful delivery of
153 a set of service assurance flows.  Read access to the design tool
154 specifically high level reports are useful to understand if goals are
155 being met and to better measure project success.
156
157 Platform developer
158 ------------------
159
160
161 Person who is responsible for the development of the DCAE platform which
162 ranges from onboarding, design, and runtime.  In the scope of onboarding
163 and design, they are also responsible (unless there's an internal
164 operational team) for the operational concerns which means the tooling
165 built in this effort will need to be continually supported. 
166 Their **users** are all the above.  The design tool is intended to span
167 across multiple environments thus must run where all the required
168 parties have access.