blob: 2c250ec79d89568ff7debe46c57bee4743f1b13f (
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
|
.. 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
===================================
Here you will find the detailed documentation of projects,
ONAP components and functionalities
Project - ONAP Integration
--------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`Integration<onap-integration:master_index>`
- ONAP Integration Project Documentation
Project - ONAP Modeling
-----------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`Model<onap-modeling-modelspec:master_index>`
- ONAP Model Specification
* - :ref:`ETSI Catalog<onap-modeling-etsicatalog:master_index>`
- ONAP ETSI Runtime Catalog Documentation
AAF - Application Authorization Framework
-----------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
* - :ref:`AAF<onap-aaf-authz:master_index>`
=======
* - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
- AAF Architecture, APIs and Guides
<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
* - :ref:`Secret Management Service<onap-aaf-sms:master_index>`
- Secret Management Service Architecture and API
=======
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
AAI - Active and Available Inventory
------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`AAI<onap-aai-aai-common:master_index>`
- AAI Architecture, APIs and Guides
<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
* - :ref:`ESR<onap-aai-esr-gui:master_index>`
- External System Registry GUI Documentation (to be removed ?)
* - :ref:`ESR<onap-aai-esr-server:master_index>`
- External System Registry Server Documentation (to be removed ?)
* - :ref:`AAI Inventory UI<onap-aai-sparky-be:master_index>`
- Sparky - AAI Inventory UI Documentation (to be removed ?)
* - :ref:`AAI Event Client<onap-aai-event-client:master_index>`
- AAI Event Client Documentation (to be removed ?)
=======
* - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_
- External System Registry GUI Documentation
* - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
- External System Registry Server Documentation
* - (in Maintenance) :ref:`Model<onap-aai-sparky-be:master_index>`
- Sparky - AAI Inventory UI Documentation
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
APPC - Application Controller
-----------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
* - :ref:`APPC<onap-appc:master_index>`
=======
* - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
- APPC Architecture, APIs and Guides
<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
* - :ref:`APPC Deployment<onap-appc-deployment:master_index>`
=======
* - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
- APPC Deployment Documentation
CCSDK - Common Controller Software Development Kit
--------------------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
- TOSCA Orchestration Plugin, Directed Graph Support
* - :ref:`Dashboard<onap-ccsdk-dashboard:master_index>`
- Common Controller Dashboard (To be removed ?)
* - :ref:`Platform Plugins<onap-ccsdk-platform-plugins:master_index>`
- Platform Plugins (To be removed ?)
* - :ref:`APPS<onap-ccsdk-apps:master_index>`
- Apps optside ODL (To be removed ?)
CDS - Controller Design Studio
------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`CDS<onap-ccsdk-cds:master_index>`
- Controller Design Studio Architecture and Guides (part of CCSDK)
CLAMP - Control Loop Automation Management Platform
---------------------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`CLAMP <onap-clamp:master_index>`
- CLAMP Architecture and Guides
CLI - Command Line Interface
----------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`CLI <onap-cli:master_index>`
- CLI Documentation
DCAE - Data Collection, Analysis and Events
-------------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`DCAE<onap-dcaegen2:master_index>`
- DCAE Architecture and Guides
DMAAP - Data Management as a Platform
-------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>`
- Bus Controller Documentation
* - :ref:`Bus Controller API<onap-dmaap-dbcapi:master_index>`
- Bus Controller API Documentation
* - :ref:`Data Router<onap-dmaap-datarouter:master_index>`
- Data Router Documentation
* - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>`
- Message Router Documentation
EXTAPI - External API Framework/NBI
-----------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
- External API Framework Documentation
HOLMES - Holmes Alarm Correlation and Analysis
----------------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`HOLMES<onap-holmes-rule-management:master_index>`
- HOLMES Architecture and APIs
* - :ref:`Engine Management<onap-holmes-engine-management:master_index>`
- HOLMES Engine Management Documentation
LOGGING - Centralized Logging
-----------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
* - :ref:`Logging<onap-logging-analytics:master_index>`
- ONAP Centralized Logging Documentation (to be deleted ?)
=======
* - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
- ONAP Centralized Logging Documentation
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
MSB - Microservices Bus
-----------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`MSB<onap-msb-apigateway:master_index>`
- Microservices Bus Documentation
MULTICLOUD - MultiCloud Framework
---------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
- MultiCloud Framework Architecture and Guides
MUSIC - ONAP Multi-Site Integration
-----------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
* - :ref:`MUSIC<onap-music:master_index>`
- MUSIC Architecture and Guides (To be deleted ?)
* - :ref:`Distributed KV Store<onap-music:master_index>`
- MUSIC Distribute KV Store Documents (To be deleted ?)
=======
* - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_
- MUSIC Architecture and Guides
* - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_
- MUSIC Distribute KV Store Documents
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
OOF - Optimization Framework
----------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`Homing and Allocation<onap-optf-has:master_index>`
- ONAP policy-driven placement optimizing service documentation
* - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>`
- Optimization Service Design Framework documentation
* - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>`
- Change Management Schedule Optimization documentation
OOM - ONAP Operations Manager
-----------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`OOM<onap-oom:master_index>`
- ONAP Operations Manager Documentation
* - :ref:`OOM Certification Service<onap-oom-certservice:master_index>`
- ONAP CMPv2 certification support
ORAN - Open-RAN Support in ONAP
-------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`ORAN<onap-ccsdk-oran:master_index>`
- O-RAN Support in ONAP (part of CCSDK)
POLICY - Policy Framework
-------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`Policy<onap-policy-parent:master_index>`
- Policy Framework Documentation
PORTAL - Portal Platform
------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`Portal<onap-portal:master_index>`
- ONAP Portal Platform Documentation
SDC - Service Design & Creation
-------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`SDC<onap-sdc:master_index>`
- Service Design & Creation Documentation
SDNC - Software Defined Network Controller
------------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`SDCN<onap-sdnc-oam:master_index>`
- SDNC Architecture, APIs and Guides
SDNR - Software Defined Network Controller for Radio
----------------------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`SDNR<onap-ccsdk-features:master_index>`
- SDN-R Documentation (part of CCSDK)
SO - Service Orchestration
--------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`SO<onap-so:master_index>`
- Service Orchestration Architecture, APIs and Guides
* - :ref:`SO Libraries<onap-so-libs:master_index>`
<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
- Service Orchestration Build (To be deleted ?)
=======
- ONAP SO/libs Documentation
>>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
UUI - Use Case User Interface
-----------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`UUI<onap-usecase-ui:master_index>`
- Usecase-UI Architecture, APIs and Guides
VFC - Virtual Function Controller
---------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
- Virtual Function Controller Architecture, APIs and Guides
VID - Virtual Infrastructure Deployment
---------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`VID<onap-vid:master_index>`
- Virtual Infrastructure Deployment Architecture, APIs and Guides
VNFSDK - VNF Software Development Kit
-------------------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
- VNF SDK Documentation and User Guides
VVP - VNF Validation Platform
-----------------------------
.. list-table::
:widths: 20 80
:header-rows: 1
* - Document
- Description
* - :ref:`VVP<onap-vvp-documentation:master_index>`
- VNF Validation Platform Documentation
|
