Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 6bcb0b16e9ce5bf7423e73690ea14756ae19fb16 / . / docs / guides / onap-developer / developing / index.rst
blob: c273d11d0aa20159edebdacb9386697b8ab88444 [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
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]77
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]78.. Being consolidated in ccsdk distribution
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]79 ../../../submodules/ccsdk/platform/blueprints.git/docs/index
80 ../../../submodules/ccsdk/platform/nbapi.git/docs/index
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]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
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]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
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]89
90Data Collection, Analysis, and Events
91-------------------------------------
92
93.. toctree::
94 :maxdepth: 2
95 :titlesonly:
96
97 ../../../submodules/dcaegen2.git/docs/index
98
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]99Data Management as a Platform Data Bus Controller
100-------------------------------------------------
101
102.. toctree::
103 :maxdepth: 1
104 :titlesonly:
105
106 ../../../submodules/dmaap/dbcapi.git/docs/index
Rich Bennett0193cf62018-10-25 13:39:18 -0400[diff] [blame]107 ../../../submodules/dmaap/buscontroller.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]108
109Data Management as a Platform Data Router
110-----------------------------------------
111
112.. toctree::
113 :maxdepth: 1
114 :titlesonly:
115
116 ../../../submodules/dmaap/datarouter.git/docs/index
117
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]118Data 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
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]127Development Tools
128-----------------
129
130.. toctree::
131 :maxdepth: 1
132 :titlesonly:
133
134 ../../../submodules/integration/devtool.git/docs/source/index
135
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]136Documentation
137-------------
138
139.. toctree::
140 :maxdepth: 2
141 :titlesonly:
142
143 ../how-to-use-docs/index.rst
144
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]145
Rich Bennettf9039002018-03-29 08:02:07 -0400[diff] [blame]146External API Framework
147----------------------
148
149.. toctree::
150 :maxdepth: 2
151 :titlesonly:
152
153 ../../../submodules/externalapi/nbi.git/docs/index
154
155
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]156Holmes
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
166Integration
167-----------
168
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]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>`.
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]172
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]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
176Logging Analytics
177-----------------
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]178
179.. toctree::
180 :maxdepth: 2
181 :titlesonly:
182
183 ../../../submodules/logging-analytics.git/docs/index
184
185Micro 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
200Modeling
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
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]210MultiVIM Cloud
Rich Bennett52314e12017-11-09 12:00:11 -0500[diff] [blame]211--------------
212
213.. toctree::
214 :maxdepth: 2
215 :titlesonly:
216
217 ../../../submodules/multicloud/framework.git/docs/index
218
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]219Music
220-----
221
222.. toctree::
223 :maxdepth: 2
224 :titlesonly:
225
226 ../../../submodules/music.git/docs/index
Rich Bennett36a88382018-10-02 15:58:37 -0400[diff] [blame]227 ../../../submodules/music/distributed-kv-store.git/docs/index
Rich Bennett304f7b52018-03-21 11:16:09 -0400[diff] [blame]228
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]229ONAP Operations Manager
230-----------------------
Rich Bennett83a20b82017-11-13 10:27:39 -0500[diff] [blame]231
232.. toctree::
233 :maxdepth: 2
234 :titlesonly:
235
236 ../../../submodules/oom.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]237
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]238Optimization Framework
239----------------------
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]240
241.. toctree::
242 :maxdepth: 2
243 :titlesonly:
244
245 ../../../submodules/optf/has.git/docs/index
246 ../../../submodules/optf/osdf.git/docs/index
vrvarma009179b2018-11-08 19:36:13 -0500[diff] [blame]247 ../../../submodules/optf/cmso.git/docs/index
Shankar Narayananff2fb8b2018-06-05 15:44:36 -0400[diff] [blame]248
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]249Policy Framework
250----------------
251
252.. toctree::
253 :maxdepth: 2
254 :titlesonly:
255
256 ../../../submodules/policy/engine.git/docs/index
mmisc394be42018-10-09 12:05:34 +0000[diff] [blame]257 ../../../submodules/policy/apex-pdp.git/docs/index
Rich Bennett6bcb0b12018-11-22 09:09:54 -0500[diff] [blame^]258 ../../../submodules/policy/distribution.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]259
260Portal Platform
261---------------
262
263.. toctree::
264 :maxdepth: 2
265 :titlesonly:
266
267 ../../../submodules/portal.git/docs/index
268
269Service Design & Creation
270-------------------------
271
272.. toctree::
273 :maxdepth: 2
274 :titlesonly:
275
276 ../../../submodules/sdc.git/docs/index
277
278.. Empty folders for this release
279 ../../../submodules/sdc/jtosca.git/docs/index
280 ../../../submodules/sdc/sdc-distribution-client.git/docs/index
281 ../../../submodules/sdc/sdc-docker-base.git/docs/index
282 ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
283 ../../../submodules/sdc/sdc-tosca.git/docs/index
284 ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
285
286Service Orchestration
287---------------------
288
289.. toctree::
290 :maxdepth: 2
291 :titlesonly:
292
293 ../../../submodules/so.git/docs/index
294 ../../../submodules/so/libs.git/docs/index
295
296Software Defined Network Controller
297-----------------------------------
298
299.. toctree::
300 :maxdepth: 2
301 :titlesonly:
302
303 ../../../submodules/sdnc/oam.git/docs/index
304
305.. Empty folders for this release
306 ../../../submodules/sdnc/adaptors.git/docs/index
307 ../../../submodules/sdnc/architecture.git/docs/index
308 ../../../submodules/sdnc/core.git/docs/index
309 ../../../submodules/sdnc/features.git/docs/index
310 ../../../submodules/sdnc/northbound.git/docs/index
311 ../../../submodules/sdnc/parent.git/docs/index
312 ../../../submodules/sdnc/plugins.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