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) Documentation can be found in previous ONAP releases
  52      - AAF Architecture, APIs and Guides
  53    * - (in Maintenance) Documentation can be found in previous ONAP releases
  54      - Secret Management Service Architecture and API
  55
  56 AAI - Active and Available Inventory
  57 ------------------------------------
  58
  59 .. list-table::
  60    :widths: 20 80
  61    :header-rows: 1
  62
  63    * - Document
  64      - Description
  65    * - :ref:`AAI<onap-aai-aai-common:master_index>`
  66      - AAI Architecture, APIs and Guides
  67    * - (in Maintenance) Documentation can be found in previous ONAP releases
  68      - External System Registry GUI Documentation
  69    * - (in Maintenance) Documentation can be found in previous ONAP releases
  70      - External System Registry Server Documentation
  71    * - (in Maintenance) Documentation can be found in previous ONAP releases
  72      - Sparky - AAI Inventory UI Documentation
  73
  74 APPC - Application Controller
  75 -----------------------------
  76
  77 .. list-table::
  78    :widths: 20 80
  79    :header-rows: 1
  80
  81    * - Document
  82      - Description
  83    * - (in Maintenance) Documentation can be found in previous ONAP releases
  84      - APPC Architecture, APIs and Guides
  85    * - (in Maintenance) Documentation can be found in previous ONAP releases
  86      - APPC Deployment Documentation
  87
  88 CCSDK - Common Controller Software Development Kit
  89 --------------------------------------------------
  90
  91 .. list-table::
  92    :widths: 20 80
  93    :header-rows: 1
  94
  95    * - Document
  96      - Description
  97    * - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
  98      - TOSCA Orchestration Plugin, Directed Graph Support
  99
 100 CDS - Controller Design Studio
 101 ------------------------------
 102
 103 .. list-table::
 104    :widths: 20 80
 105    :header-rows: 1
 106
 107    * - Document
 108      - Description
 109    * - :ref:`CDS<onap-ccsdk-cds:master_index>`
 110      - Controller Design Studio Architecture and Guides (part of CCSDK)
 111
 112 CLAMP - Control Loop Automation Management Platform
 113 ---------------------------------------------------
 114
 115 .. list-table::
 116    :widths: 20 80
 117    :header-rows: 1
 118
 119    * - Document
 120      - Description
 121    * - :ref:`CLAMP <onap-clamp:master_index>`
 122      - CLAMP Architecture and Guides
 123
 124 CLI - Command Line Interface
 125 ----------------------------
 126
 127 .. list-table::
 128    :widths: 20 80
 129    :header-rows: 1
 130
 131    * - Document
 132      - Description
 133    * - :ref:`CLI <onap-cli:master_index>`
 134      - CLI 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 Management 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:`Bus Controller API<onap-dmaap-dbcapi:master_index>`
 160      - Bus Controller API Documentation
 161    * - :ref:`Data Router<onap-dmaap-datarouter:master_index>`
 162      - Data Router Documentation
 163    * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>`
 164      - Message Router Documentation
 165
 166 EXTAPI - External API Framework/NBI
 167 -----------------------------------
 168
 169 .. list-table::
 170    :widths: 20 80
 171    :header-rows: 1
 172
 173    * - Document
 174      - Description
 175    * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
 176      - External API Framework Documentation
 177
 178 HOLMES - Holmes Alarm Correlation and Analysis
 179 ----------------------------------------------
 180
 181 .. list-table::
 182    :widths: 20 80
 183    :header-rows: 1
 184
 185    * - Document
 186      - Description
 187    * - :ref:`HOLMES<onap-holmes-rule-management:master_index>`
 188      - HOLMES Architecture and APIs
 189    * - :ref:`Engine Management<onap-holmes-engine-management:master_index>`
 190      - HOLMES Engine Management Documentation
 191
 192 LOGGING - Centralized Logging
 193 -----------------------------
 194
 195 .. list-table::
 196    :widths: 20 80
 197    :header-rows: 1
 198
 199    * - Document
 200      - Description
 201    * - (in Maintenance) Documentation can be found in previous ONAP releases
 202      - ONAP Centralized Logging Documentation
 203
 204 MSB - Microservices Bus
 205 -----------------------
 206
 207 .. list-table::
 208    :widths: 20 80
 209    :header-rows: 1
 210
 211    * - Document
 212      - Description
 213    * - :ref:`MSB<onap-msb-apigateway:master_index>`
 214      - Microservices Bus Documentation
 215
 216 MULTICLOUD - MultiCloud Framework
 217 ---------------------------------
 218
 219 .. list-table::
 220    :widths: 20 80
 221    :header-rows: 1
 222
 223    * - Document
 224      - Description
 225    * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
 226      - MultiCloud Framework Architecture and Guides
 227
 228 MUSIC - ONAP Multi-Site Integration
 229 -----------------------------------
 230
 231 .. list-table::
 232    :widths: 20 80
 233    :header-rows: 1
 234
 235    * - Document
 236      - Description
 237    * - (in Maintenance) Documentation can be found in previous ONAP releases
 238      - MUSIC Architecture and Guides
 239    * - (in Maintenance) Documentation can be found in previous ONAP releases
 240      - MUSIC Distribute KV Store Documents
 241
 242 OOF - Optimization Framework
 243 ----------------------------
 244
 245 .. list-table::
 246    :widths: 20 80
 247    :header-rows: 1
 248
 249    * - Document
 250      - Description
 251    * - :ref:`Homing and Allocation<onap-optf-has:master_index>`
 252      - ONAP policy-driven placement optimizing service documentation
 253    * - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>`
 254      - Optimization Service Design Framework documentation
 255    * - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>`
 256      - Change Management Schedule Optimization documentation
 257
 258 OOM - ONAP Operations Manager
 259 -----------------------------
 260
 261 .. list-table::
 262    :widths: 20 80
 263    :header-rows: 1
 264
 265    * - Document
 266      - Description
 267    * - :ref:`OOM<onap-oom:master_index>`
 268      - ONAP Operations Manager Documentation
 269    * - :ref:`OOM Certification Service<onap-oom-certservice:master_index>`
 270      - ONAP CMPv2 certification support
 271
 272 ORAN - Open-RAN Support in ONAP
 273 -------------------------------
 274
 275 .. list-table::
 276    :widths: 20 80
 277    :header-rows: 1
 278
 279    * - Document
 280      - Description
 281    * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
 282      - O-RAN Support in ONAP (part of CCSDK)
 283
 284 POLICY - Policy Framework
 285 -------------------------
 286
 287 .. list-table::
 288    :widths: 20 80
 289    :header-rows: 1
 290
 291    * - Document
 292      - Description
 293    * - :ref:`Policy<onap-policy-parent:master_index>`
 294      - Policy Framework Documentation
 295
 296 PORTAL - Portal Platform
 297 ------------------------
 298
 299 .. list-table::
 300    :widths: 20 80
 301    :header-rows: 1
 302
 303    * - Document
 304      - Description
 305    * - :ref:`Portal<onap-portal:master_index>`
 306      - ONAP Portal Platform Documentation
 307
 308 SDC - Service Design & Creation
 309 -------------------------------
 310
 311 .. list-table::
 312    :widths: 20 80
 313    :header-rows: 1
 314
 315    * - Document
 316      - Description
 317    * - :ref:`SDC<onap-sdc:master_index>`
 318      - Service Design & Creation Documentation
 319
 320 SDNC - Software Defined Network Controller
 321 ------------------------------------------
 322
 323 .. list-table::
 324    :widths: 20 80
 325    :header-rows: 1
 326
 327    * - Document
 328      - Description
 329    * - :ref:`SDCN<onap-sdnc-oam:master_index>`
 330      - SDNC Architecture, APIs and Guides
 331
 332 SDNR - Software Defined Network Controller for Radio
 333 ----------------------------------------------------
 334
 335 .. list-table::
 336    :widths: 20 80
 337    :header-rows: 1
 338
 339    * - Document
 340      - Description
 341    * - :ref:`SDNR<onap-ccsdk-features:master_index>`
 342      - SDN-R Documentation (part of CCSDK)
 343
 344 SO - Service Orchestration
 345 --------------------------
 346
 347 .. list-table::
 348    :widths: 20 80
 349    :header-rows: 1
 350
 351    * - Document
 352      - Description
 353    * - :ref:`SO<onap-so:master_index>`
 354      - Service Orchestration Architecture, APIs and Guides
 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