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 * To install the whole ONAP (from a complete demo solution perspective)
 143   refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
 144
 145 Logging Analytics
 146 -----------------
 147
 148 .. toctree::
 149    :maxdepth: 2
 150    :titlesonly:
 151
 152    ../../../submodules/logging-analytics.git/docs/index
 153
 154 Micro Services Bus
 155 ------------------
 156
 157 .. toctree::
 158    :maxdepth: 2
 159    :titlesonly:
 160
 161    ../../../submodules/msb/apigateway.git/docs/index
 162    ../../../submodules/msb/swagger-sdk.git/docs/index
 163
 164 .. Empty folders in this release
 165    ../../../submodules/msb/discovery.git/docs/index
 166    ../../../submodules/msb/java-sdk.git/docs/index
 167
 168
 169 Modeling
 170 --------
 171
 172 .. toctree::
 173    :maxdepth: 2
 174    :titlesonly:
 175
 176    ../../../submodules/modeling/modelspec.git/docs/index
 177    ../../../submodules/modeling/toscaparsers.git/docs/index
 178
 179 MultiVIM Cloud
 180 --------------
 181
 182 .. toctree::
 183    :maxdepth: 2
 184    :titlesonly:
 185
 186    ../../../submodules/multicloud/framework.git/docs/index
 187
 188 Music
 189 -----
 190
 191 .. toctree::
 192    :maxdepth: 2
 193    :titlesonly:
 194
 195    ../../../submodules/music.git/docs/index
 196
 197 ONAP Operations Manager
 198 -----------------------
 199
 200 .. toctree::
 201    :maxdepth: 2
 202    :titlesonly:
 203
 204    ../../../submodules/oom.git/docs/index
 205
 206 Optimization Framework
 207 ----------------------
 208
 209 .. toctree::
 210    :maxdepth: 2
 211    :titlesonly:
 212
 213    ../../../submodules/optf/has.git/docs/index
 214    ../../../submodules/optf/osdf.git/docs/index
 215
 216 Policy Framework
 217 ----------------
 218
 219 .. toctree::
 220    :maxdepth: 2
 221    :titlesonly:
 222
 223    ../../../submodules/policy/engine.git/docs/index
 224
 225 Portal Platform
 226 ---------------
 227
 228 .. toctree::
 229    :maxdepth: 2
 230    :titlesonly:
 231
 232    ../../../submodules/portal.git/docs/index
 233
 234 Service Design & Creation
 235 -------------------------
 236
 237 .. toctree::
 238    :maxdepth: 2
 239    :titlesonly:
 240
 241    ../../../submodules/sdc.git/docs/index
 242
 243 .. Empty folders for this release
 244    ../../../submodules/sdc/jtosca.git/docs/index
 245    ../../../submodules/sdc/sdc-distribution-client.git/docs/index
 246    ../../../submodules/sdc/sdc-docker-base.git/docs/index
 247    ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
 248    ../../../submodules/sdc/sdc-tosca.git/docs/index
 249    ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
 250
 251 Service Orchestration
 252 ---------------------
 253
 254 .. toctree::
 255    :maxdepth: 2
 256    :titlesonly:
 257
 258    ../../../submodules/so.git/docs/index
 259    ../../../submodules/so/libs.git/docs/index
 260
 261 Software Defined Network Controller
 262 -----------------------------------
 263
 264 .. toctree::
 265    :maxdepth: 2
 266    :titlesonly:
 267
 268    ../../../submodules/sdnc/oam.git/docs/index
 269
 270 .. Empty folders for this release
 271    ../../../submodules/sdnc/adaptors.git/docs/index
 272    ../../../submodules/sdnc/architecture.git/docs/index
 273    ../../../submodules/sdnc/core.git/docs/index
 274    ../../../submodules/sdnc/features.git/docs/index
 275    ../../../submodules/sdnc/northbound.git/docs/index
 276    ../../../submodules/sdnc/parent.git/docs/index
 277    ../../../submodules/sdnc/plugins.git/docs/index
 278
 279 Use Case User Interface
 280 -----------------------
 281
 282 .. toctree::
 283    :maxdepth: 2
 284    :titlesonly:
 285
 286    ../../../submodules/usecase-ui.git/docs/index
 287
 288 User Interface Applications
 289 ---------------------------
 290
 291 .. toctree::
 292    :maxdepth: 2
 293    :titlesonly:
 294
 295    ../../../submodules/ui/dmaapbc.git/docs/index
 296
 297 Virtual Function Controller
 298 ---------------------------
 299
 300 .. toctree::
 301    :maxdepth: 2
 302    :titlesonly:
 303
 304    ../../../submodules/vfc/nfvo/lcm.git/docs/index
 305
 306 Virtual Infrastructure Deployment
 307 ---------------------------------
 308
 309 .. toctree::
 310    :maxdepth: 2
 311    :titlesonly:
 312
 313
 314    ../../../submodules/vid.git/docs/index
 315
 316 .. Empty folders for this release
 317    ../../../submodules/vid/asdcclient.git/docs/index
 318
 319 VNF Requirements
 320 ----------------
 321
 322 .. toctree::
 323    :maxdepth: 2
 324    :titlesonly:
 325
 326
 327    ../../../submodules/vnfrqts/guidelines.git/docs/index
 328    ../../../submodules/vnfrqts/requirements.git/docs/index
 329
 330 VNF Software Development Kit
 331 ----------------------------
 332
 333 .. toctree::
 334    :maxdepth: 2
 335    :titlesonly:
 336
 337    ../../../submodules/vnfsdk/model.git/docs/index
 338
 339 VNF Validation Project
 340 -----------------------
 341
 342 .. toctree::
 343    :maxdepth: 2
 344    :titlesonly:
 345
 346    ../../../submodules/vvp/documentation.git/docs/index