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 Additional developer level detail is provided for each project below.
  13
  14 Active and Available Inventory
  15 ------------------------------
  16
  17 .. toctree::
  18    :maxdepth: 2
  19    :titlesonly:
  20
  21 | :ref:`aai aai-common<onap-aai-aai-common:master_index>`
  22 | :ref:`AAI-esr-gui<onap-aai-esr-gui:master_index>`
  23 | :ref:`aai esr-server<onap-aai-esr-server:master_index>`
  24 | :ref:`aai sparky-be<onap-aai-sparky-be:master_index>`
  25 | :ref:`aai event-clientrst<onap-aai-event-client:master_index>`
  26
  27
  28 Application Controller
  29 ----------------------
  30
  31 .. toctree::
  32    :maxdepth: 2
  33    :titlesonly:
  34
  35 | :ref:`appc deployment<onap-appc-deployment:master_index>`
  36 | :ref:`appc<onap-appc:master_index>`
  37
  38 Application Authorization Framework
  39 -----------------------------------
  40
  41 .. toctree::
  42    :maxdepth: 2
  43    :titlesonly:
  44
  45 | :ref:`aaf authz<onap-aaf-authz:master_index>`
  46 | :ref:`Secret Management Service<onap-aaf-sms:master_index>`
  47 | :ref:`Certification Service<onap-aaf-certservice:master_index>`
  48
  49 Command Line Interface
  50 ----------------------
  51
  52 .. toctree::
  53    :maxdepth: 2
  54    :titlesonly:
  55
  56 :ref:`cli<onap-cli:master_index>`
  57
  58
  59 Control Loop Automation Management Platform
  60 -------------------------------------------
  61
  62 .. toctree::
  63    :maxdepth: 2
  64    :titlesonly:
  65
  66 :ref:`clamp<onap-clamp:master_index>`
  67
  68 Common Controller Software Development Kit
  69 ------------------------------------------
  70
  71 .. toctree::
  72    :maxdepth: 2
  73    :titlesonly:
  74
  75 | :ref:`ccsdk distribution<onap-ccsdk-distribution:master_index>`
  76 | :ref:`ccsdk dashboard<onap-ccsdk-dashboard:master_index>`
  77 | :ref:`ccsdk platform plugins<onap-ccsdk-platform-plugins:master_index>`
  78 | :ref:`ccsdk apps<onap-ccsdk-apps:master_index>`
  79 | :ref:`ccsdk cds<onap-ccsdk-cds:master_index>`
  80
  81 Data Collection, Analysis, and Events
  82 -------------------------------------
  83
  84 .. toctree::
  85    :maxdepth: 2
  86    :titlesonly:
  87
  88 :ref:`dcaegen2<onap-dcaegen2:master_index>`
  89
  90 Data Management as a Platform Data Bus Controller
  91 -------------------------------------------------
  92
  93 .. toctree::
  94    :maxdepth: 1
  95    :titlesonly:
  96
  97 | :ref:`dmaap dbcapi<onap-dmaap-dbcapi:master_index>`
  98 | :ref:`dmaap buscontroller<onap-dmaap-buscontroller:master_index>`
  99
 100 Data Management as a Platform Data Router
 101 -----------------------------------------
 102
 103 .. toctree::
 104    :maxdepth: 1
 105    :titlesonly:
 106
 107 :ref:`dmaap datarouter<onap-dmaap-datarouter:master_index>`
 108
 109 Data Management as a Platform Message Router
 110 --------------------------------------------
 111
 112 .. toctree::
 113    :maxdepth: 2
 114    :titlesonly:
 115
 116 :ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
 117
 118 External API Framework
 119 ----------------------
 120
 121 .. toctree::
 122    :maxdepth: 2
 123    :titlesonly:
 124
 125 :ref:`externalapi nbi<onap-externalapi-nbi:master_index>`
 126
 127
 128 Holmes
 129 ------
 130
 131 .. toctree::
 132    :maxdepth: 2
 133    :titlesonly:
 134
 135 | :ref:`Alarm Correlation and Analysis<onap-holmes-engine-management:master_index>`
 136 | :ref:`Architecture and APIs<onap-holmes-rule-management:master_index>`
 137
 138 Integration
 139 -----------
 140
 141 .. toctree::
 142    :maxdepth: 1
 143    :titlesonly:
 144
 145 :ref:`integration<onap-integration:master_index>`
 146
 147 Logging Analytics
 148 -----------------
 149
 150 .. toctree::
 151    :maxdepth: 2
 152    :titlesonly:
 153
 154 :ref:`logging-analytics<onap-logging-analytics:master_index>`
 155
 156 Micro Services Bus
 157 ------------------
 158
 159 .. toctree::
 160    :maxdepth: 2
 161    :titlesonly:
 162
 163 :ref:`msb apigateway<onap-msb-apigateway:master_index>`
 164
 165 :ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>`
 166
 167
 168 Modeling
 169 --------
 170
 171 .. toctree::
 172    :maxdepth: 2
 173    :titlesonly:
 174
 175 :ref:`modeling modelspec<onap-modeling-modelspec:master_index>`
 176
 177 :ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>`
 178
 179 MultiVIM Cloud
 180 --------------
 181
 182 .. toctree::
 183    :maxdepth: 2
 184    :titlesonly:
 185
 186 :ref:`multicloud framework<onap-multicloud-framework:master_index>`
 187
 188 Music
 189 -----
 190
 191 .. toctree::
 192    :maxdepth: 2
 193    :titlesonly:
 194
 195 :ref:`music<onap-music:master_index>`
 196
 197 :ref:`music distributed-kv-store<onap-music-distributed-kv-store:master_index>`
 198
 199 ONAP Operations Manager
 200 -----------------------
 201
 202 .. toctree::
 203    :maxdepth: 2
 204    :titlesonly:
 205
 206 :ref:`oom<onap-oom:master_index>`
 207
 208 Optimization Framework
 209 ----------------------
 210
 211 .. toctree::
 212    :maxdepth: 2
 213    :titlesonly:
 214
 215 | :ref:`optf has<onap-optf-has:master_index>`
 216 | :ref:`optf osdf<onap-optf-osdf:master_index>`
 217 | :ref:`optf cmso<onap-optf-cmso:master_index>`
 218
 219 Policy Framework
 220 ----------------
 221
 222 .. toctree::
 223    :maxdepth: 2
 224    :titlesonly:
 225
 226 :ref:`policy parent<onap-policy-parent:master_index>`
 227
 228 :ref:`policy engine<onap-policy-engine:master_index>`
 229
 230 Portal Platform
 231 ---------------
 232
 233 .. toctree::
 234    :maxdepth: 2
 235    :titlesonly:
 236
 237 :ref:`portal<onap-portal:master_index>`
 238
 239 Service Design & Creation
 240 -------------------------
 241
 242 .. toctree::
 243    :maxdepth: 2
 244    :titlesonly:
 245
 246 :ref:`sdc<onap-sdc:master_index>`
 247
 248 Service Orchestration
 249 ---------------------
 250
 251 .. toctree::
 252    :maxdepth: 2
 253    :titlesonly:
 254
 255 :ref:`so<onap-so:master_index>`
 256
 257 :ref:`so libs<onap-so-libs:master_index>`
 258
 259 Software Defined Network Controller
 260 -----------------------------------
 261
 262 .. toctree::
 263    :maxdepth: 2
 264    :titlesonly:
 265
 266 :ref:`sdnc oam<onap-sdnc-oam:master_index>`
 267
 268 Software Defined Network Controller for Radio (SDN-R)
 269 -----------------------------------------------------
 270
 271 .. toctree::
 272    :maxdepth: 2
 273    :titlesonly:
 274
 275 :ref:`ccsdk features<onap-ccsdk-features:master_index>`
 276
 277 Use Case User Interface
 278 -----------------------
 279
 280 .. toctree::
 281    :maxdepth: 2
 282    :titlesonly:
 283
 284 :ref:`usecase-ui<onap-usecase-ui:master_index>`
 285
 286 Virtual Function Controller
 287 ---------------------------
 288
 289 .. toctree::
 290    :maxdepth: 2
 291    :titlesonly:
 292
 293 :ref:`vfc nfvo lcm<onap-vfc-nfvo-lcm:master_index>`
 294
 295 Virtual Infrastructure Deployment
 296 ---------------------------------
 297
 298 .. toctree::
 299    :maxdepth: 2
 300    :titlesonly:
 301
 302
 303 :ref:`vid<onap-vid:master_index>`
 304
 305 VNF Software Development Kit
 306 ----------------------------
 307
 308 .. toctree::
 309    :maxdepth: 2
 310    :titlesonly:
 311
 312 :ref:`vnfsdk model<onap-vnfsdk-model:master_index>`