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