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