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