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