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
  48 Command Line Interface
  49 ----------------------
  50
  51 .. toctree::
  52    :maxdepth: 2
  53    :titlesonly:
  54
  55 :ref:`cli<onap-cli:master_index>`
  56
  57
  58 Control Loop Automation Management Platform
  59 -------------------------------------------
  60
  61 .. toctree::
  62    :maxdepth: 2
  63    :titlesonly:
  64
  65 :ref:`clamp<onap-clamp:master_index>`
  66
  67 Common Controller Software Development Kit
  68 ------------------------------------------
  69
  70 .. toctree::
  71    :maxdepth: 2
  72    :titlesonly:
  73
  74 | :ref:`ccsdk distribution<onap-ccsdk-distribution:master_index>`
  75 | :ref:`ccsdk dashboard<onap-ccsdk-dashboard:master_index>`
  76 | :ref:`ccsdk platform plugins<onap-ccsdk-platform-plugins:master_index>`
  77 | :ref:`ccsdk apps<onap-ccsdk-apps:master_index>`
  78 | :ref:`ccsdk cds<onap-ccsdk-cds:master_index>`
  79
  80 Data Collection, Analysis, and Events
  81 -------------------------------------
  82
  83 .. toctree::
  84    :maxdepth: 2
  85    :titlesonly:
  86
  87 :ref:`dcaegen2<onap-dcaegen2:master_index>`
  88
  89 Data Management as a Platform Data Bus Controller
  90 -------------------------------------------------
  91
  92 .. toctree::
  93    :maxdepth: 1
  94    :titlesonly:
  95
  96 | :ref:`dmaap dbcapi<onap-dmaap-dbcapi:master_index>`
  97 | :ref:`dmaap buscontroller<onap-dmaap-buscontroller:master_index>`
  98
  99 Data Management as a Platform Data Router
 100 -----------------------------------------
 101
 102 .. toctree::
 103    :maxdepth: 1
 104    :titlesonly:
 105
 106 :ref:`dmaap datarouter<onap-dmaap-datarouter:master_index>`
 107
 108 Data Management as a Platform Message Router
 109 --------------------------------------------
 110
 111 .. toctree::
 112    :maxdepth: 2
 113    :titlesonly:
 114
 115 :ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
 116
 117 External API Framework
 118 ----------------------
 119
 120 .. toctree::
 121    :maxdepth: 2
 122    :titlesonly:
 123
 124 :ref:`externalapi nbi<onap-externalapi-nbi:master_index>`
 125
 126
 127 Holmes
 128 ------
 129
 130 .. toctree::
 131    :maxdepth: 2
 132    :titlesonly:
 133
 134 | :ref:`Alarm Correlation and Analysis<onap-holmes-engine-management:master_index>`
 135 | :ref:`Architecture and APIs<onap-holmes-rule-management:master_index>`
 136
 137 Integration
 138 -----------
 139
 140 .. toctree::
 141    :maxdepth: 1
 142    :titlesonly:
 143
 144 :ref:`integration<onap-integration:master_index>`
 145
 146 Logging Analytics
 147 -----------------
 148
 149 .. toctree::
 150    :maxdepth: 2
 151    :titlesonly:
 152
 153 :ref:`logging-analytics<onap-logging-analytics:master_index>`
 154
 155 Micro Services Bus
 156 ------------------
 157
 158 .. toctree::
 159    :maxdepth: 2
 160    :titlesonly:
 161
 162 :ref:`msb apigateway<onap-msb-apigateway:master_index>`
 163
 164 :ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>`
 165
 166
 167 Modeling
 168 --------
 169
 170 .. toctree::
 171    :maxdepth: 2
 172    :titlesonly:
 173
 174 :ref:`modeling modelspec<onap-modeling-modelspec:master_index>`
 175
 176 :ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>`
 177
 178 MultiVIM Cloud
 179 --------------
 180
 181 .. toctree::
 182    :maxdepth: 2
 183    :titlesonly:
 184
 185 :ref:`multicloud framework<onap-multicloud-framework:master_index>`
 186
 187 Music
 188 -----
 189
 190 .. toctree::
 191    :maxdepth: 2
 192    :titlesonly:
 193
 194 :ref:`music<onap-music:master_index>`
 195
 196 :ref:`music distributed-kv-store<onap-music-distributed-kv-store:master_index>`
 197
 198 ONAP Operations Manager
 199 -----------------------
 200
 201 .. toctree::
 202    :maxdepth: 2
 203    :titlesonly:
 204
 205 | :ref:`oom<onap-oom:master_index>`
 206 | :ref:`CMPv2 CertService<onap-oom-certservice: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 Portal Platform
 229 ---------------
 230
 231 .. toctree::
 232    :maxdepth: 2
 233    :titlesonly:
 234
 235 :ref:`portal<onap-portal:master_index>`
 236
 237 Service Design & Creation
 238 -------------------------
 239
 240 .. toctree::
 241    :maxdepth: 2
 242    :titlesonly:
 243
 244 :ref:`sdc<onap-sdc:master_index>`
 245
 246 Service Orchestration
 247 ---------------------
 248
 249 .. toctree::
 250    :maxdepth: 2
 251    :titlesonly:
 252
 253 :ref:`so<onap-so:master_index>`
 254
 255 :ref:`so libs<onap-so-libs:master_index>`
 256
 257 Software Defined Network Controller
 258 -----------------------------------
 259
 260 .. toctree::
 261    :maxdepth: 2
 262    :titlesonly:
 263
 264 :ref:`sdnc oam<onap-sdnc-oam:master_index>`
 265
 266 Software Defined Network Controller for Radio (SDN-R)
 267 -----------------------------------------------------
 268
 269 .. toctree::
 270    :maxdepth: 2
 271    :titlesonly:
 272
 273 :ref:`ccsdk features<onap-ccsdk-features:master_index>`
 274
 275 Use Case User Interface
 276 -----------------------
 277
 278 .. toctree::
 279    :maxdepth: 2
 280    :titlesonly:
 281
 282 :ref:`usecase-ui<onap-usecase-ui:master_index>`
 283
 284 Virtual Function Controller
 285 ---------------------------
 286
 287 .. toctree::
 288    :maxdepth: 2
 289    :titlesonly:
 290
 291 :ref:`vfc nfvo lcm<onap-vfc-nfvo-lcm:master_index>`
 292
 293 Virtual Infrastructure Deployment
 294 ---------------------------------
 295
 296 .. toctree::
 297    :maxdepth: 2
 298    :titlesonly:
 299
 300
 301 :ref:`vid<onap-vid:master_index>`
 302
 303 VNF Software Development Kit
 304 ----------------------------
 305
 306 .. toctree::
 307    :maxdepth: 2
 308    :titlesonly:
 309
 310 :ref:`vnfsdk model<onap-vnfsdk-model:master_index>`