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    * - :ref:`AAF (Latest)<onap-aaf-authz:master_index>`
  52      - (unmaintained) 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    * - :ref:`ESR GUI (Latest)<onap-aai-esr-gui:master_index>`
  66      - (unmaintained) External System Registry GUI Documentation
  67    * - :ref:`ESR Server (Latest)<onap-aai-esr-server:master_index>`
  68      - (unmaintained) External System Registry Server Documentation
  69    * - :ref:`AAI UI<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    * - :ref:`APPC (Frankfurt)<onap-appc:master_index>`
  82      - (unmaintained) APPC Architecture, APIs and Guides
  83    * - :ref:`APPC Deployment (Frankfurt)<onap-appc-deployment:master_index>`
  84      - (unmaintained) 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 CLI - Command Line Interface
 111 ----------------------------
 112
 113 .. list-table::
 114    :widths: 20 80
 115    :header-rows: 1
 116
 117    * - Document
 118      - Description
 119    * - :ref:`CLI <onap-cli:master_index>`
 120      - CLI Documentation
 121
 122 CPS - Configuration Persistence Service
 123 ---------------------------------------
 124
 125 .. list-table::
 126    :widths: 20 80
 127    :header-rows: 1
 128
 129    * - Document
 130      - Description
 131    * - :ref:`CPS<onap-cps:master_index>`
 132      - CPS Global Documentation
 133    * - :ref:`CPS DMI Plugin<onap-cps-ncmp-dmi-plugin:master_index>`
 134      - DMI Plugin Documentation
 135
 136 DCAE - Data Collection, Analysis and Events
 137 -------------------------------------------
 138
 139 .. list-table::
 140    :widths: 20 80
 141    :header-rows: 1
 142
 143    * - Document
 144      - Description
 145    * - :ref:`DCAE<onap-dcaegen2:master_index>`
 146      - DCAE Architecture and Guides
 147
 148 DMAAP - Data Movement as a Platform
 149 -----------------------------------
 150
 151 .. list-table::
 152    :widths: 20 80
 153    :header-rows: 1
 154
 155    * - Document
 156      - Description
 157    * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>`
 158      - Bus Controller 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    * - :ref:`LOGGING (Latest)<onap-logging-analytics:master_index>`
 200      - (unmaintained) 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    * - :ref:`MUSIC (Frankfurt)<onap-music:master_index>`
 236      - (unmaintained) MUSIC Architecture and Guides
 237    * - :ref:`MUSIC KV (Latest)<onap-music-distributed-kv-store:master_index>`
 238      - (unmaintained) 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-platform-cert-service:master_index>`
 268      - ONAP CMPv2 certification support
 269    * - :ref:`OOM Offline Installer<onap-oom-offline-installer:master_index>`
 270      - OOM Offline Installer
 271
 272
 273 ORAN - Open-RAN Support in ONAP
 274 -------------------------------
 275
 276 .. list-table::
 277    :widths: 20 80
 278    :header-rows: 1
 279
 280    * - Document
 281      - Description
 282    * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
 283      - O-RAN Support in ONAP (part of CCSDK)
 284
 285 POLICY - Policy Framework
 286 -------------------------
 287
 288 .. list-table::
 289    :widths: 20 80
 290    :header-rows: 1
 291
 292    * - Document
 293      - Description
 294    * - :ref:`Policy<onap-policy-parent:master_index>`
 295      - Policy Framework Documentation
 296
 297 PORTAL - Portal Platform
 298 ------------------------
 299
 300 .. list-table::
 301    :widths: 20 80
 302    :header-rows: 1
 303
 304    * - Document
 305      - Description
 306    * - :ref:`Portal (Guilin)<onap-portal:master_index>`
 307      - (unmaintained) ONAP Portal Platform Documentation
 308
 309 SDC - Service Design & Creation
 310 -------------------------------
 311
 312 .. list-table::
 313    :widths: 20 80
 314    :header-rows: 1
 315
 316    * - Document
 317      - Description
 318    * - :ref:`SDC<onap-sdc:master_index>`
 319      - Service Design & Creation Documentation
 320
 321 SDNC - Software Defined Network Controller
 322 ------------------------------------------
 323
 324 .. list-table::
 325    :widths: 20 80
 326    :header-rows: 1
 327
 328    * - Document
 329      - Description
 330    * - :ref:`SDNC<onap-sdnc-oam:master_index>`
 331      - SDNC Architecture, APIs and Guides
 332
 333 SDNR - Software Defined Network Controller for Radio
 334 ----------------------------------------------------
 335
 336 .. list-table::
 337    :widths: 20 80
 338    :header-rows: 1
 339
 340    * - Document
 341      - Description
 342    * - :ref:`SDN-R<onap-ccsdk-features:master_index>`
 343      - SDN-R Documentation (part of CCSDK)
 344
 345 SO - Service Orchestration
 346 --------------------------
 347
 348 .. list-table::
 349    :widths: 20 80
 350    :header-rows: 1
 351
 352    * - Document
 353      - Description
 354    * - :ref:`SO<onap-so:master_index>`
 355      - Service Orchestration Architecture, APIs and Guides
 356
 357 UUI - Use Case User Interface
 358 -----------------------------
 359
 360 .. list-table::
 361    :widths: 20 80
 362    :header-rows: 1
 363
 364    * - Document
 365      - Description
 366    * - :ref:`UUI<onap-usecase-ui:master_index>`
 367      - Usecase-UI Architecture, APIs and Guides
 368
 369 VFC - Virtual Function Controller
 370 ---------------------------------
 371
 372 .. list-table::
 373    :widths: 20 80
 374    :header-rows: 1
 375
 376    * - Document
 377      - Description
 378    * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
 379      - Virtual Function Controller Architecture, APIs and Guides
 380
 381 VID - Virtual Infrastructure Deployment
 382 ---------------------------------------
 383
 384 .. list-table::
 385    :widths: 20 80
 386    :header-rows: 1
 387
 388    * - Document
 389      - Description
 390    * - :ref:`VID<onap-vid:master_index>`
 391      - Virtual Infrastructure Deployment Architecture, APIs and Guides
 392
 393 VNFSDK - VNF Software Development Kit
 394 -------------------------------------
 395
 396 .. list-table::
 397    :widths: 20 80
 398    :header-rows: 1
 399
 400    * - Document
 401      - Description
 402    * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
 403      - VNF SDK Documentation and User Guides
 404
 405 VVP - VNF Validation Platform
 406 -----------------------------
 407
 408 .. list-table::
 409    :widths: 20 80
 410    :header-rows: 1
 411
 412    * - Document
 413      - Description
 414    * - :ref:`VVP<onap-vvp-documentation:master_index>`
 415      - VNF Validation Platform Documentation