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