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 Control Loop Automation Management 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/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    ../../../submodules/dmaap/buscontroller.git/docs/index
 108
 109 Data Management as a Platform Data Router
 110 -----------------------------------------
 111
 112 .. toctree::
 113    :maxdepth: 1
 114    :titlesonly:
 115
 116    ../../../submodules/dmaap/datarouter.git/docs/index
 117
 118 Data Management as a Platform Message Router
 119 --------------------------------------------
 120
 121 .. toctree::
 122    :maxdepth: 2
 123    :titlesonly:
 124
 125    ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
 126
 127 Development Tools
 128 -----------------
 129
 130 .. toctree::
 131    :maxdepth: 1
 132    :titlesonly:
 133
 134    ../../../submodules/integration/devtool.git/docs/source/index
 135
 136
 137 External API Framework
 138 ----------------------
 139
 140 .. toctree::
 141    :maxdepth: 2
 142    :titlesonly:
 143
 144    ../../../submodules/externalapi/nbi.git/docs/index
 145
 146
 147 Holmes
 148 ------
 149
 150 .. toctree::
 151    :maxdepth: 2
 152    :titlesonly:
 153
 154    Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
 155    Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
 156
 157 Integration
 158 -----------
 159
 160 .. toctree::
 161    :maxdepth: 1
 162    :titlesonly:
 163
 164    ../../../submodules/integration.git/docs/index
 165
 166 Logging Analytics
 167 -----------------
 168
 169 .. toctree::
 170    :maxdepth: 2
 171    :titlesonly:
 172
 173    ../../../submodules/logging-analytics.git/docs/index
 174
 175 Micro Services Bus
 176 ------------------
 177
 178 .. toctree::
 179    :maxdepth: 2
 180    :titlesonly:
 181
 182    ../../../submodules/msb/apigateway.git/docs/index
 183    ../../../submodules/msb/swagger-sdk.git/docs/index
 184
 185 .. Empty folders in this release
 186    ../../../submodules/msb/discovery.git/docs/index
 187    ../../../submodules/msb/java-sdk.git/docs/index
 188
 189
 190 Modeling
 191 --------
 192
 193 .. toctree::
 194    :maxdepth: 2
 195    :titlesonly:
 196
 197    ../../../submodules/modeling/modelspec.git/docs/index
 198    ../../../submodules/modeling/toscaparsers.git/docs/index
 199
 200 MultiVIM Cloud
 201 --------------
 202
 203 .. toctree::
 204    :maxdepth: 2
 205    :titlesonly:
 206
 207    ../../../submodules/multicloud/framework.git/docs/index
 208
 209 Music
 210 -----
 211
 212 .. toctree::
 213    :maxdepth: 2
 214    :titlesonly:
 215
 216    ../../../submodules/music.git/docs/index
 217    ../../../submodules/music/distributed-kv-store.git/docs/index
 218
 219 ONAP Operations Manager
 220 -----------------------
 221
 222 .. toctree::
 223    :maxdepth: 2
 224    :titlesonly:
 225
 226    ../../../submodules/oom.git/docs/index
 227
 228 Optimization Framework
 229 ----------------------
 230
 231 .. toctree::
 232    :maxdepth: 2
 233    :titlesonly:
 234
 235    ../../../submodules/optf/has.git/docs/index
 236    ../../../submodules/optf/osdf.git/docs/index
 237    ../../../submodules/optf/cmso.git/docs/index
 238
 239 Policy Framework
 240 ----------------
 241
 242 .. toctree::
 243    :maxdepth: 2
 244    :titlesonly:
 245
 246    ../../../submodules/policy/parent.git/docs/index
 247    ../../../submodules/policy/engine.git/docs/index
 248
 249 Portal Platform
 250 ---------------
 251
 252 .. toctree::
 253    :maxdepth: 2
 254    :titlesonly:
 255
 256    ../../../submodules/portal.git/docs/index
 257
 258 Service Design & Creation
 259 -------------------------
 260
 261 .. toctree::
 262    :maxdepth: 2
 263    :titlesonly:
 264
 265    ../../../submodules/sdc.git/docs/index
 266
 267 .. Empty folders for this release
 268    ../../../submodules/sdc/jtosca.git/docs/index
 269    ../../../submodules/sdc/sdc-distribution-client.git/docs/index
 270    ../../../submodules/sdc/sdc-docker-base.git/docs/index
 271    ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
 272    ../../../submodules/sdc/sdc-tosca.git/docs/index
 273    ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
 274
 275 Service Orchestration
 276 ---------------------
 277
 278 .. toctree::
 279    :maxdepth: 2
 280    :titlesonly:
 281
 282    ../../../submodules/so.git/docs/index
 283    ../../../submodules/so/libs.git/docs/index
 284
 285 Software Defined Network Controller
 286 -----------------------------------
 287
 288 .. toctree::
 289    :maxdepth: 2
 290    :titlesonly:
 291
 292    ../../../submodules/sdnc/oam.git/docs/index
 293
 294 .. Empty folders for this release
 295    ../../../submodules/sdnc/adaptors.git/docs/index
 296    ../../../submodules/sdnc/architecture.git/docs/index
 297    ../../../submodules/sdnc/core.git/docs/index
 298    ../../../submodules/sdnc/features.git/docs/index
 299    ../../../submodules/sdnc/northbound.git/docs/index
 300    ../../../submodules/sdnc/parent.git/docs/index
 301    ../../../submodules/sdnc/plugins.git/docs/index
 302
 303 Software Defined Network Controller for Radio (SDN-R)
 304 -----------------------------------------------------
 305
 306 .. toctree::
 307    :maxdepth: 2
 308    :titlesonly:
 309
 310    ../../../submodules/ccsdk/features.git/docs/index
 311
 312 Use Case User Interface
 313 -----------------------
 314
 315 .. toctree::
 316    :maxdepth: 2
 317    :titlesonly:
 318
 319    ../../../submodules/usecase-ui.git/docs/index
 320
 321 Virtual Function Controller
 322 ---------------------------
 323
 324 .. toctree::
 325    :maxdepth: 2
 326    :titlesonly:
 327
 328    ../../../submodules/vfc/nfvo/lcm.git/docs/index
 329
 330 Virtual Infrastructure Deployment
 331 ---------------------------------
 332
 333 .. toctree::
 334    :maxdepth: 2
 335    :titlesonly:
 336
 337
 338    ../../../submodules/vid.git/docs/index
 339
 340 .. Empty folders for this release
 341    ../../../submodules/vid/asdcclient.git/docs/index
 342
 343 VNF Software Development Kit
 344 ----------------------------
 345
 346 .. toctree::
 347    :maxdepth: 2
 348    :titlesonly:
 349
 350    ../../../submodules/vnfsdk/model.git/docs/index