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    ../../../submodules/aai/aai-common.git/docs/index
  22    AAI-esr-gui <../../../submodules/aai/esr-gui.git/docs/index>
  23    ../../../submodules/aai/esr-server.git/docs/index
  24    ../../../submodules/aai/sparky-be.git/docs/index
  25    ../../../submodules/aai/event-client.git/docs/index.rst
  26
  27
  28 Application Controller
  29 ----------------------
  30
  31 .. toctree::
  32    :maxdepth: 2
  33    :titlesonly:
  34
  35    ../../../submodules/appc/deployment.git/docs/index
  36    ../../../submodules/appc.git/docs/index
  37
  38 Application Authorization Framework
  39 -----------------------------------
  40
  41 .. toctree::
  42    :maxdepth: 2
  43    :titlesonly:
  44
  45    ../../../submodules/aaf/authz.git/docs/index
  46    Secret Management Service <../../../submodules/aaf/sms.git/docs/index>
  47
  48 Command Line Interface
  49 ----------------------
  50
  51 .. toctree::
  52    :maxdepth: 2
  53    :titlesonly:
  54
  55    ../../../submodules/cli.git/docs/index
  56
  57
  58 Closed Loop Automation Platform
  59 -------------------------------
  60
  61 .. toctree::
  62    :maxdepth: 2
  63    :titlesonly:
  64
  65    ../../../submodules/clamp.git/docs/index
  66
  67 Common Controller Software Development Kit
  68 ------------------------------------------
  69
  70 .. toctree::
  71    :maxdepth: 2
  72    :titlesonly:
  73
  74    ../../../submodules/ccsdk/distribution.git/docs/index
  75    ../../../submodules/ccsdk/dashboard.git/docs/index
  76    ../../../submodules/ccsdk/platform/plugins.git/docs/index
  77    ../../../submodules/ccsdk/apps.git/docs/index
  78    ../../../submodules/ccsdk/cds.git/docs/index
  79
  80 .. Being consolidated in ccsdk distribution
  81    ../../../submodules/ccsdk/platform/blueprints.git/docs/index
  82    ../../../submodules/ccsdk/platform/nbapi.git/docs/index
  83    ../../../submodules/ccsdk/storage/esaas.git/docs/index
  84    ../../../submodules/ccsdk/storage/pgaas.git/docs/index
  85    ../../../submodules/ccsdk/utils.git/docs/index
  86    ../../../submodules/ccsdk/parent.git/docs/index
  87    ../../../submodules/ccsdk/sli/adaptors.git/docs/index
  88    ../../../submodules/ccsdk/sli/core.git/docs/index
  89    ../../../submodules/ccsdk/sli/northbound.git/docs/index
  90    ../../../submodules/ccsdk/sli/plugins.git/docs/index
  91
  92 Data Collection, Analysis, and Events
  93 -------------------------------------
  94
  95 .. toctree::
  96    :maxdepth: 2
  97    :titlesonly:
  98
  99    ../../../submodules/dcaegen2.git/docs/index
 100
 101 Data Management as a Platform Data Bus Controller
 102 -------------------------------------------------
 103
 104 .. toctree::
 105    :maxdepth: 1
 106    :titlesonly:
 107
 108    ../../../submodules/dmaap/dbcapi.git/docs/index
 109    ../../../submodules/dmaap/buscontroller.git/docs/index
 110
 111 Data Management as a Platform Data Router
 112 -----------------------------------------
 113
 114 .. toctree::
 115    :maxdepth: 1
 116    :titlesonly:
 117
 118    ../../../submodules/dmaap/datarouter.git/docs/index
 119
 120 Data Management as a Platform Message Router
 121 --------------------------------------------
 122
 123 .. toctree::
 124    :maxdepth: 2
 125    :titlesonly:
 126
 127    ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
 128
 129 Development Tools
 130 -----------------
 131
 132 .. toctree::
 133    :maxdepth: 1
 134    :titlesonly:
 135
 136    ../../../submodules/integration/devtool.git/docs/source/index
 137
 138
 139 External API Framework
 140 ----------------------
 141
 142 .. toctree::
 143    :maxdepth: 2
 144    :titlesonly:
 145
 146    ../../../submodules/externalapi/nbi.git/docs/index
 147
 148
 149 Holmes
 150 ------
 151
 152 .. toctree::
 153    :maxdepth: 2
 154    :titlesonly:
 155
 156    Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
 157    Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
 158
 159 Integration
 160 -----------
 161
 162 .. toctree::
 163    :maxdepth: 1
 164    :titlesonly:
 165
 166    ../../../submodules/integration.git/docs/index
 167
 168 Logging Analytics
 169 -----------------
 170
 171 .. toctree::
 172    :maxdepth: 2
 173    :titlesonly:
 174
 175    ../../../submodules/logging-analytics.git/docs/index
 176
 177 Micro Services Bus
 178 ------------------
 179
 180 .. toctree::
 181    :maxdepth: 2
 182    :titlesonly:
 183
 184    ../../../submodules/msb/apigateway.git/docs/index
 185    ../../../submodules/msb/swagger-sdk.git/docs/index
 186
 187 .. Empty folders in this release
 188    ../../../submodules/msb/discovery.git/docs/index
 189    ../../../submodules/msb/java-sdk.git/docs/index
 190
 191
 192 Modeling
 193 --------
 194
 195 .. toctree::
 196    :maxdepth: 2
 197    :titlesonly:
 198
 199    ../../../submodules/modeling/modelspec.git/docs/index
 200    ../../../submodules/modeling/toscaparsers.git/docs/index
 201
 202 MultiVIM Cloud
 203 --------------
 204
 205 .. toctree::
 206    :maxdepth: 2
 207    :titlesonly:
 208
 209    ../../../submodules/multicloud/framework.git/docs/index
 210
 211 Music
 212 -----
 213
 214 .. toctree::
 215    :maxdepth: 2
 216    :titlesonly:
 217
 218    ../../../submodules/music.git/docs/index
 219    ../../../submodules/music/distributed-kv-store.git/docs/index
 220
 221 ONAP Operations Manager
 222 -----------------------
 223
 224 .. toctree::
 225    :maxdepth: 2
 226    :titlesonly:
 227
 228    ../../../submodules/oom.git/docs/index
 229
 230 Optimization Framework
 231 ----------------------
 232
 233 .. toctree::
 234    :maxdepth: 2
 235    :titlesonly:
 236
 237    ../../../submodules/optf/has.git/docs/index
 238    ../../../submodules/optf/osdf.git/docs/index
 239    ../../../submodules/optf/cmso.git/docs/index
 240
 241 Policy Framework
 242 ----------------
 243
 244 .. toctree::
 245    :maxdepth: 2
 246    :titlesonly:
 247
 248    ../../../submodules/policy/parent.git/docs/index
 249    ../../../submodules/policy/engine.git/docs/index
 250
 251 Portal Platform
 252 ---------------
 253
 254 .. toctree::
 255    :maxdepth: 2
 256    :titlesonly:
 257
 258    ../../../submodules/portal.git/docs/index
 259
 260 Service Design & Creation
 261 -------------------------
 262
 263 .. toctree::
 264    :maxdepth: 2
 265    :titlesonly:
 266
 267    ../../../submodules/sdc.git/docs/index
 268
 269 .. Empty folders for this release
 270    ../../../submodules/sdc/jtosca.git/docs/index
 271    ../../../submodules/sdc/sdc-distribution-client.git/docs/index
 272    ../../../submodules/sdc/sdc-docker-base.git/docs/index
 273    ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
 274    ../../../submodules/sdc/sdc-tosca.git/docs/index
 275    ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
 276
 277 Service Orchestration
 278 ---------------------
 279
 280 .. toctree::
 281    :maxdepth: 2
 282    :titlesonly:
 283
 284    ../../../submodules/so.git/docs/index
 285    ../../../submodules/so/libs.git/docs/index
 286
 287 Software Defined Network Controller
 288 -----------------------------------
 289
 290 .. toctree::
 291    :maxdepth: 2
 292    :titlesonly:
 293
 294    ../../../submodules/sdnc/oam.git/docs/index
 295
 296 .. Empty folders for this release
 297    ../../../submodules/sdnc/adaptors.git/docs/index
 298    ../../../submodules/sdnc/architecture.git/docs/index
 299    ../../../submodules/sdnc/core.git/docs/index
 300    ../../../submodules/sdnc/features.git/docs/index
 301    ../../../submodules/sdnc/northbound.git/docs/index
 302    ../../../submodules/sdnc/parent.git/docs/index
 303    ../../../submodules/sdnc/plugins.git/docs/index
 304
 305 Use Case User Interface
 306 -----------------------
 307
 308 .. toctree::
 309    :maxdepth: 2
 310    :titlesonly:
 311
 312    ../../../submodules/usecase-ui.git/docs/index
 313
 314 User Interface Applications
 315 ---------------------------
 316
 317 .. toctree::
 318    :maxdepth: 2
 319    :titlesonly:
 320
 321    ../../../submodules/ui/dmaapbc.git/docs/index
 322
 323 Virtual Function Controller
 324 ---------------------------
 325
 326 .. toctree::
 327    :maxdepth: 2
 328    :titlesonly:
 329
 330    ../../../submodules/vfc/nfvo/lcm.git/docs/index
 331
 332 Virtual Infrastructure Deployment
 333 ---------------------------------
 334
 335 .. toctree::
 336    :maxdepth: 2
 337    :titlesonly:
 338
 339
 340    ../../../submodules/vid.git/docs/index
 341
 342 .. Empty folders for this release
 343    ../../../submodules/vid/asdcclient.git/docs/index
 344
 345 VNF Software Development Kit
 346 ----------------------------
 347
 348 .. toctree::
 349    :maxdepth: 2
 350    :titlesonly:
 351
 352    ../../../submodules/vnfsdk/model.git/docs/index