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 maintained projects,
  13 ONAP components and functionalities.
  14
  15 AAI - Active and Available Inventory
  16 ------------------------------------
  17
  18 .. list-table::
  19    :widths: auto
  20    :header-rows: 1
  21
  22    * - Component
  23      - Documentation
  24    * - :ref:`aai/aai-common<onap-aai-aai-common:master_index>`
  25      - AAI Architecture, APIs and Guides
  26    * - :ref:`aai/sparky-be<onap-aai-sparky-be:master_index>`
  27      - Sparky - AAI Inventory UI
  28
  29 CCSDK - Common Controller Software Development Kit
  30 --------------------------------------------------
  31
  32 .. list-table::
  33    :widths: auto
  34    :header-rows: 1
  35
  36    * - Component
  37      - Documentation
  38    * - :ref:`ccsdk/apps<onap-ccsdk-apps:master_index>`
  39      - Micro Services for CCSDK
  40    * - :ref:`ccsdk/cds<onap-ccsdk-cds:master_index>`
  41      - Controller Design Studio Architecture and Guides
  42    * - :ref:`ccsdk/distribution<onap-ccsdk-distribution:master_index>`
  43      - TOSCA Orchestration Plugin, Directed Graph Support
  44    * - :ref:`ccsdk/features<onap-ccsdk-features:master_index>`
  45      - Software Defined Network Controller for Radio (SDNR)
  46    * - :ref:`ccsdk/oran<onap-ccsdk-oran:master_index>`
  47      - O-RAN Support in ONAP
  48
  49
  50 CLI - Command Line Interface
  51 ----------------------------
  52
  53 .. list-table::
  54    :widths: auto
  55    :header-rows: 1
  56
  57    * - Component
  58      - Documentation
  59    * - :ref:`cli<onap-cli:master_index>`
  60      - CLI
  61
  62 CPS - Configuration Persistence Service
  63 ---------------------------------------
  64
  65 .. list-table::
  66    :widths: auto
  67    :header-rows: 1
  68
  69    * - Component
  70      - Documentation
  71    * - :ref:`cps<onap-cps:master_index>`
  72      - CPS Global
  73    * - :ref:`cps/cps-temporal<onap-cps-cps-temporal:master_index>`
  74      - CPS Temporal
  75    * - :ref:`cps/ncmp/dmi-plugin<onap-cps-ncmp-dmi-plugin:master_index>`
  76      - CPS DMI Plugin
  77
  78 DCAE - Data Collection, Analysis and Events
  79 -------------------------------------------
  80
  81 .. list-table::
  82    :widths: auto
  83    :header-rows: 1
  84
  85    * - Component
  86      - Documentation
  87    * - :ref:`dcaegen2<onap-dcaegen2:master_index>`
  88      - DCAE (Gen2) Architecture and Guides
  89
  90 DMAAP - Data Movement as a Platform
  91 -----------------------------------
  92
  93 .. list-table::
  94    :widths: auto
  95    :header-rows: 1
  96
  97    * - Component
  98      - Documentation
  99    * - :ref:`dmaap/buscontroller<onap-dmaap-buscontroller:master_index>`
 100      - Bus Controller
 101    * - :ref:`dmaap/datarouter<onap-dmaap-datarouter:master_index>`
 102      - Data Router
 103    * - :ref:`dmaap/messagerouter/messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
 104      - Message Router
 105
 106 HOLMES - Alarm Correlation and Analysis
 107 ----------------------------------------------
 108
 109 .. list-table::
 110    :widths: auto
 111    :header-rows: 1
 112
 113    * - Component
 114      - Documentation
 115    * - :ref:`holmes/rule-management<onap-holmes-rule-management:master_index>`
 116      - Architecture and APIs
 117    * - :ref:`holmes/engine-management<onap-holmes-engine-management:master_index>`
 118      - Engine Management
 119
 120 INT - Integration
 121 -----------------
 122
 123 .. list-table::
 124    :widths: auto
 125    :header-rows: 1
 126
 127    * - Component
 128      - Documentation
 129    * - :ref:`integration<onap-integration:master_index>`
 130      - Integration Project
 131
 132 MOD - Modeling
 133 --------------
 134
 135 .. list-table::
 136    :widths: auto
 137    :header-rows: 1
 138
 139    * - Component
 140      - Documentation
 141    * - :ref:`modeling/modelspec<onap-modeling-modelspec:master_index>`
 142      - Model Specification
 143    * - :ref:`modeling/etsicatalog<onap-modeling-etsicatalog:master_index>`
 144      - ETSI Runtime Catalog
 145
 146 MSB - Microservices Bus
 147 -----------------------
 148
 149 .. list-table::
 150    :widths: auto
 151    :header-rows: 1
 152
 153    * - Component
 154      - Documentation
 155    * - :ref:`msb/apigateway<onap-msb-apigateway:master_index>`
 156      - Microservices Bus
 157    * - :ref:`msb/discovery<onap-msb-discovery:master_index>`
 158      - <to be revised>
 159    * - :ref:`msb/java-sdk<onap-msb-java-sdk:master_index>`
 160      - <to be revised>
 161    * - :ref:`msb/swagger-sdk<onap-msb-swagger-sdk:master_index>`
 162      - Swagger Software Development Kit
 163
 164 MULTICLOUD - MultiCloud Framework
 165 ---------------------------------
 166
 167 .. list-table::
 168    :widths: auto
 169    :header-rows: 1
 170
 171    * - Component
 172      - Documentation
 173    * - :ref:`multicloud/framework<onap-multicloud-framework:master_index>`
 174      - MultiCloud Framework Architecture and Guides
 175    * - :ref:`multicloud/k8s<onap-multicloud-k8s:master_index>`
 176      - Kubernetes Reference Deployment (KUD)
 177
 178 OOM - ONAP Operations Manager
 179 -----------------------------
 180
 181 .. list-table::
 182    :widths: auto
 183    :header-rows: 1
 184
 185    * - Component
 186      - Documentation
 187    * - :ref:`oom<onap-oom:master_index>`
 188      - ONAP Operations Manager
 189    * - :ref:`oom/platform/cert-service<onap-oom-platform-cert-service:master_index>`
 190      - ONAP CMPv2 Certification Support
 191    * - :ref:`oom/offline-installer<onap-oom-offline-installer:master_index>`
 192      - OOM Offline Installer
 193
 194 OOF - Optimization Framework
 195 ----------------------------
 196
 197 .. list-table::
 198    :widths: auto
 199    :header-rows: 1
 200
 201    * - Component
 202      - Documentation
 203    * - :ref:`optf/has<onap-optf-has:master_index>`
 204      - Homing and Allocation
 205    * - :ref:`optf/osdf<onap-optf-osdf:master_index>`
 206      - Optimization Service Design Framework
 207
 208 POLICY - Policy Framework
 209 -------------------------
 210
 211 .. list-table::
 212    :widths: auto
 213    :header-rows: 1
 214
 215    * - Component
 216      - Documentation
 217    * - :ref:`policy/parent<onap-policy-parent:master_index>`
 218      - Policy Framework
 219
 220 SDC - Service Design & Creation
 221 -------------------------------
 222
 223 .. list-table::
 224    :widths: auto
 225    :header-rows: 1
 226
 227    * - Component
 228      - Documentation
 229    * - :ref:`sdc<onap-sdc:master_index>`
 230      - Service Design & Creation
 231
 232 SDNC - Software Defined Network Controller
 233 ------------------------------------------
 234
 235 .. list-table::
 236    :widths: auto
 237    :header-rows: 1
 238
 239    * - Component
 240      - Documentation
 241    * - :ref:`sdnc/oam<onap-sdnc-oam:master_index>`
 242      - SDNC Architecture, APIs and Guides
 243
 244 SO - Service Orchestration
 245 --------------------------
 246
 247 .. list-table::
 248    :widths: auto
 249    :header-rows: 1
 250
 251    * - Component
 252      - Documentation
 253    * - :ref:`so<onap-so:master_index>`
 254      - Service Orchestration Architecture, APIs and Guides
 255
 256 UUI - Usecase User Interface
 257 -----------------------------
 258
 259 .. list-table::
 260    :widths: auto
 261    :header-rows: 1
 262
 263    * - Component
 264      - Documentation
 265    * - :ref:`usecase-ui<onap-usecase-ui:master_index>`
 266      - Usecase-UI Architecture, APIs and Guides
 267
 268 VFC - Virtual Function Controller
 269 ---------------------------------
 270
 271 .. list-table::
 272    :widths: auto
 273    :header-rows: 1
 274
 275    * - Component
 276      - Documentation
 277    * - :ref:`vfc/nfvo/lcm<onap-vfc-nfvo-lcm:master_index>`
 278      - Virtual Function Controller Architecture, APIs and Guides
 279
 280 VNFSDK - VNF Software Development Kit
 281 -------------------------------------
 282
 283 .. list-table::
 284    :widths: auto
 285    :header-rows: 1
 286
 287    * - Component
 288      - Documentation
 289    * - :ref:`vnfsdk/model<onap-vnfsdk-model:master_index>`
 290      - VNF SDK, User Guides