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