Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / b9e7fe509571a6ada96b19f14a5b09ce117e6b42 / . / docs / guides / onap-developer / developing / index.rst
blob: 5148ffdf62970ca5a3f384977b34df760bf1f058 [file] [log] [blame]
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]1.. This work is licensed under a Creative Commons Attribution
2.. 4.0 International License.
Rich Bennett1bf0d362017-10-20 05:08:11 -0400[diff] [blame]3.. http://creativecommons.org/licenses/by/4.0
4.. Copyright 2017 AT&T Intellectual Property. All rights reserved.
5
Rich Bennettb921b992017-11-17 08:28:37 -0500[diff] [blame]6.. index:: Developer Guides
7
Rich Bennett1bf0d362017-10-20 05:08:11 -0400[diff] [blame]8.. _doc_onap-developer_guide_projects:
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]9
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]10ONAP components and functionalities
11===================================
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]12Additional developer level detail is provided for each project below.
13
14Active and Available Inventory
15------------------------------
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]16
Rich Bennett1bf0d362017-10-20 05:08:11 -0400[diff] [blame]17.. toctree::
18 :maxdepth: 2
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]19 :titlesonly:
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]20
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]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
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]25 ../../../submodules/aai/event-client.git/docs/index.rst
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]26
27
28Application 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
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]38Application Authorization Framework
39-----------------------------------
40
41.. toctree::
42 :maxdepth: 2
43 :titlesonly:
44
45 ../../../submodules/aaf/authz.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]46 Secret Management Service <../../../submodules/aaf/sms.git/docs/index>
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]47
48Command Line Interface
49----------------------
50
51.. toctree::
52 :maxdepth: 2
53 :titlesonly:
54
55 ../../../submodules/cli.git/docs/index
56
57
andreasgeisslerb9e7fe52019-09-02 13:52:02 +0200[diff] [blame^]58Control Loop Automation Management Platform
59-------------------------------------------
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]60
61.. toctree::
62 :maxdepth: 2
63 :titlesonly:
64
65 ../../../submodules/clamp.git/docs/index
66
67Common 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
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]76 ../../../submodules/ccsdk/platform/plugins.git/docs/index
ezhil14f8a6c2019-01-04 14:24:23 +0530[diff] [blame]77 ../../../submodules/ccsdk/apps.git/docs/index
Ezhilarasib5aa4082019-02-11 18:02:04 +0200[diff] [blame]78 ../../../submodules/ccsdk/cds.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]79
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]80.. Being consolidated in ccsdk distribution
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]81 ../../../submodules/ccsdk/platform/blueprints.git/docs/index
82 ../../../submodules/ccsdk/platform/nbapi.git/docs/index
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]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
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]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
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]91
92Data Collection, Analysis, and Events
93-------------------------------------
94
95.. toctree::
96 :maxdepth: 2
97 :titlesonly:
98
99 ../../../submodules/dcaegen2.git/docs/index
100
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]101Data Management as a Platform Data Bus Controller
102-------------------------------------------------
103
104.. toctree::
105 :maxdepth: 1
106 :titlesonly:
107
108 ../../../submodules/dmaap/dbcapi.git/docs/index
Rich Bennett0193cf62018-10-25 13:39:18 -0400[diff] [blame]109 ../../../submodules/dmaap/buscontroller.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]110
111Data Management as a Platform Data Router
112-----------------------------------------
113
114.. toctree::
115 :maxdepth: 1
116 :titlesonly:
117
118 ../../../submodules/dmaap/datarouter.git/docs/index
119
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]120Data 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
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]129Development Tools
130-----------------
131
132.. toctree::
133 :maxdepth: 1
134 :titlesonly:
135
136 ../../../submodules/integration/devtool.git/docs/source/index
137
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]138
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]139External API Framework
140----------------------
141
142.. toctree::
143 :maxdepth: 2
144 :titlesonly:
145
146 ../../../submodules/externalapi/nbi.git/docs/index
147
148
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]149Holmes
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
159Integration
160-----------
161
Yang Xue8f84e42019-06-21 19:30:15 -0400[diff] [blame]162.. toctree::
163 :maxdepth: 1
164 :titlesonly:
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]165
Yang Xue8f84e42019-06-21 19:30:15 -0400[diff] [blame]166 ../../../submodules/integration.git/docs/index
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]167
168Logging Analytics
169-----------------
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]170
171.. toctree::
172 :maxdepth: 2
173 :titlesonly:
174
175 ../../../submodules/logging-analytics.git/docs/index
176
177Micro Services Bus
178------------------
179
180.. toctree::
181 :maxdepth: 2
182 :titlesonly:
183
184 ../../../submodules/msb/apigateway.git/docs/index
185 ../../../submodules/msb/swagger-sdk.git/docs/index
186
187.. Empty folders in this release
188 ../../../submodules/msb/discovery.git/docs/index
189 ../../../submodules/msb/java-sdk.git/docs/index
190
191
192Modeling
193--------
194
195.. toctree::
196 :maxdepth: 2
197 :titlesonly:
198
199 ../../../submodules/modeling/modelspec.git/docs/index
200 ../../../submodules/modeling/toscaparsers.git/docs/index
201
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]202MultiVIM Cloud
Rich Bennett52314e12017-11-09 12:00:11 -0500[diff] [blame]203--------------
204
205.. toctree::
206 :maxdepth: 2
207 :titlesonly:
208
209 ../../../submodules/multicloud/framework.git/docs/index
210
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]211Music
212-----
213
214.. toctree::
215 :maxdepth: 2
216 :titlesonly:
217
218 ../../../submodules/music.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]219 ../../../submodules/music/distributed-kv-store.git/docs/index
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]220
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]221ONAP Operations Manager
222-----------------------
Rich Bennett83a20b82017-11-13 10:27:39 -0500[diff] [blame]223
224.. toctree::
225 :maxdepth: 2
226 :titlesonly:
227
228 ../../../submodules/oom.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]229
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]230Optimization Framework
231----------------------
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]232
233.. toctree::
234 :maxdepth: 2
235 :titlesonly:
236
237 ../../../submodules/optf/has.git/docs/index
238 ../../../submodules/optf/osdf.git/docs/index
vrvarma009179b2018-11-08 19:36:13 -0500[diff] [blame]239 ../../../submodules/optf/cmso.git/docs/index
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]240
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]241Policy Framework
242----------------
243
244.. toctree::
245 :maxdepth: 2
246 :titlesonly:
247
Pamela Dragosh1301b482019-05-29 11:48:04 -0400[diff] [blame]248 ../../../submodules/policy/parent.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]249 ../../../submodules/policy/engine.git/docs/index
250
251Portal Platform
252---------------
253
254.. toctree::
255 :maxdepth: 2
256 :titlesonly:
257
258 ../../../submodules/portal.git/docs/index
259
260Service Design & Creation
261-------------------------
262
263.. toctree::
264 :maxdepth: 2
265 :titlesonly:
266
267 ../../../submodules/sdc.git/docs/index
268
269.. Empty folders for this release
270 ../../../submodules/sdc/jtosca.git/docs/index
271 ../../../submodules/sdc/sdc-distribution-client.git/docs/index
272 ../../../submodules/sdc/sdc-docker-base.git/docs/index
273 ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
274 ../../../submodules/sdc/sdc-tosca.git/docs/index
275 ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
276
277Service Orchestration
278---------------------
279
280.. toctree::
281 :maxdepth: 2
282 :titlesonly:
283
284 ../../../submodules/so.git/docs/index
285 ../../../submodules/so/libs.git/docs/index
286
287Software Defined Network Controller
288-----------------------------------
289
290.. toctree::
291 :maxdepth: 2
292 :titlesonly:
293
294 ../../../submodules/sdnc/oam.git/docs/index
295
296.. Empty folders for this release
297 ../../../submodules/sdnc/adaptors.git/docs/index
298 ../../../submodules/sdnc/architecture.git/docs/index
299 ../../../submodules/sdnc/core.git/docs/index
300 ../../../submodules/sdnc/features.git/docs/index
301 ../../../submodules/sdnc/northbound.git/docs/index
302 ../../../submodules/sdnc/parent.git/docs/index
303 ../../../submodules/sdnc/plugins.git/docs/index
304
sai-neetha93d30e02019-07-25 14:10:37 +0200[diff] [blame]305Software Defined Network Controller for Radio (SDN-R)
306-----------------------------------------------------
307
308.. toctree::
309 :maxdepth: 2
310 :titlesonly:
311
312 ../../../submodules/ccsdk/features.git/docs/index
313
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]314Use Case User Interface
315-----------------------
316
317.. toctree::
318 :maxdepth: 2
319 :titlesonly:
320
321 ../../../submodules/usecase-ui.git/docs/index
322
Rich Bennett054fce62018-05-22 00:07:55 -0400[diff] [blame]323User Interface Applications
324---------------------------
325
326.. toctree::
327 :maxdepth: 2
328 :titlesonly:
329
330 ../../../submodules/ui/dmaapbc.git/docs/index
331
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]332Virtual Function Controller
333---------------------------
334
335.. toctree::
336 :maxdepth: 2
337 :titlesonly:
338
339 ../../../submodules/vfc/nfvo/lcm.git/docs/index
340
341Virtual Infrastructure Deployment
342---------------------------------
343
344.. toctree::
345 :maxdepth: 2
346 :titlesonly:
347
348
349 ../../../submodules/vid.git/docs/index
350
351.. Empty folders for this release
352 ../../../submodules/vid/asdcclient.git/docs/index
353
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]354VNF Software Development Kit
355----------------------------
356
357.. toctree::
358 :maxdepth: 2
359 :titlesonly:
360
361 ../../../submodules/vnfsdk/model.git/docs/index