Update git submodules
[doc.git] / docs / guides / onap-developer / developing / index.rst
1 .. This work is licensed under a Creative Commons Attribution
2 .. 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
5
6 .. index:: Developer Guides
7
8 .. _doc_onap-developer_guide_projects:
9
10 ONAP components and functionalities
11 ===================================
12 Additional developer level detail is provided for each project below.
13
14 Active and Available Inventory
15 ------------------------------
16
17 .. toctree::
18    :maxdepth: 2
19    :titlesonly:
20
21    ../../../submodules/aai/aai-common.git/docs/index
22    AAI-esr-gui <../../../submodules/aai/esr-gui.git/docs/index>
23    ../../../submodules/aai/esr-server.git/docs/index
24    ../../../submodules/aai/sparky-be.git/docs/index
25    ../../../submodules/aai/event-client.git/docs/index.rst
26
27
28 Application Controller
29 ----------------------
30
31 .. toctree::
32    :maxdepth: 2
33    :titlesonly:
34
35    ../../../submodules/appc/deployment.git/docs/index
36    ../../../submodules/appc.git/docs/index
37
38 Application Authorization Framework
39 -----------------------------------
40
41 .. toctree::
42    :maxdepth: 2
43    :titlesonly:
44
45    ../../../submodules/aaf/authz.git/docs/index
46    Secret Management Service <../../../submodules/aaf/sms.git/docs/index>
47    Certification Service <../../../submodules/aaf/certservice.git/docs/index>
48
49 Command Line Interface
50 ----------------------
51
52 .. toctree::
53    :maxdepth: 2
54    :titlesonly:
55
56    ../../../submodules/cli.git/docs/index
57
58
59 Control Loop Automation Management Platform
60 -------------------------------------------
61
62 .. toctree::
63    :maxdepth: 2
64    :titlesonly:
65
66    ../../../submodules/clamp.git/docs/index
67
68 Common Controller Software Development Kit
69 ------------------------------------------
70
71 .. toctree::
72    :maxdepth: 2
73    :titlesonly:
74
75    ../../../submodules/ccsdk/distribution.git/docs/index
76    ../../../submodules/ccsdk/dashboard.git/docs/index
77    ../../../submodules/ccsdk/platform/plugins.git/docs/index
78    ../../../submodules/ccsdk/apps.git/docs/index
79    ../../../submodules/ccsdk/cds.git/docs/index
80
81 Data Collection, Analysis, and Events
82 -------------------------------------
83
84 .. toctree::
85    :maxdepth: 2
86    :titlesonly:
87
88    ../../../submodules/dcaegen2.git/docs/index
89
90 Data Management as a Platform Data Bus Controller
91 -------------------------------------------------
92
93 .. toctree::
94    :maxdepth: 1
95    :titlesonly:
96
97    ../../../submodules/dmaap/dbcapi.git/docs/index
98    ../../../submodules/dmaap/buscontroller.git/docs/index
99
100 Data Management as a Platform Data Router
101 -----------------------------------------
102
103 .. toctree::
104    :maxdepth: 1
105    :titlesonly:
106
107    ../../../submodules/dmaap/datarouter.git/docs/index
108
109 Data Management as a Platform Message Router
110 --------------------------------------------
111
112 .. toctree::
113    :maxdepth: 2
114    :titlesonly:
115
116    ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
117
118 External API Framework
119 ----------------------
120
121 .. toctree::
122    :maxdepth: 2
123    :titlesonly:
124
125    ../../../submodules/externalapi/nbi.git/docs/index
126
127
128 Holmes
129 ------
130
131 .. toctree::
132    :maxdepth: 2
133    :titlesonly:
134
135    Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
136    Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
137
138 Integration
139 -----------
140
141 .. toctree::
142    :maxdepth: 1
143    :titlesonly:
144
145    ../../../submodules/integration.git/docs/index
146
147 Logging Analytics
148 -----------------
149
150 .. toctree::
151    :maxdepth: 2
152    :titlesonly:
153
154    ../../../submodules/logging-analytics.git/docs/index
155
156 Micro Services Bus
157 ------------------
158
159 .. toctree::
160    :maxdepth: 2
161    :titlesonly:
162
163    ../../../submodules/msb/apigateway.git/docs/index
164    ../../../submodules/msb/swagger-sdk.git/docs/index
165
166
167 Modeling
168 --------
169
170 .. toctree::
171    :maxdepth: 2
172    :titlesonly:
173
174    ../../../submodules/modeling/modelspec.git/docs/index
175    ../../../submodules/modeling/etsicatalog.git/docs/index
176
177 MultiVIM Cloud
178 --------------
179
180 .. toctree::
181    :maxdepth: 2
182    :titlesonly:
183
184    ../../../submodules/multicloud/framework.git/docs/index
185
186 Music
187 -----
188
189 .. toctree::
190    :maxdepth: 2
191    :titlesonly:
192
193    ../../../submodules/music.git/docs/index
194    ../../../submodules/music/distributed-kv-store.git/docs/index
195
196 ONAP Operations Manager
197 -----------------------
198
199 .. toctree::
200    :maxdepth: 2
201    :titlesonly:
202
203    ../../../submodules/oom.git/docs/index
204
205 Optimization Framework
206 ----------------------
207
208 .. toctree::
209    :maxdepth: 2
210    :titlesonly:
211
212    ../../../submodules/optf/has.git/docs/index
213    ../../../submodules/optf/osdf.git/docs/index
214    ../../../submodules/optf/cmso.git/docs/index
215
216 Policy Framework
217 ----------------
218
219 .. toctree::
220    :maxdepth: 2
221    :titlesonly:
222
223    ../../../submodules/policy/parent.git/docs/index
224    ../../../submodules/policy/engine.git/docs/index
225
226 Portal Platform
227 ---------------
228
229 .. toctree::
230    :maxdepth: 2
231    :titlesonly:
232
233    ../../../submodules/portal.git/docs/index
234
235 Service Design & Creation
236 -------------------------
237
238 .. toctree::
239    :maxdepth: 2
240    :titlesonly:
241
242    ../../../submodules/sdc.git/docs/index
243
244 Service Orchestration
245 ---------------------
246
247 .. toctree::
248    :maxdepth: 2
249    :titlesonly:
250
251    ../../../submodules/so.git/docs/index
252    ../../../submodules/so/libs.git/docs/index
253
254 Software Defined Network Controller
255 -----------------------------------
256
257 .. toctree::
258    :maxdepth: 2
259    :titlesonly:
260
261    ../../../submodules/sdnc/oam.git/docs/index
262
263 Software Defined Network Controller for Radio (SDN-R)
264 -----------------------------------------------------
265
266 .. toctree::
267    :maxdepth: 2
268    :titlesonly:
269
270    ../../../submodules/ccsdk/features.git/docs/index
271
272 Use Case User Interface
273 -----------------------
274
275 .. toctree::
276    :maxdepth: 2
277    :titlesonly:
278
279    ../../../submodules/usecase-ui.git/docs/index
280
281 Virtual Function Controller
282 ---------------------------
283
284 .. toctree::
285    :maxdepth: 2
286    :titlesonly:
287
288    ../../../submodules/vfc/nfvo/lcm.git/docs/index
289
290 Virtual Infrastructure Deployment
291 ---------------------------------
292
293 .. toctree::
294    :maxdepth: 2
295    :titlesonly:
296
297
298    ../../../submodules/vid.git/docs/index
299
300 VNF Software Development Kit
301 ----------------------------
302
303 .. toctree::
304    :maxdepth: 2
305    :titlesonly:
306
307    ../../../submodules/vnfsdk/model.git/docs/index