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