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