Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / d5ebcdf25085fca11dcb2390deb1c744ed444b4c / . / docs / guides / onap-developer / developing / index.rst
blob: e0bc103a321da797edceddd3ca6f1438e0c89c16 [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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]21| :ref:`aai aai-common<onap-aai-aai-common:master_index>`
22| :ref:`AAI-esr-gui<onap-aai-esr-gui:master_index>`
23| :ref:`aai esr-server<onap-aai-esr-server:master_index>`
24| :ref:`aai sparky-be<onap-aai-sparky-be:master_index>`
25| :ref:`aai event-clientrst<onap-aai-event-client:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]26
27
28Application Controller
29----------------------
30
31.. toctree::
32 :maxdepth: 2
33 :titlesonly:
34
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]35| :ref:`appc deployment<onap-appc-deployment:master_index>`
36| :ref:`appc<onap-appc:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]37
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]38Application Authorization Framework
39-----------------------------------
40
41.. toctree::
42 :maxdepth: 2
43 :titlesonly:
44
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]45| :ref:`aaf authz<onap-aaf-authz:master_index>`
46| :ref:`Secret Management Service<onap-aaf-sms:master_index>`
47| :ref:`Certification Service<onap-aaf-certservice:master_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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]56:ref:`cli<onap-cli:master_index>`
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]66:ref:`clamp<onap-clamp:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]67
68Common Controller Software Development Kit
69------------------------------------------
70
71.. toctree::
72 :maxdepth: 2
73 :titlesonly:
74
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]75| :ref:`ccsdk distribution<onap-ccsdk-distribution:master_index>`
76| :ref:`ccsdk dashboard<onap-ccsdk-dashboard:master_index>`
77| :ref:`ccsdk platform plugins<onap-ccsdk-platform-plugins:master_index>`
78| :ref:`ccsdk apps<onap-ccsdk-apps:master_index>`
79| :ref:`ccsdk cds<onap-ccsdk-cds:master_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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]88:ref:`dcaegen2<onap-dcaegen2:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]97| :ref:`dmaap dbcapi<onap-dmaap-dbcapi:master_index>`
98| :ref:`dmaap buscontroller<onap-dmaap-buscontroller:master_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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]107:ref:`dmaap datarouter<onap-dmaap-datarouter:master_index>`
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]116:ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]117
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]118External API Framework
119----------------------
120
121.. toctree::
122 :maxdepth: 2
123 :titlesonly:
124
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]125:ref:`externalapi nbi<onap-externalapi-nbi:master_index>`
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]126
127
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]128Holmes
129------
130
131.. toctree::
132 :maxdepth: 2
133 :titlesonly:
134
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]135| :ref:`Alarm Correlation and Analysis<onap-holmes-engine-management:master_index>`
136| :ref:`Architecture and APIs<onap-holmes-rule-management:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]145:ref:`integration<onap-integration:master_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
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]154:ref:`logging-analytics<onap-logging-analytics:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]155
156Micro Services Bus
157------------------
158
159.. toctree::
160 :maxdepth: 2
161 :titlesonly:
162
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]163:ref:`msb apigateway<onap-msb-apigateway:master_index>`
164
165:ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]166
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]167
168Modeling
169--------
170
171.. toctree::
172 :maxdepth: 2
173 :titlesonly:
174
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]175:ref:`modeling modelspec<onap-modeling-modelspec:master_index>`
176
177:ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]178
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]179MultiVIM Cloud
Rich Bennett52314e12017-11-09 12:00:11 -0500[diff] [blame]180--------------
181
182.. toctree::
183 :maxdepth: 2
184 :titlesonly:
185
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]186:ref:`multicloud framework<onap-multicloud-framework:master_index>`
Rich Bennett52314e12017-11-09 12:00:11 -0500[diff] [blame]187
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]188Music
189-----
190
191.. toctree::
192 :maxdepth: 2
193 :titlesonly:
194
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]195:ref:`music<onap-music:master_index>`
196
197:ref:`music distributed-kv-store<onap-music-distributed-kv-store:master_index>`
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]198
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]199ONAP Operations Manager
200-----------------------
Rich Bennett83a20b82017-11-13 10:27:39 -0500[diff] [blame]201
202.. toctree::
203 :maxdepth: 2
204 :titlesonly:
205
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]206:ref:`oom<onap-oom:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]207
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]208Optimization Framework
209----------------------
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]210
211.. toctree::
212 :maxdepth: 2
213 :titlesonly:
214
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]215| :ref:`optf has<onap-optf-has:master_index>`
216| :ref:`optf osdf<onap-optf-osdf:master_index>`
217| :ref:`optf cmso<onap-optf-cmso:master_index>`
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]218
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]219Policy Framework
220----------------
221
222.. toctree::
223 :maxdepth: 2
224 :titlesonly:
225
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]226:ref:`policy parent<onap-policy-parent:master_index>`
227
228:ref:`policy engine<onap-policy-engine:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]229
230Portal Platform
231---------------
232
233.. toctree::
234 :maxdepth: 2
235 :titlesonly:
236
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]237:ref:`portal<onap-portal:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]238
239Service Design & Creation
240-------------------------
241
242.. toctree::
243 :maxdepth: 2
244 :titlesonly:
245
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]246:ref:`sdc<onap-sdc:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]247
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]248Service Orchestration
249---------------------
250
251.. toctree::
252 :maxdepth: 2
253 :titlesonly:
254
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]255:ref:`so<onap-so:master_index>`
256
257:ref:`so libs<onap-so-libs:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]258
259Software Defined Network Controller
260-----------------------------------
261
262.. toctree::
263 :maxdepth: 2
264 :titlesonly:
265
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]266:ref:`sdnc oam<onap-sdnc-oam:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]267
sai-neetha93d30e02019-07-25 14:10:37 +0200[diff] [blame]268Software Defined Network Controller for Radio (SDN-R)
269-----------------------------------------------------
270
271.. toctree::
272 :maxdepth: 2
273 :titlesonly:
274
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]275:ref:`ccsdk features<onap-ccsdk-features:master_index>`
sai-neetha93d30e02019-07-25 14:10:37 +0200[diff] [blame]276
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]277Use Case User Interface
278-----------------------
279
280.. toctree::
281 :maxdepth: 2
282 :titlesonly:
283
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]284:ref:`usecase-ui<onap-usecase-ui:master_index>`
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]285
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]286Virtual Function Controller
287---------------------------
288
289.. toctree::
290 :maxdepth: 2
291 :titlesonly:
292
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]293:ref:`vfc nfvo lcm<onap-vfc-nfvo-lcm:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]294
295Virtual Infrastructure Deployment
296---------------------------------
297
298.. toctree::
299 :maxdepth: 2
300 :titlesonly:
301
302
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]303:ref:`vid<onap-vid:master_index>`
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]304
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]305VNF Software Development Kit
306----------------------------
307
308.. toctree::
309 :maxdepth: 2
310 :titlesonly:
311
Aric Gardner6ceaa842020-04-10 14:00:17 -0400[diff] [blame]312:ref:`vnfsdk model<onap-vnfsdk-model:master_index>`