Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 8787afd724f24201b1e21ad0b8839c8189e51364 / . / docs / guides / onap-developer / developing / index.rst
blob: fff8ce6287b7e948d204d27bf15d4957ca172e00 [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===================================
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]12Here you will find the detailed documentation of projects,
13ONAP components and functionalities
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]14
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]15Project - ONAP Integration
16--------------------------
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]17
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]18.. list-table::
19 :widths: 20 80
20 :header-rows: 1
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]21
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]22 * - Document
23 - Description
24 * - :ref:`Integration<onap-integration:master_index>`
25 - ONAP Integration Project Documentation
26
27Project - ONAP Modeling
28-----------------------
29
30.. list-table::
31 :widths: 20 80
32 :header-rows: 1
33
34 * - Document
35 - Description
36 * - :ref:`Model<onap-modeling-modelspec:master_index>`
37 - ONAP Model Specification
38 * - :ref:`ETSI Catalog<onap-modeling-etsicatalog:master_index>`
39 - ONAP ETSI Runtime Catalog Documentation
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]40
41
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]42AAF - Application Authorization Framework
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]43-----------------------------------------
44
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]45.. list-table::
46 :widths: 20 80
47 :header-rows: 1
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]48
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]49 * - Document
50 - Description
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]51 * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]52 - AAF Architecture, APIs and Guides
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]53
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]54AAI - Active and Available Inventory
55------------------------------------
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]56
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]57.. list-table::
58 :widths: 20 80
59 :header-rows: 1
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]60
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]61 * - Document
62 - Description
63 * - :ref:`AAI<onap-aai-aai-common:master_index>`
64 - AAI Architecture, APIs and Guides
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]65 * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_
andreasgeissler392f7112020-11-20 09:43:54 +0100[diff] [blame]66 - External System Registry GUI Documentation
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]67 * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
andreasgeissler392f7112020-11-20 09:43:54 +0100[diff] [blame]68 - External System Registry Server Documentation
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]69 * - (in Maintenance) :ref:`Model<onap-aai-sparky-be:master_index>`
andreasgeissler392f7112020-11-20 09:43:54 +0100[diff] [blame]70 - Sparky - AAI Inventory UI Documentation
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]71
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]72APPC - Application Controller
73-----------------------------
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]74
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]75.. list-table::
76 :widths: 20 80
77 :header-rows: 1
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]78
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]79 * - Document
80 - Description
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]81 * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]82 - APPC Architecture, APIs and Guides
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]83 * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]84 - APPC Deployment Documentation
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]85
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]86CCSDK - Common Controller Software Development Kit
87--------------------------------------------------
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]88
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]89.. list-table::
90 :widths: 20 80
91 :header-rows: 1
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]92
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]93 * - Document
94 - Description
95 * - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
96 - TOSCA Orchestration Plugin, Directed Graph Support
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]97
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]98CDS - Controller Design Studio
99------------------------------
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]100
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]101.. list-table::
102 :widths: 20 80
103 :header-rows: 1
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]104
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]105 * - Document
106 - Description
107 * - :ref:`CDS<onap-ccsdk-cds:master_index>`
108 - Controller Design Studio Architecture and Guides (part of CCSDK)
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]109
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]110CLAMP - Control Loop Automation Management Platform
111---------------------------------------------------
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]112
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]113.. list-table::
114 :widths: 20 80
115 :header-rows: 1
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]116
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]117 * - Document
118 - Description
119 * - :ref:`CLAMP <onap-clamp:master_index>`
120 - CLAMP Architecture and Guides
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]121
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]122CLI - Command Line Interface
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]123----------------------------
124
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]125.. list-table::
126 :widths: 20 80
127 :header-rows: 1
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]128
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]129 * - Document
130 - Description
131 * - :ref:`CLI <onap-cli:master_index>`
132 - CLI Documentation
133
134DCAE - Data Collection, Analysis and Events
135-------------------------------------------
136
137.. list-table::
138 :widths: 20 80
139 :header-rows: 1
140
141 * - Document
142 - Description
143 * - :ref:`DCAE<onap-dcaegen2:master_index>`
144 - DCAE Architecture and Guides
145
146DMAAP - Data Management as a Platform
147-------------------------------------
148
149.. list-table::
150 :widths: 20 80
151 :header-rows: 1
152
153 * - Document
154 - Description
155 * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>`
156 - Bus Controller Documentation
157 * - :ref:`Bus Controller API<onap-dmaap-dbcapi:master_index>`
158 - Bus Controller API Documentation
159 * - :ref:`Data Router<onap-dmaap-datarouter:master_index>`
160 - Data Router Documentation
161 * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>`
162 - Message Router Documentation
163
164EXTAPI - External API Framework/NBI
165-----------------------------------
166
167.. list-table::
168 :widths: 20 80
169 :header-rows: 1
170
171 * - Document
172 - Description
173 * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
174 - External API Framework Documentation
175
176HOLMES - Holmes Alarm Correlation and Analysis
177----------------------------------------------
178
179.. list-table::
180 :widths: 20 80
181 :header-rows: 1
182
183 * - Document
184 - Description
185 * - :ref:`HOLMES<onap-holmes-rule-management:master_index>`
186 - HOLMES Architecture and APIs
187 * - :ref:`Engine Management<onap-holmes-engine-management:master_index>`
188 - HOLMES Engine Management Documentation
189
190LOGGING - Centralized Logging
191-----------------------------
192
193.. list-table::
194 :widths: 20 80
195 :header-rows: 1
196
197 * - Document
198 - Description
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]199 * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
andreasgeissler392f7112020-11-20 09:43:54 +0100[diff] [blame]200 - ONAP Centralized Logging Documentation
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]201
202MSB - Microservices Bus
203-----------------------
204
205.. list-table::
206 :widths: 20 80
207 :header-rows: 1
208
209 * - Document
210 - Description
211 * - :ref:`MSB<onap-msb-apigateway:master_index>`
212 - Microservices Bus Documentation
213
214MULTICLOUD - MultiCloud Framework
215---------------------------------
216
217.. list-table::
218 :widths: 20 80
219 :header-rows: 1
220
221 * - Document
222 - Description
223 * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
224 - MultiCloud Framework Architecture and Guides
225
226MUSIC - ONAP Multi-Site Integration
227-----------------------------------
228
229.. list-table::
230 :widths: 20 80
231 :header-rows: 1
232
233 * - Document
234 - Description
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]235 * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_
andreasgeissler392f7112020-11-20 09:43:54 +0100[diff] [blame]236 - MUSIC Architecture and Guides
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]237 * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_
andreasgeissler392f7112020-11-20 09:43:54 +0100[diff] [blame]238 - MUSIC Distribute KV Store Documents
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]239
240OOF - Optimization Framework
241----------------------------
242
243.. list-table::
244 :widths: 20 80
245 :header-rows: 1
246
247 * - Document
248 - Description
249 * - :ref:`Homing and Allocation<onap-optf-has:master_index>`
250 - ONAP policy-driven placement optimizing service documentation
251 * - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>`
252 - Optimization Service Design Framework documentation
253 * - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>`
254 - Change Management Schedule Optimization documentation
255
256OOM - ONAP Operations Manager
257-----------------------------
258
259.. list-table::
260 :widths: 20 80
261 :header-rows: 1
262
263 * - Document
264 - Description
265 * - :ref:`OOM<onap-oom:master_index>`
266 - ONAP Operations Manager Documentation
267 * - :ref:`OOM Certification Service<onap-oom-certservice:master_index>`
268 - ONAP CMPv2 certification support
269
270ORAN - Open-RAN Support in ONAP
271-------------------------------
272
273.. list-table::
274 :widths: 20 80
275 :header-rows: 1
276
277 * - Document
278 - Description
279 * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
280 - O-RAN Support in ONAP (part of CCSDK)
281
282POLICY - Policy Framework
283-------------------------
284
285.. list-table::
286 :widths: 20 80
287 :header-rows: 1
288
289 * - Document
290 - Description
291 * - :ref:`Policy<onap-policy-parent:master_index>`
292 - Policy Framework Documentation
293
294PORTAL - Portal Platform
295------------------------
296
297.. list-table::
298 :widths: 20 80
299 :header-rows: 1
300
301 * - Document
302 - Description
303 * - :ref:`Portal<onap-portal:master_index>`
304 - ONAP Portal Platform Documentation
305
306SDC - Service Design & Creation
307-------------------------------
308
309.. list-table::
310 :widths: 20 80
311 :header-rows: 1
312
313 * - Document
314 - Description
315 * - :ref:`SDC<onap-sdc:master_index>`
316 - Service Design & Creation Documentation
317
318SDNC - Software Defined Network Controller
319------------------------------------------
320
321.. list-table::
322 :widths: 20 80
323 :header-rows: 1
324
325 * - Document
326 - Description
327 * - :ref:`SDCN<onap-sdnc-oam:master_index>`
328 - SDNC Architecture, APIs and Guides
329
330SDNR - Software Defined Network Controller for Radio
331----------------------------------------------------
332
333.. list-table::
334 :widths: 20 80
335 :header-rows: 1
336
337 * - Document
338 - Description
339 * - :ref:`SDNR<onap-ccsdk-features:master_index>`
340 - SDN-R Documentation (part of CCSDK)
341
342SO - Service Orchestration
343--------------------------
344
345.. list-table::
346 :widths: 20 80
347 :header-rows: 1
348
349 * - Document
350 - Description
351 * - :ref:`SO<onap-so:master_index>`
352 - Service Orchestration Architecture, APIs and Guides
andreasgeissler8787afd2020-11-23 14:28:48 +0100[diff] [blame^]353 * - :ref:`SO Libraries<onap-so-libs:master_index>`
354 - ONAP SO/libs Documentation
andreasgeissler23fdddd2020-10-16 12:48:32 +0200[diff] [blame]355
356UUI - Use Case User Interface
357-----------------------------
358
359.. list-table::
360 :widths: 20 80
361 :header-rows: 1
362
363 * - Document
364 - Description
365 * - :ref:`UUI<onap-usecase-ui:master_index>`
366 - Usecase-UI Architecture, APIs and Guides
367
368VFC - Virtual Function Controller
369---------------------------------
370
371.. list-table::
372 :widths: 20 80
373 :header-rows: 1
374
375 * - Document
376 - Description
377 * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
378 - Virtual Function Controller Architecture, APIs and Guides
379
380VID - Virtual Infrastructure Deployment
381---------------------------------------
382
383.. list-table::
384 :widths: 20 80
385 :header-rows: 1
386
387 * - Document
388 - Description
389 * - :ref:`VID<onap-vid:master_index>`
390 - Virtual Infrastructure Deployment Architecture, APIs and Guides
391
392VNFSDK - VNF Software Development Kit
393-------------------------------------
394
395.. list-table::
396 :widths: 20 80
397 :header-rows: 1
398
399 * - Document
400 - Description
401 * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
402 - VNF SDK Documentation and User Guides
403
404VVP - VNF Validation Platform
405-----------------------------
406
407.. list-table::
408 :widths: 20 80
409 :header-rows: 1
410
411 * - Document
412 - Description
413 * - :ref:`VVP<onap-vvp-documentation:master_index>`
414 - VNF Validation Platform Documentation