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