docs/guides/onap-developer/developing/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5 .. index:: Developer Guides
   6
   7 .. _doc_onap-developer_guide_projects:
   8
   9 Developing ONAP
  10 ===============
  11 Additional developer level detail is provided for each project below.
  12
  13 Active and Available Inventory
  14 ------------------------------
  15
  16 .. toctree::
  17    :maxdepth: 2
  18    :titlesonly:
  19
  20    ../../../submodules/aai/aai-common.git/docs/index
  21    AAI-esr-gui <../../../submodules/aai/esr-gui.git/docs/index>
  22    ../../../submodules/aai/esr-server.git/docs/index
  23    ../../../submodules/aai/sparky-be.git/docs/index
  24
  25
  26 Application Controller
  27 ----------------------
  28
  29 .. toctree::
  30    :maxdepth: 2
  31    :titlesonly:
  32
  33    ../../../submodules/appc/deployment.git/docs/index
  34    ../../../submodules/appc.git/docs/index
  35
  36 Closed Loop Automation Platform
  37 -------------------------------
  38
  39 .. toctree::
  40    :maxdepth: 2
  41    :titlesonly:
  42
  43    ../../../submodules/clamp.git/docs/index
  44
  45 Common Controller Software Development Kit
  46 ------------------------------------------
  47
  48 .. toctree::
  49    :maxdepth: 2
  50    :titlesonly:
  51
  52    ../../../submodules/ccsdk/distribution.git/docs/index
  53    ../../../submodules/ccsdk/dashboard.git/docs/index
  54
  55 .. Being consolidated in ccsdk distribution
  56    ../../../submodules/ccsdk/platform/blueprints.git/docs/index
  57    ../../../submodules/ccsdk/platform/nbapi.git/docs/index
  58    ../../../submodules/ccsdk/storage/esaas.git/docs/index
  59    ../../../submodules/ccsdk/storage/pgaas.git/docs/index
  60    ../../../submodules/ccsdk/utils.git/docs/index
  61    ../../../submodules/ccsdk/parent.git/docs/index
  62    ../../../submodules/ccsdk/platform/plugins.git/docs/index
  63    ../../../submodules/ccsdk/sli/adaptors.git/docs/index
  64    ../../../submodules/ccsdk/sli/core.git/docs/index
  65    ../../../submodules/ccsdk/sli/northbound.git/docs/index
  66    ../../../submodules/ccsdk/sli/plugins.git/docs/index
  67
  68 Data Collection, Analysis, and Events
  69 -------------------------------------
  70
  71 .. toctree::
  72    :maxdepth: 2
  73    :titlesonly:
  74
  75    ../../../submodules/dcaegen2.git/docs/index
  76
  77 Data Management as a Platform Message Router
  78 --------------------------------------------
  79
  80 .. toctree::
  81    :maxdepth: 2
  82    :titlesonly:
  83
  84    ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
  85
  86 Documentation
  87 -------------
  88
  89 .. toctree::
  90    :maxdepth: 2
  91    :titlesonly:
  92
  93    ../how-to-use-docs/index.rst
  94
  95
  96 Holmes
  97 ------
  98
  99 .. toctree::
 100    :maxdepth: 2
 101    :titlesonly:
 102
 103    Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
 104    Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
 105
 106 Integration
 107 -----------
 108
 109 .. toctree::
 110    :maxdepth: 2
 111    :titlesonly:
 112
 113    ../../../submodules/integration.git/docs/index
 114
 115 Logging Enhancements Project
 116 ----------------------------
 117
 118 .. toctree::
 119    :maxdepth: 2
 120    :titlesonly:
 121
 122    ../../../submodules/logging-analytics.git/docs/index
 123
 124 Micro Services Bus
 125 ------------------
 126
 127 .. toctree::
 128    :maxdepth: 2
 129    :titlesonly:
 130
 131    ../../../submodules/msb/apigateway.git/docs/index
 132    ../../../submodules/msb/swagger-sdk.git/docs/index
 133
 134 .. Empty folders in this release
 135    ../../../submodules/msb/discovery.git/docs/index
 136    ../../../submodules/msb/java-sdk.git/docs/index
 137
 138
 139 Modeling
 140 --------
 141
 142 .. toctree::
 143    :maxdepth: 2
 144    :titlesonly:
 145
 146    ../../../submodules/modeling/modelspec.git/docs/index
 147    ../../../submodules/modeling/toscaparsers.git/docs/index
 148
 149 MultiVIM Cloud
 150 --------------
 151
 152 .. toctree::
 153    :maxdepth: 2
 154    :titlesonly:
 155
 156    ../../../submodules/multicloud/framework.git/docs/index
 157
 158
 159 ONAP Command Line Interface
 160 ---------------------------
 161
 162 .. toctree::
 163    :maxdepth: 2
 164    :titlesonly:
 165
 166    ../../../submodules/cli.git/docs/index
 167
 168 ONAP Operations Manager (experimental)
 169 --------------------------------------
 170
 171 .. toctree::
 172    :maxdepth: 2
 173    :titlesonly:
 174
 175    ../../../submodules/oom.git/docs/index
 176
 177 ONAP Use Case User Interface
 178 ----------------------------
 179
 180 .. toctree::
 181    :maxdepth: 2
 182    :titlesonly:
 183
 184    ../../../submodules/usecase-ui.git/docs/index
 185
 186 Policy Framework
 187 ----------------
 188
 189 .. toctree::
 190    :maxdepth: 2
 191    :titlesonly:
 192
 193    ../../../submodules/policy/engine.git/docs/index
 194
 195 Portal Platform
 196 ---------------
 197
 198 .. toctree::
 199    :maxdepth: 2
 200    :titlesonly:
 201
 202    ../../../submodules/portal.git/docs/index
 203
 204 Service Design & Creation
 205 -------------------------
 206
 207 .. toctree::
 208    :maxdepth: 2
 209    :titlesonly:
 210
 211    ../../../submodules/sdc.git/docs/index
 212
 213 .. Empty folders for this release
 214    ../../../submodules/sdc/jtosca.git/docs/index
 215    ../../../submodules/sdc/sdc-distribution-client.git/docs/index
 216    ../../../submodules/sdc/sdc-docker-base.git/docs/index
 217    ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
 218    ../../../submodules/sdc/sdc-tosca.git/docs/index
 219    ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
 220
 221 Service Orchestration
 222 ---------------------
 223
 224 .. toctree::
 225    :maxdepth: 2
 226    :titlesonly:
 227
 228    ../../../submodules/so.git/docs/index
 229    ../../../submodules/so/libs.git/docs/index
 230
 231 Software Defined Network Controller
 232 -----------------------------------
 233
 234 .. toctree::
 235    :maxdepth: 2
 236    :titlesonly:
 237
 238    ../../../submodules/sdnc/oam.git/docs/index
 239
 240 .. Empty folders for this release
 241    ../../../submodules/sdnc/adaptors.git/docs/index
 242    ../../../submodules/sdnc/architecture.git/docs/index
 243    ../../../submodules/sdnc/core.git/docs/index
 244    ../../../submodules/sdnc/features.git/docs/index
 245    ../../../submodules/sdnc/northbound.git/docs/index
 246    ../../../submodules/sdnc/parent.git/docs/index
 247    ../../../submodules/sdnc/plugins.git/docs/index
 248
 249 Virtual Function Controller
 250 ---------------------------
 251
 252 .. toctree::
 253    :maxdepth: 2
 254    :titlesonly:
 255
 256    ../../../submodules/vfc/nfvo/lcm.git/docs/index
 257
 258 Virtual Infrastructure Deployment
 259 ---------------------------------
 260
 261 .. toctree::
 262    :maxdepth: 2
 263    :titlesonly:
 264
 265
 266    ../../../submodules/vid.git/docs/index
 267
 268 .. Empty folders for this release
 269    ../../../submodules/vid/asdcclient.git/docs/index
 270
 271 VNF Requirements
 272 ----------------
 273
 274 .. toctree::
 275    :maxdepth: 2
 276    :titlesonly:
 277
 278
 279    ../../../submodules/vnfrqts/guidelines.git/docs/index
 280    ../../../submodules/vnfrqts/requirements.git/docs/index
 281
 282 VNF Software Development Kit
 283 ----------------------------
 284
 285 .. toctree::
 286    :maxdepth: 2
 287    :titlesonly:
 288
 289    ../../../submodules/vnfsdk/model.git/docs/index