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    * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_
  52      - AAF Architecture, APIs and Guides
  53
  54 AAI - Active and Available Inventory
  55 ------------------------------------
  56
  57 .. list-table::
  58    :widths: 20 80
  59    :header-rows: 1
  60
  61    * - Document
  62      - Description
  63    * - :ref:`AAI<onap-aai-aai-common:master_index>`
  64      - AAI Architecture, APIs and Guides
  65    * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_
  66      - External System Registry GUI Documentation
  67    * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
  68      - External System Registry Server Documentation
  69    * - (in Maintenance) :ref:`Model<onap-aai-sparky-be:master_index>`
  70      - Sparky - AAI Inventory UI Documentation
  71
  72 APPC - Application Controller
  73 -----------------------------
  74
  75 .. list-table::
  76    :widths: 20 80
  77    :header-rows: 1
  78
  79    * - Document
  80      - Description
  81    * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_
  82      - APPC Architecture, APIs and Guides
  83    * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_
  84      - APPC Deployment Documentation
  85
  86 CCSDK - Common Controller Software Development Kit
  87 --------------------------------------------------
  88
  89 .. list-table::
  90    :widths: 20 80
  91    :header-rows: 1
  92
  93    * - Document
  94      - Description
  95    * - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
  96      - TOSCA Orchestration Plugin, Directed Graph Support
  97
  98 CDS - Controller Design Studio
  99 ------------------------------
 100
 101 .. list-table::
 102    :widths: 20 80
 103    :header-rows: 1
 104
 105    * - Document
 106      - Description
 107    * - :ref:`CDS<onap-ccsdk-cds:master_index>`
 108      - Controller Design Studio Architecture and Guides (part of CCSDK)
 109
 110 CLAMP - Control Loop Automation Management Platform
 111 ---------------------------------------------------
 112
 113 .. list-table::
 114    :widths: 20 80
 115    :header-rows: 1
 116
 117    * - Document
 118      - Description
 119    * - :ref:`CLAMP <onap-clamp:master_index>`
 120      - CLAMP Architecture and Guides
 121
 122 CLI - Command Line Interface
 123 ----------------------------
 124
 125 .. list-table::
 126    :widths: 20 80
 127    :header-rows: 1
 128
 129    * - Document
 130      - Description
 131    * - :ref:`CLI <onap-cli:master_index>`
 132      - CLI Documentation
 133
 134 DCAE - 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
 146 DMAAP - 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
 164 EXTAPI - 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
 176 HOLMES - 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
 190 LOGGING - Centralized Logging
 191 -----------------------------
 192
 193 .. list-table::
 194    :widths: 20 80
 195    :header-rows: 1
 196
 197    * - Document
 198      - Description
 199    * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
 200      - ONAP Centralized Logging Documentation
 201
 202 MSB - 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
 214 MULTICLOUD - 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
 226 MUSIC - ONAP Multi-Site Integration
 227 -----------------------------------
 228
 229 .. list-table::
 230    :widths: 20 80
 231    :header-rows: 1
 232
 233    * - Document
 234      - Description
 235    * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_
 236      - MUSIC Architecture and Guides
 237    * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_
 238      - MUSIC Distribute KV Store Documents
 239
 240 OOF - 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
 256 OOM - 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
 270 ORAN - 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
 282 POLICY - 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
 294 PORTAL - 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
 306 SDC - 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
 318 SDNC - 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
 330 SDNR - 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
 342 SO - 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
 353    * - :ref:`SO Libraries<onap-so-libs:master_index>`
 354      - ONAP SO/libs Documentation
 355
 356 UUI - 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
 368 VFC - 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
 380 VID - 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
 392 VNFSDK - 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
 404 VVP - 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