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 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-policy-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 CPS - Configuration Persistence Service
 135 ---------------------------------------
 136
 137 .. list-table::
 138    :widths: 20 80
 139    :header-rows: 1
 140
 141    * - Document
 142      - Description
 143    * - :ref:`CPS<onap-cps:master_index>`
 144      - CPS Global Documentation
 145    * - :ref:`CPS DMI Plugin<onap-cps-ncmp-dmi-plugin:master_index>`
 146      - DMI Plugin Documentation
 147    * - :ref:`CPS Temporal<onap-cps-cps-temporal:master_index>`
 148      - Temporal Documentation
 149
 150 DCAE - Data Collection, Analysis and Events
 151 -------------------------------------------
 152
 153 .. list-table::
 154    :widths: 20 80
 155    :header-rows: 1
 156
 157    * - Document
 158      - Description
 159    * - :ref:`DCAE<onap-dcaegen2:master_index>`
 160      - DCAE Architecture and Guides
 161
 162 DMAAP - Data Movement as a Platform
 163 -----------------------------------
 164
 165 .. list-table::
 166    :widths: 20 80
 167    :header-rows: 1
 168
 169    * - Document
 170      - Description
 171    * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>`
 172      - Bus Controller Documentation
 173    * - :ref:`Data Router<onap-dmaap-datarouter:master_index>`
 174      - Data Router Documentation
 175    * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>`
 176      - Message Router Documentation
 177
 178 EXTAPI - External API Framework/NBI
 179 -----------------------------------
 180
 181 .. list-table::
 182    :widths: 20 80
 183    :header-rows: 1
 184
 185    * - Document
 186      - Description
 187    * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
 188      - External API Framework Documentation
 189
 190 HOLMES - Holmes Alarm Correlation and Analysis
 191 ----------------------------------------------
 192
 193 .. list-table::
 194    :widths: 20 80
 195    :header-rows: 1
 196
 197    * - Document
 198      - Description
 199    * - :ref:`HOLMES<onap-holmes-rule-management:master_index>`
 200      - HOLMES Architecture and APIs
 201    * - :ref:`Engine Management<onap-holmes-engine-management:master_index>`
 202      - HOLMES Engine Management Documentation
 203
 204 LOGGING - Centralized Logging
 205 -----------------------------
 206
 207 .. list-table::
 208    :widths: 20 80
 209    :header-rows: 1
 210
 211    * - Document
 212      - Description
 213    * - :ref:`LOGGING (Latest)<onap-logging-analytics:master_index>`
 214      - (unmaintained) ONAP Centralized Logging Documentation
 215
 216 MSB - Microservices Bus
 217 -----------------------
 218
 219 .. list-table::
 220    :widths: 20 80
 221    :header-rows: 1
 222
 223    * - Document
 224      - Description
 225    * - :ref:`MSB<onap-msb-apigateway:master_index>`
 226      - Microservices Bus Documentation
 227
 228 MULTICLOUD - MultiCloud Framework
 229 ---------------------------------
 230
 231 .. list-table::
 232    :widths: 20 80
 233    :header-rows: 1
 234
 235    * - Document
 236      - Description
 237    * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
 238      - MultiCloud Framework Architecture and Guides
 239
 240 MUSIC - ONAP Multi-Site Integration
 241 -----------------------------------
 242
 243 .. list-table::
 244    :widths: 20 80
 245    :header-rows: 1
 246
 247    * - Document
 248      - Description
 249    * - :ref:`MUSIC (Frankfurt)<onap-music:master_index>`
 250      - (unmaintained) MUSIC Architecture and Guides
 251    * - :ref:`MUSIC KV (Latest)<onap-music-distributed-kv-store:master_index>`
 252      - (unmaintained) MUSIC Distribute KV Store Documents
 253
 254 OOF - Optimization Framework
 255 ----------------------------
 256
 257 .. list-table::
 258    :widths: 20 80
 259    :header-rows: 1
 260
 261    * - Document
 262      - Description
 263    * - :ref:`Homing and Allocation<onap-optf-has:master_index>`
 264      - ONAP policy-driven placement optimizing service documentation
 265    * - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>`
 266      - Optimization Service Design Framework documentation
 267    * - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>`
 268      - Change Management Schedule Optimization documentation
 269
 270 OOM - ONAP Operations Manager
 271 -----------------------------
 272
 273 .. list-table::
 274    :widths: 20 80
 275    :header-rows: 1
 276
 277    * - Document
 278      - Description
 279    * - :ref:`OOM<onap-oom:master_index>`
 280      - ONAP Operations Manager Documentation
 281    * - :ref:`OOM Certification Service<onap-oom-platform-cert-service:master_index>`
 282      - ONAP CMPv2 certification support
 283    * - :ref:`OOM Offline Installer<onap-oom-offline-installer:master_index>`
 284      - OOM Offline Installer
 285
 286
 287 ORAN - Open-RAN Support in ONAP
 288 -------------------------------
 289
 290 .. list-table::
 291    :widths: 20 80
 292    :header-rows: 1
 293
 294    * - Document
 295      - Description
 296    * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
 297      - O-RAN Support in ONAP (part of CCSDK)
 298
 299 POLICY - Policy Framework
 300 -------------------------
 301
 302 .. list-table::
 303    :widths: 20 80
 304    :header-rows: 1
 305
 306    * - Document
 307      - Description
 308    * - :ref:`Policy<onap-policy-parent:master_index>`
 309      - Policy Framework Documentation
 310
 311 PORTAL - Portal Platform
 312 ------------------------
 313
 314 .. list-table::
 315    :widths: 20 80
 316    :header-rows: 1
 317
 318    * - Document
 319      - Description
 320    * - :ref:`Portal (Guilin)<onap-portal:master_index>`
 321      - (unmaintained) ONAP Portal Platform Documentation
 322
 323 SDC - Service Design & Creation
 324 -------------------------------
 325
 326 .. list-table::
 327    :widths: 20 80
 328    :header-rows: 1
 329
 330    * - Document
 331      - Description
 332    * - :ref:`SDC<onap-sdc:master_index>`
 333      - Service Design & Creation Documentation
 334
 335 SDNC - Software Defined Network Controller
 336 ------------------------------------------
 337
 338 .. list-table::
 339    :widths: 20 80
 340    :header-rows: 1
 341
 342    * - Document
 343      - Description
 344    * - :ref:`SDNC<onap-sdnc-oam:master_index>`
 345      - SDNC Architecture, APIs and Guides
 346
 347 SDNR - Software Defined Network Controller for Radio
 348 ----------------------------------------------------
 349
 350 .. list-table::
 351    :widths: 20 80
 352    :header-rows: 1
 353
 354    * - Document
 355      - Description
 356    * - :ref:`SDN-R<onap-ccsdk-features:master_index>`
 357      - SDN-R Documentation (part of CCSDK)
 358
 359 SO - Service Orchestration
 360 --------------------------
 361
 362 .. list-table::
 363    :widths: 20 80
 364    :header-rows: 1
 365
 366    * - Document
 367      - Description
 368    * - :ref:`SO<onap-so:master_index>`
 369      - Service Orchestration Architecture, APIs and Guides
 370
 371 UUI - Use Case User Interface
 372 -----------------------------
 373
 374 .. list-table::
 375    :widths: 20 80
 376    :header-rows: 1
 377
 378    * - Document
 379      - Description
 380    * - :ref:`UUI<onap-usecase-ui:master_index>`
 381      - Usecase-UI Architecture, APIs and Guides
 382
 383 VFC - Virtual Function Controller
 384 ---------------------------------
 385
 386 .. list-table::
 387    :widths: 20 80
 388    :header-rows: 1
 389
 390    * - Document
 391      - Description
 392    * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
 393      - Virtual Function Controller Architecture, APIs and Guides
 394
 395 VID - Virtual Infrastructure Deployment
 396 ---------------------------------------
 397
 398 .. list-table::
 399    :widths: 20 80
 400    :header-rows: 1
 401
 402    * - Document
 403      - Description
 404    * - :ref:`VID<onap-vid:master_index>`
 405      - Virtual Infrastructure Deployment Architecture, APIs and Guides
 406
 407 VNFSDK - VNF Software Development Kit
 408 -------------------------------------
 409
 410 .. list-table::
 411    :widths: 20 80
 412    :header-rows: 1
 413
 414    * - Document
 415      - Description
 416    * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
 417      - VNF SDK Documentation and User Guides
 418
 419 VVP - VNF Validation Platform
 420 -----------------------------
 421
 422 .. list-table::
 423    :widths: 20 80
 424    :header-rows: 1
 425
 426    * - Document
 427      - Description
 428    * - :ref:`VVP<onap-vvp-documentation:master_index>`
 429      - VNF Validation Platform Documentation