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<onap-aaf-authz:master_index>`
  52      - AAF Architecture, APIs and Guides
  53    * - :ref:`Secret Management Service<onap-aaf-sms:master_index>`
  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    * - :ref:`ESR<onap-aai-esr-gui:master_index>`
  68      - External System Registry GUI Documentation (to be removed ?)
  69    * - :ref:`ESR<onap-aai-esr-server:master_index>`
  70      - External System Registry Server Documentation (to be removed ?)
  71    * - :ref:`AAI Inventory UI<onap-aai-sparky-be:master_index>`
  72      - Sparky - AAI Inventory UI Documentation (to be removed ?)
  73    * - :ref:`AAI Event Client<onap-aai-event-client:master_index>`
  74      - AAI Event Client Documentation (to be removed ?)
  75
  76 APPC - Application Controller
  77 -----------------------------
  78
  79 .. list-table::
  80    :widths: 20 80
  81    :header-rows: 1
  82
  83    * - Document
  84      - Description
  85    * - :ref:`APPC<onap-appc:master_index>`
  86      - APPC Architecture, APIs and Guides
  87    * - :ref:`APPC Deployment<onap-appc-deployment:master_index>`
  88      - APPC Deployment Documentation
  89
  90 CCSDK - Common Controller Software Development Kit
  91 --------------------------------------------------
  92
  93 .. list-table::
  94    :widths: 20 80
  95    :header-rows: 1
  96
  97    * - Document
  98      - Description
  99    * - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
 100      - TOSCA Orchestration Plugin, Directed Graph Support
 101    * - :ref:`Dashboard<onap-ccsdk-dashboard:master_index>`
 102      - Common Controller Dashboard (To be removed ?)
 103    * - :ref:`Platform Plugins<onap-ccsdk-platform-plugins:master_index>`
 104      - Platform Plugins (To be removed ?)
 105    * - :ref:`APPS<onap-ccsdk-apps:master_index>`
 106      - Apps optside ODL (To be removed ?)
 107
 108 CDS - Controller Design Studio
 109 ------------------------------
 110
 111 .. list-table::
 112    :widths: 20 80
 113    :header-rows: 1
 114
 115    * - Document
 116      - Description
 117    * - :ref:`CDS<onap-ccsdk-cds:master_index>`
 118      - Controller Design Studio Architecture and Guides (part of CCSDK)
 119
 120 CLAMP - Control Loop Automation Management Platform
 121 ---------------------------------------------------
 122
 123 .. list-table::
 124    :widths: 20 80
 125    :header-rows: 1
 126
 127    * - Document
 128      - Description
 129    * - :ref:`CLAMP <onap-clamp:master_index>`
 130      - CLAMP Architecture and Guides
 131
 132 CLI - Command Line Interface
 133 ----------------------------
 134
 135 .. list-table::
 136    :widths: 20 80
 137    :header-rows: 1
 138
 139    * - Document
 140      - Description
 141    * - :ref:`CLI <onap-cli:master_index>`
 142      - CLI Documentation
 143
 144 DCAE - Data Collection, Analysis and Events
 145 -------------------------------------------
 146
 147 .. list-table::
 148    :widths: 20 80
 149    :header-rows: 1
 150
 151    * - Document
 152      - Description
 153    * - :ref:`DCAE<onap-dcaegen2:master_index>`
 154      - DCAE Architecture and Guides
 155
 156 DMAAP - Data Management as a Platform
 157 -------------------------------------
 158
 159 .. list-table::
 160    :widths: 20 80
 161    :header-rows: 1
 162
 163    * - Document
 164      - Description
 165    * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>`
 166      - Bus Controller Documentation
 167    * - :ref:`Bus Controller API<onap-dmaap-dbcapi:master_index>`
 168      - Bus Controller API 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<onap-logging-analytics:master_index>`
 210      - ONAP Centralized Logging Documentation (to be deleted ?)
 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<onap-music:master_index>`
 246      - MUSIC Architecture and Guides (To be deleted ?)
 247    * - :ref:`Distributed KV Store<onap-music:master_index>`
 248      - MUSIC Distribute KV Store Documents (To be deleted ?)
 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-certservice:master_index>`
 278      - ONAP CMPv2 certification support
 279
 280 ORAN - Open-RAN Support in ONAP
 281 -------------------------------
 282
 283 .. list-table::
 284    :widths: 20 80
 285    :header-rows: 1
 286
 287    * - Document
 288      - Description
 289    * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
 290      - O-RAN Support in ONAP (part of CCSDK)
 291
 292 POLICY - Policy Framework
 293 -------------------------
 294
 295 .. list-table::
 296    :widths: 20 80
 297    :header-rows: 1
 298
 299    * - Document
 300      - Description
 301    * - :ref:`Policy<onap-policy-parent:master_index>`
 302      - Policy Framework Documentation
 303
 304 PORTAL - Portal Platform
 305 ------------------------
 306
 307 .. list-table::
 308    :widths: 20 80
 309    :header-rows: 1
 310
 311    * - Document
 312      - Description
 313    * - :ref:`Portal<onap-portal:master_index>`
 314      - ONAP Portal Platform Documentation
 315
 316 SDC - Service Design & Creation
 317 -------------------------------
 318
 319 .. list-table::
 320    :widths: 20 80
 321    :header-rows: 1
 322
 323    * - Document
 324      - Description
 325    * - :ref:`SDC<onap-sdc:master_index>`
 326      - Service Design & Creation Documentation
 327
 328 SDNC - Software Defined Network Controller
 329 ------------------------------------------
 330
 331 .. list-table::
 332    :widths: 20 80
 333    :header-rows: 1
 334
 335    * - Document
 336      - Description
 337    * - :ref:`SDCN<onap-sdnc-oam:master_index>`
 338      - SDNC Architecture, APIs and Guides
 339
 340 SDNR - Software Defined Network Controller for Radio
 341 ----------------------------------------------------
 342
 343 .. list-table::
 344    :widths: 20 80
 345    :header-rows: 1
 346
 347    * - Document
 348      - Description
 349    * - :ref:`SDNR<onap-ccsdk-features:master_index>`
 350      - SDN-R Documentation (part of CCSDK)
 351
 352 SO - Service Orchestration
 353 --------------------------
 354
 355 .. list-table::
 356    :widths: 20 80
 357    :header-rows: 1
 358
 359    * - Document
 360      - Description
 361    * - :ref:`SO<onap-so:master_index>`
 362      - Service Orchestration Architecture, APIs and Guides
 363    * - :ref:`SO Libraries<onap-so-libs:master_index>`
 364      - Service Orchestration Build (To be deleted ?)
 365
 366 UUI - Use Case User Interface
 367 -----------------------------
 368
 369 .. list-table::
 370    :widths: 20 80
 371    :header-rows: 1
 372
 373    * - Document
 374      - Description
 375    * - :ref:`UUI<onap-usecase-ui:master_index>`
 376      - Usecase-UI Architecture, APIs and Guides
 377
 378 VFC - Virtual Function Controller
 379 ---------------------------------
 380
 381 .. list-table::
 382    :widths: 20 80
 383    :header-rows: 1
 384
 385    * - Document
 386      - Description
 387    * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
 388      - Virtual Function Controller Architecture, APIs and Guides
 389
 390 VID - Virtual Infrastructure Deployment
 391 ---------------------------------------
 392
 393 .. list-table::
 394    :widths: 20 80
 395    :header-rows: 1
 396
 397    * - Document
 398      - Description
 399    * - :ref:`VID<onap-vid:master_index>`
 400      - Virtual Infrastructure Deployment Architecture, APIs and Guides
 401
 402 VNFSDK - VNF Software Development Kit
 403 -------------------------------------
 404
 405 .. list-table::
 406    :widths: 20 80
 407    :header-rows: 1
 408
 409    * - Document
 410      - Description
 411    * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
 412      - VNF SDK Documentation and User Guides
 413
 414 VVP - VNF Validation Platform
 415 -----------------------------
 416
 417 .. list-table::
 418    :widths: 20 80
 419    :header-rows: 1
 420
 421    * - Document
 422      - Description
 423    * - :ref:`VVP<onap-vvp-documentation:master_index>`
 424      - VNF Validation Platform Documentation