Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / c02ed362a5d498fcc21d6c495e5c92523a3fe76b / . / docs / guides / onap-developer / developing / index.rst
blob: b92541769975e3d2ebf1d582b581b6f9f9b8718a [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
96Holmes
97------
98
99.. toctree::
100 :maxdepth: 2
101 :titlesonly:
102
103 Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
104 Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
105
106Integration
107-----------
108
Gildas Lanilisc0263552017-11-28 12:26:19 -0800[diff] [blame]109* ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest<doc-release-manifest>`.
110* 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]111
112Logging Enhancements Project
113----------------------------
114
115.. toctree::
116 :maxdepth: 2
117 :titlesonly:
118
119 ../../../submodules/logging-analytics.git/docs/index
120
121Micro Services Bus
122------------------
123
124.. toctree::
125 :maxdepth: 2
126 :titlesonly:
127
128 ../../../submodules/msb/apigateway.git/docs/index
129 ../../../submodules/msb/swagger-sdk.git/docs/index
130
131.. Empty folders in this release
132 ../../../submodules/msb/discovery.git/docs/index
133 ../../../submodules/msb/java-sdk.git/docs/index
134
135
136Modeling
137--------
138
139.. toctree::
140 :maxdepth: 2
141 :titlesonly:
142
143 ../../../submodules/modeling/modelspec.git/docs/index
144 ../../../submodules/modeling/toscaparsers.git/docs/index
145
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]146MultiVIM Cloud
Rich Bennett52314e12017-11-09 12:00:11 -0500[diff] [blame]147--------------
148
149.. toctree::
150 :maxdepth: 2
151 :titlesonly:
152
153 ../../../submodules/multicloud/framework.git/docs/index
154
155
Denes Nemetheea9a622018-03-09 13:08:41 +0100[diff] [blame]156Nokia SVNFM driver
157------------------
158
159.. toctree::
160 :maxdepth: 2
161 :titlesonly:
162
163 ../../../submodules/vfc/svnfm.git/nokiav2/docs/index
164
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]165ONAP Command Line Interface
166---------------------------
167
168.. toctree::
169 :maxdepth: 2
170 :titlesonly:
171
172 ../../../submodules/cli.git/docs/index
173
Rich Bennett83a20b82017-11-13 10:27:39 -0500[diff] [blame]174ONAP Operations Manager (experimental)
175--------------------------------------
176
177.. toctree::
178 :maxdepth: 2
179 :titlesonly:
180
181 ../../../submodules/oom.git/docs/index
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]182
Rich Bennett039faf72017-11-06 16:46:01 -0500[diff] [blame]183ONAP Use Case User Interface
184----------------------------
185
186.. toctree::
187 :maxdepth: 2
188 :titlesonly:
189
190 ../../../submodules/usecase-ui.git/docs/index
191
192Policy Framework
193----------------
194
195.. toctree::
196 :maxdepth: 2
197 :titlesonly:
198
199 ../../../submodules/policy/engine.git/docs/index
200
201Portal Platform
202---------------
203
204.. toctree::
205 :maxdepth: 2
206 :titlesonly:
207
208 ../../../submodules/portal.git/docs/index
209
210Service Design & Creation
211-------------------------
212
213.. toctree::
214 :maxdepth: 2
215 :titlesonly:
216
217 ../../../submodules/sdc.git/docs/index
218
219.. Empty folders for this release
220 ../../../submodules/sdc/jtosca.git/docs/index
221 ../../../submodules/sdc/sdc-distribution-client.git/docs/index
222 ../../../submodules/sdc/sdc-docker-base.git/docs/index
223 ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
224 ../../../submodules/sdc/sdc-tosca.git/docs/index
225 ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
226
227Service Orchestration
228---------------------
229
230.. toctree::
231 :maxdepth: 2
232 :titlesonly:
233
234 ../../../submodules/so.git/docs/index
235 ../../../submodules/so/libs.git/docs/index
236
237Software Defined Network Controller
238-----------------------------------
239
240.. toctree::
241 :maxdepth: 2
242 :titlesonly:
243
244 ../../../submodules/sdnc/oam.git/docs/index
245
246.. Empty folders for this release
247 ../../../submodules/sdnc/adaptors.git/docs/index
248 ../../../submodules/sdnc/architecture.git/docs/index
249 ../../../submodules/sdnc/core.git/docs/index
250 ../../../submodules/sdnc/features.git/docs/index
251 ../../../submodules/sdnc/northbound.git/docs/index
252 ../../../submodules/sdnc/parent.git/docs/index
253 ../../../submodules/sdnc/plugins.git/docs/index
254
255Virtual Function Controller
256---------------------------
257
258.. toctree::
259 :maxdepth: 2
260 :titlesonly:
261
262 ../../../submodules/vfc/nfvo/lcm.git/docs/index
263
264Virtual Infrastructure Deployment
265---------------------------------
266
267.. toctree::
268 :maxdepth: 2
269 :titlesonly:
270
271
272 ../../../submodules/vid.git/docs/index
273
274.. Empty folders for this release
275 ../../../submodules/vid/asdcclient.git/docs/index
276
277VNF Requirements
278----------------
279
280.. toctree::
281 :maxdepth: 2
282 :titlesonly:
283
284
285 ../../../submodules/vnfrqts/guidelines.git/docs/index
286 ../../../submodules/vnfrqts/requirements.git/docs/index
287
288VNF Software Development Kit
289----------------------------
290
291.. toctree::
292 :maxdepth: 2
293 :titlesonly:
294
295 ../../../submodules/vnfsdk/model.git/docs/index