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) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_
  52      - 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    * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_
  66      - External System Registry GUI Documentation
  67    * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
  68      - 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    * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_
  82      - APPC Architecture, APIs and Guides
  83    * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_
  84      - 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 Management 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    * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
 210      - 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    * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_
 246      - MUSIC Architecture and Guides
 247    * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_
 248      - 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
 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:`SDNC<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:`SDN-R<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
 364 UUI - Use Case User Interface
 365 -----------------------------
 366
 367 .. list-table::
 368    :widths: 20 80
 369    :header-rows: 1
 370
 371    * - Document
 372      - Description
 373    * - :ref:`UUI<onap-usecase-ui:master_index>`
 374      - Usecase-UI Architecture, APIs and Guides
 375
 376 VFC - Virtual Function Controller
 377 ---------------------------------
 378
 379 .. list-table::
 380    :widths: 20 80
 381    :header-rows: 1
 382
 383    * - Document
 384      - Description
 385    * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
 386      - Virtual Function Controller Architecture, APIs and Guides
 387
 388 VID - Virtual Infrastructure Deployment
 389 ---------------------------------------
 390
 391 .. list-table::
 392    :widths: 20 80
 393    :header-rows: 1
 394
 395    * - Document
 396      - Description
 397    * - :ref:`VID<onap-vid:master_index>`
 398      - Virtual Infrastructure Deployment Architecture, APIs and Guides
 399
 400 VNFSDK - VNF Software Development Kit
 401 -------------------------------------
 402
 403 .. list-table::
 404    :widths: 20 80
 405    :header-rows: 1
 406
 407    * - Document
 408      - Description
 409    * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
 410      - VNF SDK Documentation and User Guides
 411
 412 VVP - VNF Validation Platform
 413 -----------------------------
 414
 415 .. list-table::
 416    :widths: 20 80
 417    :header-rows: 1
 418
 419    * - Document
 420      - Description
 421    * - :ref:`VVP<onap-vvp-documentation:master_index>`
 422      - VNF Validation Platform Documentation