Newer
Older
Dimitrios Giannopoulos
committed
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="Openslice.io">
<link rel="canonical" href="http://openslice.io/develop/contributing/developing/">
<link rel="shortcut icon" href="../../img/favicon.ico">
<title>Developing - Openslice</title>
<link href="../../css/bootstrap.min.css" rel="stylesheet">
<link href="../../css/font-awesome.min.css" rel="stylesheet">
<link href="../../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
<link href="../../css/version-select.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
</head>
<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="../..">Openslice</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
<span class="navbar-toggler-icon"></span>
</button>
<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="../.." class="dropdown-item">Introduction</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Getting Started <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="../../deployment/" class="dropdown-item">Deployment/Installation</a>
</li>
<li>
<a href="../../nfvoconfig/" class="dropdown-item">NFV Orchestrator Configuration</a>
</li>
<li>
<a href="../../catalogs/" class="dropdown-item">Service Catalogs</a>
</li>
<li>
<a href="../../nfvcatalogs/" class="dropdown-item">NFV Catalogs</a>
</li>
<li>
<a href="../../lcm/" class="dropdown-item">LCM Rules</a>
</li>
<li>
<a href="../../architecture/consumingServicesFromExternalPartners/" class="dropdown-item">Consuming Services From External OSS</a>
</li>
<li>
<a href="../../service_inventory/" class="dropdown-item">Service Inventory</a>
</li>
<li>
<a href="../../alarms_actions/" class="dropdown-item">Alarms and Actions</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Design & Architecture <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="../../architecture/architecture/" class="dropdown-item">Architecture</a>
</li>
<li>
<a href="../../architecture/messagebus/" class="dropdown-item">Message bus</a>
</li>
<li>
<a href="../../architecture/osom/" class="dropdown-item">OSOM</a>
</li>
<li>
<a href="../../architecture/oauth/" class="dropdown-item">Authentication</a>
</li>
<li>
<a href="../../architecture/tmfapi/" class="dropdown-item">TMF API</a>
</li>
<li>
<a href="../../architecture/nfvapi/" class="dropdown-item">NFV API</a>
</li>
<li>
<a href="../../architecture/tmfweb/" class="dropdown-item">TMF WEB</a>
</li>
<li>
<a href="../../architecture/nfvweb/" class="dropdown-item">NFV WEB</a>
</li>
<li>
<a href="../../architecture/issuemgt/" class="dropdown-item">Issue management</a>
</li>
<li>
<a href="../../architecture/centrallog/" class="dropdown-item">Central logging</a>
</li>
</ul>
</li>
<li class="dropdown active">
<a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Contributing <b class="caret"></b></a>
<ul class="dropdown-menu">
<li>
<a href="./" class="dropdown-item active">Developing</a>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav ml-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href="../../architecture/centrallog/" class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" class="nav-link disabled">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/openslice" class="nav-link">openslice</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>
<div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
<ul class="nav flex-column">
<li class="nav-item" data-level="1"><a href="#developing" class="nav-link">Developing</a>
<ul class="nav flex-column">
<li class="nav-item" data-level="2"><a href="#slack" class="nav-link">Slack</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#general-subsystems" class="nav-link">General subsystems</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#oauth-server" class="nav-link">Oauth server</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#vnfnsd-catalog-management-and-nsd-deployment-api-service" class="nav-link">VNF/NSD Catalog Management and NSD Deployment API service</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#vnfnsd-catalog-management-and-nsd-deployment-web-ui-service" class="nav-link">VNF/NSD Catalog Management and NSD Deployment WEB UI service</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#versionrelease-management" class="nav-link">Version/release management</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-level="2"><a href="#wishlist" class="nav-link">Wishlist</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="developing">Developing</h1>
<p>Openslice backend services are mainly implemented with Java 17 or above and Spring boot.</p>
<p>Openslice uses various subsystems and depending on the module would you like to work, other subsystems must be present (you can disable them though in the code, e.g. at application.yml file)</p>
<p>To get the latest development branch:</p>
<pre><code>wget https://raw.githubusercontent.com/openslice/org.etsi.osl.main/develop/compose/deploy.sh
sudo ./deploy.sh develop [or replace develop with other branch name]
</code></pre>
<h2 id="slack">Slack</h2>
<ul>
<li>Slack: https://openslice.slack.com</li>
</ul>
<h2 id="general-subsystems">General subsystems</h2>
<ul>
<li>Docker and Docker Compose should be installed in your development environment</li>
</ul>
<h3 id="consul">Consul</h3>
<p>consul service registry should be up and running. You can launch consul with docker:
<code>sudo docker run -d --name consul -p 8500:8500 -p 8600:8600 consul</code></p>
<h3 id="activemq">ActiveMQ</h3>
<p>ActiveMQ is our messaging system. You can launch an instance of ActiveMQ:
<code>sudo docker run --name='activemq' -d -e 'ACTIVEMQ_NAME=amqp-srv1' -e 'ACTIVEMQ_REMOVE_DEFAULT_ACCOUNT=true' -e 'ACTIVEMQ_ADMIN_LOGIN=admin' -e 'ACTIVEMQ_ADMIN_PASSWORD=admin' -e 'ACTIVEMQ_WRITE_LOGIN=producer_login' -e 'ACTIVEMQ_WRITE_PASSWORD=producer_password' -e 'ACTIVEMQ_READ_LOGIN=consumer_login' -e 'ACTIVEMQ_READ_PASSWORD=consumer_password' -e 'ACTIVEMQ_JMX_LOGIN=jmx_login' -e 'ACTIVEMQ_JMX_PASSWORD=jmx_password' -e 'ACTIVEMQ_STATIC_TOPICS=topic1;topic2;topic3' -e 'ACTIVEMQ_STATIC_QUEUES=queue1;queue2;queue3' -e 'ACTIVEMQ_MIN_MEMORY=1024' -e 'ACTIVEMQ_MAX_MEMORY=4096' -e 'ACTIVEMQ_ENABLED_SCHEDULER=true' -v /home/ctranoris/testcompose/data/activemq:/data/activemq -v /var/log/activemq:/var/log/activemq -p 8161:8161 -p 61616:61616 -p 61613:61613 webcenter/activemq:5.14.3</code></p>
<h3 id="mysql-server">MySQL server</h3>
<p>We use mysql as a storage DB. Please make sure that you have it installed in your system. There are instructions on internet how to install it. Check also our docker-compose installation script</p>
<h2 id="oauth-server">Oauth server</h2>
<p>Keycloak is used as the authentication server.</p>
<blockquote>
<p>Note: Please check the Post installation steps -> Keycloak at localhost, at <a href="../../deployment/">Deployment/Installation</a>, if you are developing in a local environment</p>
</blockquote>
<h2 id="vnfnsd-catalog-management-and-nsd-deployment-api-service">VNF/NSD Catalog Management and NSD Deployment API service</h2>
<p>Clone the repository: https://github.com/openslice/org.etsi.osl.portal.api</p>
<p>Check the application.yml file. Default port is 13080. Especially the datasource username/password, server port.</p>
<p>make sure that the General subsystems are up and running as well as the OAuth server</p>
<p>run it with <code>mvn spring-boot:run</code></p>
<p>You can check your consul server if it registered. </p>
<h3 id="swagger-api">Swagger API</h3>
<p>Swagger API of the service is at <code>http://localhost:13000/osapi/swagger-ui/</code>. You can try there various REST actions and authenticate via the OAuth server</p>
<h2 id="vnfnsd-catalog-management-and-nsd-deployment-web-ui-service">VNF/NSD Catalog Management and NSD Deployment WEB UI service</h2>
<p>The Web UI is written in AngularJS</p>
<p>Clone the repository: https://github.com/openslice/org.etsi.osl.portal.web</p>
<p>by default the project org.etsi.osl.portal.api exposes the folder ../org.etsi.osl.portal.web/src/ in a folder testweb (Check class MvcConfig.java in org.etsi.osl.portal.api) for development. (In production nginx is used). Point your browser to <code>http://localhost:13000/osapi/testweb/index.html/</code></p>
<hr />
<h2 id="versionrelease-management">Version/release management</h2>
<p>Check this nice article on how we develop and release versions</p>
<p>https://nvie.com/posts/a-successful-git-branching-model/</p>
<p>We develop in the develop branch</p>
<hr />
<h2 id="wishlist">Wishlist</h2>
<p>Check also our wishlist of new features. You can add your own</p>
<p>See <a href="../wishlist/">Wishlist</a></p></div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>Copyright © 2019-2023 Openslice Project</p>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../../js/jquery-3.6.0.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script>
var base_url = "../..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../../js/base.js"></script>
<script src="../../js/version-select.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>