Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 6de4da40fc81d339895ce2bb71f3635d2516104a / . / docs / guides / onap-developer / developing / index.rst
blob: 0b09cfb78f56b7a7724cf5fbb595c42acd741646 [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 Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]81Data Collection, Analysis, and Events
82-------------------------------------
83
84.. toctree::
85 :maxdepth: 2
86 :titlesonly:
87
88 ../../../submodules/dcaegen2.git/docs/index
89
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]90Data Management as a Platform Data Bus Controller
91-------------------------------------------------
92
93.. toctree::
94 :maxdepth: 1
95 :titlesonly:
96
97 ../../../submodules/dmaap/dbcapi.git/docs/index
Rich Bennett0193cf62018-10-25 13:39:18 -0400[diff] [blame]98 ../../../submodules/dmaap/buscontroller.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]99
100Data Management as a Platform Data Router
101-----------------------------------------
102
103.. toctree::
104 :maxdepth: 1
105 :titlesonly:
106
107 ../../../submodules/dmaap/datarouter.git/docs/index
108
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]109Data 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
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]118External API Framework
119----------------------
120
121.. toctree::
122 :maxdepth: 2
123 :titlesonly:
124
125 ../../../submodules/externalapi/nbi.git/docs/index
126
127
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]128Holmes
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
138Integration
139-----------
140
Yang Xue8f84e42019-06-21 19:30:15 -0400[diff] [blame]141.. toctree::
142 :maxdepth: 1
143 :titlesonly:
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]144
Yang Xue8f84e42019-06-21 19:30:15 -0400[diff] [blame]145 ../../../submodules/integration.git/docs/index
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]146
147Logging Analytics
148-----------------
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]149
150.. toctree::
151 :maxdepth: 2
152 :titlesonly:
153
154 ../../../submodules/logging-analytics.git/docs/index
155
156Micro 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
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]166
167Modeling
168--------
169
170.. toctree::
171 :maxdepth: 2
172 :titlesonly:
173
174 ../../../submodules/modeling/modelspec.git/docs/index
yxpoke220be632019-10-17 17:46:03 +0800[diff] [blame]175 ../../../submodules/modeling/etsicatalog.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]176
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]177MultiVIM Cloud
Rich Bennett52314e12017-11-09 12:00:11 -0500[diff] [blame]178--------------
179
180.. toctree::
181 :maxdepth: 2
182 :titlesonly:
183
184 ../../../submodules/multicloud/framework.git/docs/index
185
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]186Music
187-----
188
189.. toctree::
190 :maxdepth: 2
191 :titlesonly:
192
193 ../../../submodules/music.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]194 ../../../submodules/music/distributed-kv-store.git/docs/index
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]195
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]196ONAP Operations Manager
197-----------------------
Rich Bennett83a20b82017-11-13 10:27:39 -0500[diff] [blame]198
199.. toctree::
200 :maxdepth: 2
201 :titlesonly:
202
203 ../../../submodules/oom.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]204
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]205Optimization Framework
206----------------------
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]207
208.. toctree::
209 :maxdepth: 2
210 :titlesonly:
211
212 ../../../submodules/optf/has.git/docs/index
213 ../../../submodules/optf/osdf.git/docs/index
vrvarma009179b2018-11-08 19:36:13 -0500[diff] [blame]214 ../../../submodules/optf/cmso.git/docs/index
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]215
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]216Policy Framework
217----------------
218
219.. toctree::
220 :maxdepth: 2
221 :titlesonly:
222
Pamela Dragosh1301b482019-05-29 11:48:04 -0400[diff] [blame]223 ../../../submodules/policy/parent.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]224 ../../../submodules/policy/engine.git/docs/index
225
226Portal Platform
227---------------
228
229.. toctree::
230 :maxdepth: 2
231 :titlesonly:
232
233 ../../../submodules/portal.git/docs/index
234
235Service Design & Creation
236-------------------------
237
238.. toctree::
239 :maxdepth: 2
240 :titlesonly:
241
242 ../../../submodules/sdc.git/docs/index
243
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]244Service 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
254Software Defined Network Controller
255-----------------------------------
256
257.. toctree::
258 :maxdepth: 2
259 :titlesonly:
260
261 ../../../submodules/sdnc/oam.git/docs/index
262
sai-neetha93d30e02019-07-25 14:10:37 +0200[diff] [blame]263Software 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
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]272Use Case User Interface
273-----------------------
274
275.. toctree::
276 :maxdepth: 2
277 :titlesonly:
278
279 ../../../submodules/usecase-ui.git/docs/index
280
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]281Virtual Function Controller
282---------------------------
283
284.. toctree::
285 :maxdepth: 2
286 :titlesonly:
287
288 ../../../submodules/vfc/nfvo/lcm.git/docs/index
289
290Virtual Infrastructure Deployment
291---------------------------------
292
293.. toctree::
294 :maxdepth: 2
295 :titlesonly:
296
297
298 ../../../submodules/vid.git/docs/index
299
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]300VNF Software Development Kit
301----------------------------
302
303.. toctree::
304 :maxdepth: 2
305 :titlesonly:
306
307 ../../../submodules/vnfsdk/model.git/docs/index