summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/developing/index.rst
blob: e0bc103a321da797edceddd3ca6f1438e0c89c16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
.. This work is licensed under a Creative Commons Attribution
.. 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 AT&T Intellectual Property.  All rights reserved.

.. index:: Developer Guides

.. _doc_onap-developer_guide_projects:

ONAP components and functionalities
===================================
Additional developer level detail is provided for each project below.

Active and Available Inventory
------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

| :ref:`aai aai-common<onap-aai-aai-common:master_index>`
| :ref:`AAI-esr-gui<onap-aai-esr-gui:master_index>`
| :ref:`aai esr-server<onap-aai-esr-server:master_index>`
| :ref:`aai sparky-be<onap-aai-sparky-be:master_index>`
| :ref:`aai event-clientrst<onap-aai-event-client:master_index>`


Application Controller
----------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

| :ref:`appc deployment<onap-appc-deployment:master_index>`
| :ref:`appc<onap-appc:master_index>`

Application Authorization Framework
-----------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

| :ref:`aaf authz<onap-aaf-authz:master_index>`
| :ref:`Secret Management Service<onap-aaf-sms:master_index>`
| :ref:`Certification Service<onap-aaf-certservice:master_index>`

Command Line Interface
----------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`cli<onap-cli:master_index>`


Control Loop Automation Management Platform
-------------------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`clamp<onap-clamp:master_index>`

Common Controller Software Development Kit
------------------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

| :ref:`ccsdk distribution<onap-ccsdk-distribution:master_index>`
| :ref:`ccsdk dashboard<onap-ccsdk-dashboard:master_index>`
| :ref:`ccsdk platform plugins<onap-ccsdk-platform-plugins:master_index>`
| :ref:`ccsdk apps<onap-ccsdk-apps:master_index>`
| :ref:`ccsdk cds<onap-ccsdk-cds:master_index>`

Data Collection, Analysis, and Events
-------------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`dcaegen2<onap-dcaegen2:master_index>`

Data Management as a Platform Data Bus Controller
-------------------------------------------------

.. toctree::
   :maxdepth: 1
   :titlesonly:

| :ref:`dmaap dbcapi<onap-dmaap-dbcapi:master_index>`
| :ref:`dmaap buscontroller<onap-dmaap-buscontroller:master_index>`

Data Management as a Platform Data Router
-----------------------------------------

.. toctree::
   :maxdepth: 1
   :titlesonly:

:ref:`dmaap datarouter<onap-dmaap-datarouter:master_index>`

Data Management as a Platform Message Router
--------------------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>`

External API Framework
----------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`externalapi nbi<onap-externalapi-nbi:master_index>`


Holmes
------

.. toctree::
   :maxdepth: 2
   :titlesonly:

| :ref:`Alarm Correlation and Analysis<onap-holmes-engine-management:master_index>`
| :ref:`Architecture and APIs<onap-holmes-rule-management:master_index>`

Integration
-----------

.. toctree::
   :maxdepth: 1
   :titlesonly:

:ref:`integration<onap-integration:master_index>`

Logging Analytics
-----------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`logging-analytics<onap-logging-analytics:master_index>`

Micro Services Bus
------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`msb apigateway<onap-msb-apigateway:master_index>`

:ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>`


Modeling
--------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`modeling modelspec<onap-modeling-modelspec:master_index>`

:ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>`

MultiVIM Cloud
--------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`multicloud framework<onap-multicloud-framework:master_index>`

Music
-----

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`music<onap-music:master_index>`

:ref:`music distributed-kv-store<onap-music-distributed-kv-store:master_index>`

ONAP Operations Manager
-----------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`oom<onap-oom:master_index>`

Optimization Framework
----------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

| :ref:`optf has<onap-optf-has:master_index>`
| :ref:`optf osdf<onap-optf-osdf:master_index>`
| :ref:`optf cmso<onap-optf-cmso:master_index>`

Policy Framework
----------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`policy parent<onap-policy-parent:master_index>`

:ref:`policy engine<onap-policy-engine:master_index>`

Portal Platform
---------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`portal<onap-portal:master_index>`

Service Design & Creation
-------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`sdc<onap-sdc:master_index>`

Service Orchestration
---------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`so<onap-so:master_index>`

:ref:`so libs<onap-so-libs:master_index>`

Software Defined Network Controller
-----------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`sdnc oam<onap-sdnc-oam:master_index>`

Software Defined Network Controller for Radio (SDN-R)
-----------------------------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`ccsdk features<onap-ccsdk-features:master_index>`

Use Case User Interface
-----------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`usecase-ui<onap-usecase-ui:master_index>`

Virtual Function Controller
---------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`vfc nfvo lcm<onap-vfc-nfvo-lcm:master_index>`

Virtual Infrastructure Deployment
---------------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:


:ref:`vid<onap-vid:master_index>`

VNF Software Development Kit
----------------------------

.. toctree::
   :maxdepth: 2
   :titlesonly:

:ref:`vnfsdk model<onap-vnfsdk-model:master_index>`