docs/platform/components/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 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 CPS - Configuration Persistence Service
  50 ---------------------------------------
  51
  52 .. list-table::
  53    :widths: auto
  54    :header-rows: 1
  55
  56    * - Component
  57      - Documentation
  58    * - :ref:`cps<onap-cps:master_index>`
  59      - CPS Global
  60    * - :ref:`cps/cps-temporal<onap-cps-cps-temporal:master_index>`
  61      - CPS Temporal
  62    * - :ref:`cps/ncmp/dmi-plugin<onap-cps-ncmp-dmi-plugin:master_index>`
  63      - CPS DMI Plugin
  64
  65 DCAE - Data Collection, Analysis and Events
  66 -------------------------------------------
  67
  68 .. list-table::
  69    :widths: auto
  70    :header-rows: 1
  71
  72    * - Component
  73      - Documentation
  74    * - :ref:`dcaegen2<onap-dcaegen2:master_index>`
  75      - DCAE (Gen2) Architecture and Guides
  76
  77 DMAAP - Data Movement as a Platform
  78 -----------------------------------
  79
  80 .. list-table::
  81    :widths: auto
  82    :header-rows: 1
  83
  84    * - Component
  85      - Documentation
  86    * - :ref:`dmaap/buscontroller<onap-dmaap-buscontroller:master_index>`
  87      - Bus Controller
  88    * - :ref:`dmaap/datarouter<onap-dmaap-datarouter:master_index>`
  89      - Data Router
  90    * - :ref:`dmaap/messagerouter/messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
  91      - Message Router
  92
  93 HOLMES - Alarm Correlation and Analysis
  94 ----------------------------------------------
  95
  96 .. list-table::
  97    :widths: auto
  98    :header-rows: 1
  99
 100    * - Component
 101      - Documentation
 102    * - :ref:`holmes/rule-management<onap-holmes-rule-management:master_index>`
 103      - Architecture and APIs
 104    * - :ref:`holmes/engine-management<onap-holmes-engine-management:master_index>`
 105      - Engine Management
 106
 107 INT - Integration
 108 -----------------
 109
 110 .. list-table::
 111    :widths: auto
 112    :header-rows: 1
 113
 114    * - Component
 115      - Documentation
 116    * - :ref:`integration<onap-integration:master_index>`
 117      - Integration Project
 118
 119 MOD - Modeling
 120 --------------
 121
 122 .. list-table::
 123    :widths: auto
 124    :header-rows: 1
 125
 126    * - Component
 127      - Documentation
 128    * - :ref:`modeling/etsicatalog<onap-modeling-etsicatalog:master_index>`
 129      - ETSI Runtime Catalog
 130
 131 MSB - Microservices Bus
 132 -----------------------
 133
 134 .. list-table::
 135    :widths: auto
 136    :header-rows: 1
 137
 138    * - Component
 139      - Documentation
 140    * - :ref:`msb/apigateway<onap-msb-apigateway:master_index>`
 141      - Microservices Bus
 142    * - :ref:`msb/discovery<onap-msb-discovery:master_index>`
 143      - <to be revised>
 144    * - :ref:`msb/java-sdk<onap-msb-java-sdk:master_index>`
 145      - <to be revised>
 146    * - :ref:`msb/swagger-sdk<onap-msb-swagger-sdk:master_index>`
 147      - Swagger Software Development Kit
 148
 149 MULTICLOUD - MultiCloud Framework
 150 ---------------------------------
 151
 152 .. list-table::
 153    :widths: auto
 154    :header-rows: 1
 155
 156    * - Component
 157      - Documentation
 158    * - :ref:`multicloud/framework<onap-multicloud-framework:master_index>`
 159      - MultiCloud Framework Architecture and Guides
 160    * - :ref:`multicloud/k8s<onap-multicloud-k8s:master_index>`
 161      - Kubernetes Reference Deployment (KUD)
 162
 163 OOM - ONAP Operations Manager
 164 -----------------------------
 165
 166 .. list-table::
 167    :widths: auto
 168    :header-rows: 1
 169
 170    * - Component
 171      - Documentation
 172    * - :ref:`oom<onap-oom:master_index>`
 173      - ONAP Operations Manager
 174
 175 OOF - Optimization Framework
 176 ----------------------------
 177
 178 .. list-table::
 179    :widths: auto
 180    :header-rows: 1
 181
 182    * - Component
 183      - Documentation
 184    * - :ref:`optf/has<onap-optf-has:master_index>`
 185      - Homing and Allocation
 186    * - :ref:`optf/osdf<onap-optf-osdf:master_index>`
 187      - Optimization Service Design Framework
 188
 189 POLICY - Policy Framework
 190 -------------------------
 191
 192 .. list-table::
 193    :widths: auto
 194    :header-rows: 1
 195
 196    * - Component
 197      - Documentation
 198    * - :ref:`policy/parent<onap-policy-parent:master_index>`
 199      - Policy Framework
 200
 201 SDC - Service Design & Creation
 202 -------------------------------
 203
 204 .. list-table::
 205    :widths: auto
 206    :header-rows: 1
 207
 208    * - Component
 209      - Documentation
 210    * - :ref:`sdc<onap-sdc:master_index>`
 211      - Service Design & Creation
 212
 213 SDNC - Software Defined Network Controller
 214 ------------------------------------------
 215
 216 .. list-table::
 217    :widths: auto
 218    :header-rows: 1
 219
 220    * - Component
 221      - Documentation
 222    * - :ref:`sdnc/oam<onap-sdnc-oam:master_index>`
 223      - SDNC Architecture, APIs and Guides
 224
 225 SO - Service Orchestration
 226 --------------------------
 227
 228 .. list-table::
 229    :widths: auto
 230    :header-rows: 1
 231
 232    * - Component
 233      - Documentation
 234    * - :ref:`so<onap-so:master_index>`
 235      - Service Orchestration Architecture, APIs and Guides
 236
 237 UUI - Usecase User Interface
 238 -----------------------------
 239
 240 .. list-table::
 241    :widths: auto
 242    :header-rows: 1
 243
 244    * - Component
 245      - Documentation
 246    * - :ref:`usecase-ui<onap-usecase-ui:master_index>`
 247      - Usecase-UI Architecture, APIs and Guides
 248
 249 VFC - Virtual Function Controller
 250 ---------------------------------
 251
 252 .. list-table::
 253    :widths: auto
 254    :header-rows: 1
 255
 256    * - Component
 257      - Documentation
 258    * - :ref:`vfc/nfvo/lcm<onap-vfc-nfvo-lcm:master_index>`
 259      - Virtual Function Controller Architecture, APIs and Guides
 260