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