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