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