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