docs/guides/onap-developer/developing/index.rst

   1 .. This work is licensed under a Creative Commons Attribution
   2 .. 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   5
   6 .. index:: Developer Guides
   7
   8 .. _doc_onap-developer_guide_projects:
   9
  10 ONAP components and functionalities
  11 ===================================
  12 Here you will find the detailed documentation of projects,
  13 ONAP components and functionalities
  14
  15 Project - ONAP Integration
  16 --------------------------
  17
  18 .. list-table::
  19    :widths: 20 80
  20    :header-rows: 1
  21
  22    * - Document
  23      - Description
  24    * - :ref:`Integration<onap-integration:master_index>`
  25      - ONAP Integration Project Documentation
  26
  27 Project - 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
  40
  41
  42 AAF - Application Authorization Framework
  43 -----------------------------------------
  44
  45 .. list-table::
  46    :widths: 20 80
  47    :header-rows: 1
  48
  49    * - Document
  50      - Description
  51 <<<<<<< HEAD   (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
  52    * - :ref:`AAF<onap-aaf-authz:master_index>`
  53 =======
  54    * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_
  55 >>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
  56      - AAF Architecture, APIs and Guides
  57 <<<<<<< HEAD   (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
  58    * - :ref:`Secret Management Service<onap-aaf-sms:master_index>`
  59      - Secret Management Service Architecture and API
  60 =======
  61 >>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
  62
  63 AAI - Active and Available Inventory
  64 ------------------------------------
  65
  66 .. list-table::
  67    :widths: 20 80
  68    :header-rows: 1
  69
  70    * - Document
  71      - Description
  72    * - :ref:`AAI<onap-aai-aai-common:master_index>`
  73      - AAI Architecture, APIs and Guides
  74 <<<<<<< HEAD   (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
  75    * - :ref:`ESR<onap-aai-esr-gui:master_index>`
  76      - External System Registry GUI Documentation (to be removed ?)
  77    * - :ref:`ESR<onap-aai-esr-server:master_index>`
  78      - External System Registry Server Documentation (to be removed ?)
  79    * - :ref:`AAI Inventory UI<onap-aai-sparky-be:master_index>`
  80      - Sparky - AAI Inventory UI Documentation (to be removed ?)
  81    * - :ref:`AAI Event Client<onap-aai-event-client:master_index>`
  82      - AAI Event Client Documentation (to be removed ?)
  83 =======
  84    * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_
  85      - External System Registry GUI Documentation
  86    * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
  87      - External System Registry Server Documentation
  88    * - (in Maintenance) :ref:`Model<onap-aai-sparky-be:master_index>`
  89      - Sparky - AAI Inventory UI Documentation
  90 >>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
  91
  92 APPC - Application Controller
  93 -----------------------------
  94
  95 .. list-table::
  96    :widths: 20 80
  97    :header-rows: 1
  98
  99    * - Document
 100      - Description
 101 <<<<<<< HEAD   (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
 102    * - :ref:`APPC<onap-appc:master_index>`
 103 =======
 104    * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_
 105 >>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
 106      - APPC Architecture, APIs and Guides
 107 <<<<<<< HEAD   (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
 108    * - :ref:`APPC Deployment<onap-appc-deployment:master_index>`
 109 =======
 110    * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_
 111 >>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
 112      - APPC Deployment Documentation
 113
 114 CCSDK - Common Controller Software Development Kit
 115 --------------------------------------------------
 116
 117 .. list-table::
 118    :widths: 20 80
 119    :header-rows: 1
 120
 121    * - Document
 122      - Description
 123    * - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
 124      - TOSCA Orchestration Plugin, Directed Graph Support
 125    * - :ref:`Dashboard<onap-ccsdk-dashboard:master_index>`
 126      - Common Controller Dashboard (To be removed ?)
 127    * - :ref:`Platform Plugins<onap-ccsdk-platform-plugins:master_index>`
 128      - Platform Plugins (To be removed ?)
 129    * - :ref:`APPS<onap-ccsdk-apps:master_index>`
 130      - Apps optside ODL (To be removed ?)
 131
 132 CDS - Controller Design Studio
 133 ------------------------------
 134
 135 .. list-table::
 136    :widths: 20 80
 137    :header-rows: 1
 138
 139    * - Document
 140      - Description
 141    * - :ref:`CDS<onap-ccsdk-cds:master_index>`
 142      - Controller Design Studio Architecture and Guides (part of CCSDK)
 143
 144 CLAMP - Control Loop Automation Management Platform
 145 ---------------------------------------------------
 146
 147 .. list-table::
 148    :widths: 20 80
 149    :header-rows: 1
 150
 151    * - Document
 152      - Description
 153    * - :ref:`CLAMP <onap-clamp:master_index>`
 154      - CLAMP Architecture and Guides
 155
 156 CLI - Command Line Interface
 157 ----------------------------
 158
 159 .. list-table::
 160    :widths: 20 80
 161    :header-rows: 1
 162
 163    * - Document
 164      - Description
 165    * - :ref:`CLI <onap-cli:master_index>`
 166      - CLI Documentation
 167
 168 DCAE - Data Collection, Analysis and Events
 169 -------------------------------------------
 170
 171 .. list-table::
 172    :widths: 20 80
 173    :header-rows: 1
 174
 175    * - Document
 176      - Description
 177    * - :ref:`DCAE<onap-dcaegen2:master_index>`
 178      - DCAE Architecture and Guides
 179
 180 DMAAP - Data Management as a Platform
 181 -------------------------------------
 182
 183 .. list-table::
 184    :widths: 20 80
 185    :header-rows: 1
 186
 187    * - Document
 188      - Description
 189    * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>`
 190      - Bus Controller Documentation
 191    * - :ref:`Bus Controller API<onap-dmaap-dbcapi:master_index>`
 192      - Bus Controller API Documentation
 193    * - :ref:`Data Router<onap-dmaap-datarouter:master_index>`
 194      - Data Router Documentation
 195    * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>`
 196      - Message Router Documentation
 197
 198 EXTAPI - External API Framework/NBI
 199 -----------------------------------
 200
 201 .. list-table::
 202    :widths: 20 80
 203    :header-rows: 1
 204
 205    * - Document
 206      - Description
 207    * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
 208      - External API Framework Documentation
 209
 210 HOLMES - Holmes Alarm Correlation and Analysis
 211 ----------------------------------------------
 212
 213 .. list-table::
 214    :widths: 20 80
 215    :header-rows: 1
 216
 217    * - Document
 218      - Description
 219    * - :ref:`HOLMES<onap-holmes-rule-management:master_index>`
 220      - HOLMES Architecture and APIs
 221    * - :ref:`Engine Management<onap-holmes-engine-management:master_index>`
 222      - HOLMES Engine Management Documentation
 223
 224 LOGGING - Centralized Logging
 225 -----------------------------
 226
 227 .. list-table::
 228    :widths: 20 80
 229    :header-rows: 1
 230
 231    * - Document
 232      - Description
 233 <<<<<<< HEAD   (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
 234    * - :ref:`Logging<onap-logging-analytics:master_index>`
 235      - ONAP Centralized Logging Documentation (to be deleted ?)
 236 =======
 237    * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
 238      - ONAP Centralized Logging Documentation
 239 >>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
 240
 241 MSB - Microservices Bus
 242 -----------------------
 243
 244 .. list-table::
 245    :widths: 20 80
 246    :header-rows: 1
 247
 248    * - Document
 249      - Description
 250    * - :ref:`MSB<onap-msb-apigateway:master_index>`
 251      - Microservices Bus Documentation
 252
 253 MULTICLOUD - MultiCloud Framework
 254 ---------------------------------
 255
 256 .. list-table::
 257    :widths: 20 80
 258    :header-rows: 1
 259
 260    * - Document
 261      - Description
 262    * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
 263      - MultiCloud Framework Architecture and Guides
 264
 265 MUSIC - ONAP Multi-Site Integration
 266 -----------------------------------
 267
 268 .. list-table::
 269    :widths: 20 80
 270    :header-rows: 1
 271
 272    * - Document
 273      - Description
 274 <<<<<<< HEAD   (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
 275    * - :ref:`MUSIC<onap-music:master_index>`
 276      - MUSIC Architecture and Guides (To be deleted ?)
 277    * - :ref:`Distributed KV Store<onap-music:master_index>`
 278      - MUSIC Distribute KV Store Documents (To be deleted ?)
 279 =======
 280    * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_
 281      - MUSIC Architecture and Guides
 282    * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_
 283      - MUSIC Distribute KV Store Documents
 284 >>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
 285
 286 OOF - Optimization Framework
 287 ----------------------------
 288
 289 .. list-table::
 290    :widths: 20 80
 291    :header-rows: 1
 292
 293    * - Document
 294      - Description
 295    * - :ref:`Homing and Allocation<onap-optf-has:master_index>`
 296      - ONAP policy-driven placement optimizing service documentation
 297    * - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>`
 298      - Optimization Service Design Framework documentation
 299    * - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>`
 300      - Change Management Schedule Optimization documentation
 301
 302 OOM - ONAP Operations Manager
 303 -----------------------------
 304
 305 .. list-table::
 306    :widths: 20 80
 307    :header-rows: 1
 308
 309    * - Document
 310      - Description
 311    * - :ref:`OOM<onap-oom:master_index>`
 312      - ONAP Operations Manager Documentation
 313    * - :ref:`OOM Certification Service<onap-oom-certservice:master_index>`
 314      - ONAP CMPv2 certification support
 315
 316 ORAN - Open-RAN Support in ONAP
 317 -------------------------------
 318
 319 .. list-table::
 320    :widths: 20 80
 321    :header-rows: 1
 322
 323    * - Document
 324      - Description
 325    * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
 326      - O-RAN Support in ONAP (part of CCSDK)
 327
 328 POLICY - Policy Framework
 329 -------------------------
 330
 331 .. list-table::
 332    :widths: 20 80
 333    :header-rows: 1
 334
 335    * - Document
 336      - Description
 337    * - :ref:`Policy<onap-policy-parent:master_index>`
 338      - Policy Framework Documentation
 339
 340 PORTAL - Portal Platform
 341 ------------------------
 342
 343 .. list-table::
 344    :widths: 20 80
 345    :header-rows: 1
 346
 347    * - Document
 348      - Description
 349    * - :ref:`Portal<onap-portal:master_index>`
 350      - ONAP Portal Platform Documentation
 351
 352 SDC - Service Design & Creation
 353 -------------------------------
 354
 355 .. list-table::
 356    :widths: 20 80
 357    :header-rows: 1
 358
 359    * - Document
 360      - Description
 361    * - :ref:`SDC<onap-sdc:master_index>`
 362      - Service Design & Creation Documentation
 363
 364 SDNC - Software Defined Network Controller
 365 ------------------------------------------
 366
 367 .. list-table::
 368    :widths: 20 80
 369    :header-rows: 1
 370
 371    * - Document
 372      - Description
 373    * - :ref:`SDCN<onap-sdnc-oam:master_index>`
 374      - SDNC Architecture, APIs and Guides
 375
 376 SDNR - Software Defined Network Controller for Radio
 377 ----------------------------------------------------
 378
 379 .. list-table::
 380    :widths: 20 80
 381    :header-rows: 1
 382
 383    * - Document
 384      - Description
 385    * - :ref:`SDNR<onap-ccsdk-features:master_index>`
 386      - SDN-R Documentation (part of CCSDK)
 387
 388 SO - Service Orchestration
 389 --------------------------
 390
 391 .. list-table::
 392    :widths: 20 80
 393    :header-rows: 1
 394
 395    * - Document
 396      - Description
 397    * - :ref:`SO<onap-so:master_index>`
 398      - Service Orchestration Architecture, APIs and Guides
 399    * - :ref:`SO Libraries<onap-so-libs:master_index>`
 400 <<<<<<< HEAD   (2d25f5 Merge "Update release notes list to Guilin release Update Mu)
 401      - Service Orchestration Build (To be deleted ?)
 402 =======
 403      - ONAP SO/libs Documentation
 404 >>>>>>> CHANGE (8787af Added links to older release docs for maintained components)
 405
 406 UUI - Use Case User Interface
 407 -----------------------------
 408
 409 .. list-table::
 410    :widths: 20 80
 411    :header-rows: 1
 412
 413    * - Document
 414      - Description
 415    * - :ref:`UUI<onap-usecase-ui:master_index>`
 416      - Usecase-UI Architecture, APIs and Guides
 417
 418 VFC - Virtual Function Controller
 419 ---------------------------------
 420
 421 .. list-table::
 422    :widths: 20 80
 423    :header-rows: 1
 424
 425    * - Document
 426      - Description
 427    * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
 428      - Virtual Function Controller Architecture, APIs and Guides
 429
 430 VID - Virtual Infrastructure Deployment
 431 ---------------------------------------
 432
 433 .. list-table::
 434    :widths: 20 80
 435    :header-rows: 1
 436
 437    * - Document
 438      - Description
 439    * - :ref:`VID<onap-vid:master_index>`
 440      - Virtual Infrastructure Deployment Architecture, APIs and Guides
 441
 442 VNFSDK - VNF Software Development Kit
 443 -------------------------------------
 444
 445 .. list-table::
 446    :widths: 20 80
 447    :header-rows: 1
 448
 449    * - Document
 450      - Description
 451    * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
 452      - VNF SDK Documentation and User Guides
 453
 454 VVP - VNF Validation Platform
 455 -----------------------------
 456
 457 .. list-table::
 458    :widths: 20 80
 459    :header-rows: 1
 460
 461    * - Document
 462      - Description
 463    * - :ref:`VVP<onap-vvp-documentation:master_index>`
 464      - VNF Validation Platform Documentation