Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 8a701b00a4615a6de13543bd584ff7a999c75cda / . / docs / guides / onap-developer / developing / index.rst
blob: f1086700abdadd06860f17f1293a1836f1069f7d [file] [log] [blame]
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]1.. This work is licensed under a Creative Commons Attribution
2.. 4.0 International License.
Rich Bennett1bf0d362017-10-20 05:08:11 -0400[diff] [blame]3.. http://creativecommons.org/licenses/by/4.0
4.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
5
Rich Bennettb921b992017-11-17 08:28:37 -0500[diff] [blame]6.. index:: Developer Guides
7
Rich Bennett1bf0d362017-10-20 05:08:11 -0400[diff] [blame]8.. _doc_onap-developer_guide_projects:
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]9
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]10ONAP components and functionalities
11===================================
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]12Additional developer level detail is provided for each project below.
13
14Active and Available Inventory
15------------------------------
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]16
Rich Bennett1bf0d362017-10-20 05:08:11 -0400[diff] [blame]17.. toctree::
18 :maxdepth: 2
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]19 :titlesonly:
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]20
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]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
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]25 ../../../submodules/aai/event-client.git/docs/index.rst
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]26
27
28Application 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
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]38Application Authorization Framework
39-----------------------------------
40
41.. toctree::
42 :maxdepth: 2
43 :titlesonly:
44
45 ../../../submodules/aaf/authz.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]46 Secret Management Service <../../../submodules/aaf/sms.git/docs/index>
Tomasz Wrobel40f98022020-03-25 08:51:31 +0100[diff] [blame]47 Certification Service <../../../submodules/aaf/certservice.git/docs/index>
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]48
49Command Line Interface
50----------------------
51
52.. toctree::
53 :maxdepth: 2
54 :titlesonly:
55
56 ../../../submodules/cli.git/docs/index
57
58
andreasgeisslerb9e7fe52019-09-02 13:52:02 +0200[diff] [blame]59Control Loop Automation Management Platform
60-------------------------------------------
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]61
62.. toctree::
63 :maxdepth: 2
64 :titlesonly:
65
66 ../../../submodules/clamp.git/docs/index
67
68Common 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
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]77 ../../../submodules/ccsdk/platform/plugins.git/docs/index
ezhil14f8a6c2019-01-04 14:24:23 +0530[diff] [blame]78 ../../../submodules/ccsdk/apps.git/docs/index
Ezhilarasib5aa4082019-02-11 18:02:04 +0200[diff] [blame]79 ../../../submodules/ccsdk/cds.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]80
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]81.. Being consolidated in ccsdk distribution
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]82 ../../../submodules/ccsdk/platform/blueprints.git/docs/index
83 ../../../submodules/ccsdk/platform/nbapi.git/docs/index
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]84 ../../../submodules/ccsdk/storage/esaas.git/docs/index
85 ../../../submodules/ccsdk/storage/pgaas.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]86 ../../../submodules/ccsdk/sli/adaptors.git/docs/index
87 ../../../submodules/ccsdk/sli/core.git/docs/index
88 ../../../submodules/ccsdk/sli/northbound.git/docs/index
89 ../../../submodules/ccsdk/sli/plugins.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]90
91Data Collection, Analysis, and Events
92-------------------------------------
93
94.. toctree::
95 :maxdepth: 2
96 :titlesonly:
97
98 ../../../submodules/dcaegen2.git/docs/index
99
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]100Data Management as a Platform Data Bus Controller
101-------------------------------------------------
102
103.. toctree::
104 :maxdepth: 1
105 :titlesonly:
106
107 ../../../submodules/dmaap/dbcapi.git/docs/index
Rich Bennett0193cf62018-10-25 13:39:18 -0400[diff] [blame]108 ../../../submodules/dmaap/buscontroller.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]109
110Data Management as a Platform Data Router
111-----------------------------------------
112
113.. toctree::
114 :maxdepth: 1
115 :titlesonly:
116
117 ../../../submodules/dmaap/datarouter.git/docs/index
118
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]119Data Management as a Platform Message Router
120--------------------------------------------
121
122.. toctree::
123 :maxdepth: 2
124 :titlesonly:
125
126 ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
127
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]128Development Tools
129-----------------
130
131.. toctree::
132 :maxdepth: 1
133 :titlesonly:
134
135 ../../../submodules/integration/devtool.git/docs/source/index
136
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]137
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]138External API Framework
139----------------------
140
141.. toctree::
142 :maxdepth: 2
143 :titlesonly:
144
145 ../../../submodules/externalapi/nbi.git/docs/index
146
147
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]148Holmes
149------
150
151.. toctree::
152 :maxdepth: 2
153 :titlesonly:
154
155 Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
156 Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
157
158Integration
159-----------
160
Yang Xue8f84e42019-06-21 19:30:15 -0400[diff] [blame]161.. toctree::
162 :maxdepth: 1
163 :titlesonly:
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]164
Yang Xue8f84e42019-06-21 19:30:15 -0400[diff] [blame]165 ../../../submodules/integration.git/docs/index
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]166
167Logging Analytics
168-----------------
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]169
170.. toctree::
171 :maxdepth: 2
172 :titlesonly:
173
174 ../../../submodules/logging-analytics.git/docs/index
175
176Micro Services Bus
177------------------
178
179.. toctree::
180 :maxdepth: 2
181 :titlesonly:
182
183 ../../../submodules/msb/apigateway.git/docs/index
184 ../../../submodules/msb/swagger-sdk.git/docs/index
185
186.. Empty folders in this release
187 ../../../submodules/msb/discovery.git/docs/index
188 ../../../submodules/msb/java-sdk.git/docs/index
189
190
191Modeling
192--------
193
194.. toctree::
195 :maxdepth: 2
196 :titlesonly:
197
198 ../../../submodules/modeling/modelspec.git/docs/index
yxpoke220be632019-10-17 17:46:03 +0800[diff] [blame]199 ../../../submodules/modeling/etsicatalog.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]200
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]201MultiVIM Cloud
Rich Bennett52314e12017-11-09 12:00:11 -0500[diff] [blame]202--------------
203
204.. toctree::
205 :maxdepth: 2
206 :titlesonly:
207
208 ../../../submodules/multicloud/framework.git/docs/index
209
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]210Music
211-----
212
213.. toctree::
214 :maxdepth: 2
215 :titlesonly:
216
217 ../../../submodules/music.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]218 ../../../submodules/music/distributed-kv-store.git/docs/index
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]219
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]220ONAP Operations Manager
221-----------------------
Rich Bennett83a20b82017-11-13 10:27:39 -0500[diff] [blame]222
223.. toctree::
224 :maxdepth: 2
225 :titlesonly:
226
227 ../../../submodules/oom.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]228
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]229Optimization Framework
230----------------------
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]231
232.. toctree::
233 :maxdepth: 2
234 :titlesonly:
235
236 ../../../submodules/optf/has.git/docs/index
237 ../../../submodules/optf/osdf.git/docs/index
vrvarma009179b2018-11-08 19:36:13 -0500[diff] [blame]238 ../../../submodules/optf/cmso.git/docs/index
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]239
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]240Policy Framework
241----------------
242
243.. toctree::
244 :maxdepth: 2
245 :titlesonly:
246
Pamela Dragosh1301b482019-05-29 11:48:04 -0400[diff] [blame]247 ../../../submodules/policy/parent.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]248 ../../../submodules/policy/engine.git/docs/index
249
250Portal Platform
251---------------
252
253.. toctree::
254 :maxdepth: 2
255 :titlesonly:
256
257 ../../../submodules/portal.git/docs/index
258
259Service Design & Creation
260-------------------------
261
262.. toctree::
263 :maxdepth: 2
264 :titlesonly:
265
266 ../../../submodules/sdc.git/docs/index
267
268.. Empty folders for this release
269 ../../../submodules/sdc/jtosca.git/docs/index
270 ../../../submodules/sdc/sdc-distribution-client.git/docs/index
271 ../../../submodules/sdc/sdc-docker-base.git/docs/index
272 ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
273 ../../../submodules/sdc/sdc-tosca.git/docs/index
274 ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
275
276Service Orchestration
277---------------------
278
279.. toctree::
280 :maxdepth: 2
281 :titlesonly:
282
283 ../../../submodules/so.git/docs/index
284 ../../../submodules/so/libs.git/docs/index
285
286Software Defined Network Controller
287-----------------------------------
288
289.. toctree::
290 :maxdepth: 2
291 :titlesonly:
292
293 ../../../submodules/sdnc/oam.git/docs/index
294
295.. Empty folders for this release
296 ../../../submodules/sdnc/adaptors.git/docs/index
297 ../../../submodules/sdnc/architecture.git/docs/index
298 ../../../submodules/sdnc/core.git/docs/index
299 ../../../submodules/sdnc/features.git/docs/index
300 ../../../submodules/sdnc/northbound.git/docs/index
301 ../../../submodules/sdnc/parent.git/docs/index
302 ../../../submodules/sdnc/plugins.git/docs/index
303
sai-neetha93d30e02019-07-25 14:10:37 +0200[diff] [blame]304Software Defined Network Controller for Radio (SDN-R)
305-----------------------------------------------------
306
307.. toctree::
308 :maxdepth: 2
309 :titlesonly:
310
311 ../../../submodules/ccsdk/features.git/docs/index
312
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]313Use Case User Interface
314-----------------------
315
316.. toctree::
317 :maxdepth: 2
318 :titlesonly:
319
320 ../../../submodules/usecase-ui.git/docs/index
321
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]322Virtual Function Controller
323---------------------------
324
325.. toctree::
326 :maxdepth: 2
327 :titlesonly:
328
329 ../../../submodules/vfc/nfvo/lcm.git/docs/index
330
331Virtual Infrastructure Deployment
332---------------------------------
333
334.. toctree::
335 :maxdepth: 2
336 :titlesonly:
337
338
339 ../../../submodules/vid.git/docs/index
340
341.. Empty folders for this release
342 ../../../submodules/vid/asdcclient.git/docs/index
343
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]344VNF Software Development Kit
345----------------------------
346
347.. toctree::
348 :maxdepth: 2
349 :titlesonly:
350
351 ../../../submodules/vnfsdk/model.git/docs/index