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