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 * ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest<doc-release-manifest>`.
 110 * To install the whole ONAP (from a complete demo solution perspective) refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
 111
 112 Logging Enhancements Project
 113 ----------------------------
 114
 115 .. toctree::
 116    :maxdepth: 2
 117    :titlesonly:
 118
 119    ../../../submodules/logging-analytics.git/docs/index
 120
 121 Micro Services Bus
 122 ------------------
 123
 124 .. toctree::
 125    :maxdepth: 2
 126    :titlesonly:
 127
 128    ../../../submodules/msb/apigateway.git/docs/index
 129    ../../../submodules/msb/swagger-sdk.git/docs/index
 130
 131 .. Empty folders in this release
 132    ../../../submodules/msb/discovery.git/docs/index
 133    ../../../submodules/msb/java-sdk.git/docs/index
 134
 135
 136 Modeling
 137 --------
 138
 139 .. toctree::
 140    :maxdepth: 2
 141    :titlesonly:
 142
 143    ../../../submodules/modeling/modelspec.git/docs/index
 144    ../../../submodules/modeling/toscaparsers.git/docs/index
 145
 146 MultiVIM Cloud
 147 --------------
 148
 149 .. toctree::
 150    :maxdepth: 2
 151    :titlesonly:
 152
 153    ../../../submodules/multicloud/framework.git/docs/index
 154
 155
 156 Nokia SVNFM driver
 157 ------------------
 158
 159 .. toctree::
 160    :maxdepth: 2
 161    :titlesonly:
 162
 163    ../../../submodules/vfc/svnfm.git/nokiav2/docs/index
 164
 165 ONAP Command Line Interface
 166 ---------------------------
 167
 168 .. toctree::
 169    :maxdepth: 2
 170    :titlesonly:
 171
 172    ../../../submodules/cli.git/docs/index
 173
 174 ONAP Operations Manager (experimental)
 175 --------------------------------------
 176
 177 .. toctree::
 178    :maxdepth: 2
 179    :titlesonly:
 180
 181    ../../../submodules/oom.git/docs/index
 182
 183 ONAP Use Case User Interface
 184 ----------------------------
 185
 186 .. toctree::
 187    :maxdepth: 2
 188    :titlesonly:
 189
 190    ../../../submodules/usecase-ui.git/docs/index
 191
 192 Policy Framework
 193 ----------------
 194
 195 .. toctree::
 196    :maxdepth: 2
 197    :titlesonly:
 198
 199    ../../../submodules/policy/engine.git/docs/index
 200
 201 Portal Platform
 202 ---------------
 203
 204 .. toctree::
 205    :maxdepth: 2
 206    :titlesonly:
 207
 208    ../../../submodules/portal.git/docs/index
 209
 210 Service Design & Creation
 211 -------------------------
 212
 213 .. toctree::
 214    :maxdepth: 2
 215    :titlesonly:
 216
 217    ../../../submodules/sdc.git/docs/index
 218
 219 .. Empty folders for this release
 220    ../../../submodules/sdc/jtosca.git/docs/index
 221    ../../../submodules/sdc/sdc-distribution-client.git/docs/index
 222    ../../../submodules/sdc/sdc-docker-base.git/docs/index
 223    ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
 224    ../../../submodules/sdc/sdc-tosca.git/docs/index
 225    ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
 226
 227 Service Orchestration
 228 ---------------------
 229
 230 .. toctree::
 231    :maxdepth: 2
 232    :titlesonly:
 233
 234    ../../../submodules/so.git/docs/index
 235    ../../../submodules/so/libs.git/docs/index
 236
 237 Software Defined Network Controller
 238 -----------------------------------
 239
 240 .. toctree::
 241    :maxdepth: 2
 242    :titlesonly:
 243
 244    ../../../submodules/sdnc/oam.git/docs/index
 245
 246 .. Empty folders for this release
 247    ../../../submodules/sdnc/adaptors.git/docs/index
 248    ../../../submodules/sdnc/architecture.git/docs/index
 249    ../../../submodules/sdnc/core.git/docs/index
 250    ../../../submodules/sdnc/features.git/docs/index
 251    ../../../submodules/sdnc/northbound.git/docs/index
 252    ../../../submodules/sdnc/parent.git/docs/index
 253    ../../../submodules/sdnc/plugins.git/docs/index
 254
 255 Virtual Function Controller
 256 ---------------------------
 257
 258 .. toctree::
 259    :maxdepth: 2
 260    :titlesonly:
 261
 262    ../../../submodules/vfc/nfvo/lcm.git/docs/index
 263
 264 Virtual Infrastructure Deployment
 265 ---------------------------------
 266
 267 .. toctree::
 268    :maxdepth: 2
 269    :titlesonly:
 270
 271
 272    ../../../submodules/vid.git/docs/index
 273
 274 .. Empty folders for this release
 275    ../../../submodules/vid/asdcclient.git/docs/index
 276
 277 VNF Requirements
 278 ----------------
 279
 280 .. toctree::
 281    :maxdepth: 2
 282    :titlesonly:
 283
 284
 285    ../../../submodules/vnfrqts/guidelines.git/docs/index
 286    ../../../submodules/vnfrqts/requirements.git/docs/index
 287
 288 VNF Software Development Kit
 289 ----------------------------
 290
 291 .. toctree::
 292    :maxdepth: 2
 293    :titlesonly:
 294
 295    ../../../submodules/vnfsdk/model.git/docs/index