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