Newer
Older
Dimitrios Giannopoulos
committed
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="ETSI SDG OSL Documentation page">
<meta name="author" content="OpenSlice by ETSI">
<link rel="canonical" href="https://osl.etsi.org/release0/">
<link rel="next" href="deployment/">
<link rel="icon" href="images/favicon.png">
Dimitrios Giannopoulos
committed
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.8">
Dimitrios Giannopoulos
committed
<title>Introduction - ETSI SDG OSL Documentation</title>
Dimitrios Giannopoulos
committed
<link rel="stylesheet" href="assets/stylesheets/main.f2e4d321.min.css">
Dimitrios Giannopoulos
committed
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
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="cyan" data-md-color-accent="blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#usage" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="." title="ETSI SDG OSL Documentation" class="md-header__button md-logo" aria-label="ETSI SDG OSL Documentation" data-md-component="logo">
<img src="images/logo_osl.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
ETSI SDG OSL Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Introduction
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://labs.etsi.org/rep/osl" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81-2.9-.295-5.7.083-8.4 1.11-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.09 18.09 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3 4.7 0 9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82z"/></svg>
</div>
<div class="md-source__repository">
OSL GitLab
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
Dimitrios Giannopoulos
committed
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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="." title="ETSI SDG OSL Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG OSL Documentation" data-md-component="logo">
<img src="images/logo_osl.png" alt="logo">
</a>
ETSI SDG OSL Documentation
</label>
<div class="md-nav__source">
<a href="https://labs.etsi.org/rep/osl" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81-2.9-.295-5.7.083-8.4 1.11-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.09 18.09 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3 4.7 0 9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82z"/></svg>
</div>
<div class="md-source__repository">
OSL GitLab
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
Overview
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Overview
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Introduction
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Introduction
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
<span class="md-ellipsis">
Usage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#service-lifecycle-rules" class="md-nav__link">
<span class="md-ellipsis">
Service Lifecycle Rules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#multidomain-scenarios-and-federation" class="md-nav__link">
<span class="md-ellipsis">
Multidomain scenarios and federation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#live-demo" class="md-nav__link">
<span class="md-ellipsis">
Live Demo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#video-demo" class="md-nav__link">
<span class="md-ellipsis">
Video demo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#installing" class="md-nav__link">
<span class="md-ellipsis">
Installing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hardware-requirements" class="md-nav__link">
<span class="md-ellipsis">
Hardware requirements
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#supported-apis" class="md-nav__link">
<span class="md-ellipsis">
Supported APIs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#source-code" class="md-nav__link">
<span class="md-ellipsis">
Source code
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#contributing" class="md-nav__link">
<span class="md-ellipsis">
Contributing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#social-media" class="md-nav__link">
<span class="md-ellipsis">
Social Media
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#history" class="md-nav__link">
<span class="md-ellipsis">
History
</span>
</a>
Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="#ecosystem" class="md-nav__link">
<span class="md-ellipsis">
Ecosystem
</span>
</a>
Dimitrios Giannopoulos
committed
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
</li>
<li class="md-nav__item">
<a href="#citation" class="md-nav__link">
<span class="md-ellipsis">
Citation
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="deployment/" class="md-nav__link">
<span class="md-ellipsis">
Deployment/Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="nfvoconfig/" class="md-nav__link">
<span class="md-ellipsis">
NFV Orchestrator Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="catalogs/" class="md-nav__link">
<span class="md-ellipsis">
Service Catalogs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="nfvcatalogs/" class="md-nav__link">
<span class="md-ellipsis">
NFV Catalogs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="lcm/" class="md-nav__link">
<span class="md-ellipsis">
LCM Rules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/consumingServicesFromExternalPartners/" class="md-nav__link">
<span class="md-ellipsis">
Consuming Services From External OSS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="service_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Service Inventory
</span>
</a>
</li>
<li class="md-nav__item">
<a href="alarms_actions/" class="md-nav__link">
<span class="md-ellipsis">
Alarms and Actions
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Design & Architecture
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Design & Architecture
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="architecture/architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/messagebus/" class="md-nav__link">
<span class="md-ellipsis">
Message bus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/osom/" class="md-nav__link">
<span class="md-ellipsis">
OSOM
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/oauth/" class="md-nav__link">
<span class="md-ellipsis">
Authentication
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/tmfapi/" class="md-nav__link">
<span class="md-ellipsis">
TMF API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/nfvapi/" class="md-nav__link">
<span class="md-ellipsis">
NFV API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/tmfweb/" class="md-nav__link">
<span class="md-ellipsis">
TMF WEB
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/nfvweb/" class="md-nav__link">
<span class="md-ellipsis">
NFV WEB
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/issuemgt/" class="md-nav__link">
<span class="md-ellipsis">
Issue management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="architecture/centrallog/" class="md-nav__link">
<span class="md-ellipsis">
Central logging
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Contributing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="contributing/developing/" class="md-nav__link">
<span class="md-ellipsis">
Developing
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
<span class="md-ellipsis">
Usage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#service-lifecycle-rules" class="md-nav__link">
<span class="md-ellipsis">
Service Lifecycle Rules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#multidomain-scenarios-and-federation" class="md-nav__link">
<span class="md-ellipsis">
Multidomain scenarios and federation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#live-demo" class="md-nav__link">
<span class="md-ellipsis">
Live Demo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#video-demo" class="md-nav__link">
<span class="md-ellipsis">
Video demo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#installing" class="md-nav__link">
<span class="md-ellipsis">
Installing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hardware-requirements" class="md-nav__link">
<span class="md-ellipsis">
Hardware requirements
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#supported-apis" class="md-nav__link">
<span class="md-ellipsis">
Supported APIs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#source-code" class="md-nav__link">
<span class="md-ellipsis">
Source code
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#contributing" class="md-nav__link">
<span class="md-ellipsis">
Contributing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#social-media" class="md-nav__link">
<span class="md-ellipsis">
Social Media
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#history" class="md-nav__link">
<span class="md-ellipsis">
History
</span>
</a>
Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="#ecosystem" class="md-nav__link">
<span class="md-ellipsis">
Ecosystem
</span>
</a>
Dimitrios Giannopoulos
committed
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
</li>
<li class="md-nav__item">
<a href="#citation" class="md-nav__link">
<span class="md-ellipsis">
Citation
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>Introduction</h1>
<p><img src="images/openslice_logo.png" alt="drawing" width="200"/></p>
Dimitrios Giannopoulos
committed
<p>version: 2023Q4 - Release 0</p>
Dimitrios Giannopoulos
committed
<p>The ETSI Software Development Group for OpenSlice (SDG OSL) is developing an open source service based Operations Support System (OSS) to deliver Network Slice as a Service (NSaaS) following specifications from major SDOs including ETSI, TM Forum and GSMA. See more details <a href="https://osl.etsi.org/about/">here</a>.</p>
Dimitrios Giannopoulos
committed
<h2 id="usage">Usage</h2>
Dimitrios Giannopoulos
committed
<p>OpenSlice allows Vertical Customers to browse the available offered service specifications and also allows NFV developers to onboard and manage VNF and Network Service artifacts. It also supports TMFORUM OpenAPIs regarding Service Catalog Management, Ordering, Resource, etc.
The following figure displays the usage of OpenSlice.</p>
<p><a href="images/index_intro_architecture.png"><img alt="OpenSlice usage" src="images/index_intro_architecture.png" /></a></p>
Dimitrios Giannopoulos
committed
<p>There are two portals offering UI friendly access to users:</p>
<ul>
<li>The Services portal allows users to access services and service providers to design services. </li>
<li>The NFV portal allows users to self-manage NFV artifacts and onboard them to a target MANO/NFV Orchestrator.</li>
</ul>
Dimitrios Giannopoulos
committed
<p>3rd party applications can use OpenSlice through TMForum Open APIs.</p>
<p>Service Specifications reside into Service Catalogs, grouped in Categories. OpenSlice offers a Service Orchestrator called <a href="architecture/osom/">OSOM</a>. OSOM instantiates Service Specifications by requesting Network Services from target MANOs/NFVOs. NFV artifacts reside into a VNF/NSD catalog and are onboarded to a target MANO/NFV Orchestrator. Service Specifications reference NSD from the VNF/NSD catalog. </p>
<p>Customers make Service Orders and OpenSlice instantiates the requested Service Specifications of the Service Order. Running Services instantiated by OpenSlice, reside in OpenSlice Service Inventory. The following picture displays how Service Specifications are related to Running Services and how Running Services relate with instantiated running Network Services. (See also <a href="service_inventory/">Service Inventory</a>)</p>
<p><a href="images/service_specification_instantiation.png"><img alt="OpenSlice Service Specification instantiation" src="images/service_specification_instantiation.png" /></a></p>
Dimitrios Giannopoulos
committed
<h2 id="service-lifecycle-rules">Service Lifecycle Rules</h2>
Dimitrios Giannopoulos
committed
<p>OpenSlice constains support for defining rules of services, affecting their behavior. See <a href="lcm/">LCM Rules</a>.</p>
Dimitrios Giannopoulos
committed
<h2 id="multidomain-scenarios-and-federation">Multidomain scenarios and federation</h2>
Dimitrios Giannopoulos
committed
<p>OpenSlice can be used to exchange service specifications/catalogs and make service orders between Organizations as the following figure displays.</p>
<p><a href="images/multi-domain-organizations.png"><img alt="OpenSlice Service Specification instantiation" src="images/multi-domain-organizations.png" /></a></p>
Dimitrios Giannopoulos
committed
<p>An Identity federation is also possible since our authentication service is based on Keycloak (see <a href="architecture/oauth/">OAuth</a>).</p>
<p>See more on <a href="architecture/consumingServicesFromExternalPartners/">Consuming Services From External Partner Organizations</a>.</p>
Dimitrios Giannopoulos
committed
<h2 id="live-demo">Live Demo</h2>
<ul>
Dimitrios Giannopoulos
committed
<li>OpenSlice demo: <a href="http://portal.openslice.io/">http://portal.openslice.io/</a></li>
<li>OpenSlice Service Catalogs and ordering: <a href="http://portal.openslice.io/services/">http://portal.openslice.io/services/</a></li>
<li>OpenSlice NFV Services onboarding: <a href="http://portal.openslice.io/nfvportal">http://portal.openslice.io/nfvportal</a><blockquote>
Dimitrios Giannopoulos
committed
<p>username=admin, password=openslice <br> or <br>username=admin, password=changeme</p>
</blockquote>
</li>
</ul>
<h2 id="video-demo">Video demo</h2>
<ul>
<li><a href="https://youtu.be/KU8JPDFFl9A">https://youtu.be/KU8JPDFFl9A</a></li>
</ul>
<hr />
<h2 id="installing">Installing</h2>
Dimitrios Giannopoulos
committed
<p>See <a href="deployment/">Deployment/Installation</a>.</p>
Dimitrios Giannopoulos
committed
<hr />
<h2 id="hardware-requirements">Hardware requirements</h2>
Dimitrios Giannopoulos
committed
<p>The complete environment consists of microservices deployed as docker containers. Portainer is also installed to monitor them at port 9000.</p>
Dimitrios Giannopoulos
committed
<p>If you would like to operate all APIs, OSOM, the Mysql Server, nginx, etc then you need at least:</p>
Dimitrios Giannopoulos
committed
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
<table>
<thead>
<tr>
<th><strong>Minimum Hardware Requirements</strong></th>
<th><strong>Recomended Hardware Requirements</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>4 CPU cores</td>
<td>8 CPU cores</td>
</tr>
<tr>
<td>8 GB RAM</td>
<td>16 GB RAM</td>
</tr>
<tr>
<td>20 GB storage</td>
<td>40 GB storage</td>
</tr>
</tbody>
</table>
Dimitrios Giannopoulos
committed
<p>(NOTE: Bugzilla or ELK are not included and we assume they run elsewhere)</p>
Dimitrios Giannopoulos
committed
<p>However, you may try the front facing services of OpenSlice with a minimum installation on a VM on a laptop with:</p>
Dimitrios Giannopoulos
committed
<ul>
<li>2 cores</li>
<li>4GB of RAM </li>
</ul>
<h2 id="supported-apis">Supported APIs</h2>
Dimitrios Giannopoulos
committed
<p>Quick overview of the supported APIs through our Swagger links:</p>
Dimitrios Giannopoulos
committed
<ul>
Dimitrios Giannopoulos
committed
<li><a href="http://portal.openslice.io/tmf-api/swagger-ui/index.html">TMF APIs</a></li>
<li><a href="http://portal.openslice.io/osapi/swagger-ui/index.html">API for VNF/NSD management</a></li>
Dimitrios Giannopoulos
committed
</ul>
<h2 id="source-code">Source code</h2>
Dimitrios Giannopoulos
committed
<p>OpenSlice source code is available at <a href="https://labs.etsi.org/rep/osl/code">OSL GitLab repository</a>.</p>
Dimitrios Giannopoulos
committed
<h2 id="contributing">Contributing</h2>
Dimitrios Giannopoulos
committed
<p>You may contribute following the guidelines at <a href="contributing/developing/">Contributing page</a>.</p>
Dimitrios Giannopoulos
committed
<h2 id="social-media">Social Media</h2>
<ul>
Dimitrios Giannopoulos
committed
<li><a href="https://twitter.com/OpensliceOSS">Twitter</a></li>
<li><a href="https://openslice.slack.com">Slack</a></li>
Dimitrios Giannopoulos
committed
</ul>
<h2 id="history">History</h2>
<ul>
Dimitrios Giannopoulos
committed
<li>The NFV portal part of OpenSlice was initially developed in H2020 European Research project <a href="https://5ginfire.eu">5GinFIRE</a> by University of Patras, Greece</li>
<li>OpenSlice core services, APIs was further developed and maintained in H2020 European project <a href="https://5g-vinni.eu/">5G-VINNI</a> by University of Patras, Greece</li>
<li>OpenSlice has been a part off OSM's OSS/BSS ecosystem</li>
Dimitrios Giannopoulos
committed
</ul>
<p><a href="https://osm.etsi.org/wikipub/index.php/OSS_BSS"><img alt="Part of OSM Ecosystem" src="images/osm_ecosystem_ossbss.png" /></a></p>
Dimitrios Giannopoulos
committed
<h2 id="ecosystem">Ecosystem</h2>
<p>Discover the current OpenSlice ecosystem <a href="https://osl.etsi.org/ecosystem/">here</a>.</p>
Dimitrios Giannopoulos
committed
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
<h2 id="citation">Citation</h2>
<p>Please cite our <a href="https://arxiv.org/abs/2102.03290">![paper]</a> if you use Openslice</p>
<pre><code>
@misc{tranoris2021openslice,
title={Openslice: An opensource OSS for Delivering Network Slice as a Service},
author={Christos Tranoris},
year={2021},
eprint={2102.03290},
archivePrefix={arXiv},
primaryClass={cs.NI}
}
</code></pre>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="deployment/" class="md-footer__link md-footer__link--next" aria-label="Next: Deployment/Installation">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Deployment/Installation
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Dimitrios Giannopoulos
committed
Copyright © 2019-2024 Openslice Project
Dimitrios Giannopoulos
committed
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://osl.etsi.org/" target="_blank" rel="noopener" title="osl.etsi.org" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M352 256c0 22.2-1.2 43.6-3.3 64H163.3c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64h185.4c2.2 20.4 3.3 41.8 3.3 64zm28.8-64h123.1c5.3 20.5 8.1 41.9 8.1 64s-2.8 43.5-8.1 64H380.8c2.1-20.6 3.2-42 3.2-64s-1.1-43.4-3.2-64zm112.6-32H376.7c-10-63.9-29.8-117.4-55.3-151.6 78.3 20.7 142 77.5 171.9 151.6zm-149.1 0H167.7c6.1-36.4 15.5-68.6 27-94.7 10.5-23.6 22.2-40.7 33.5-51.5C239.4 3.2 248.7 0 256 0s16.6 3.2 27.8 13.8c11.3 10.8 23 27.9 33.5 51.5 11.6 26 20.9 58.2 27 94.7zm-209 0H18.6c30-74.1 93.6-130.9 172-151.6-25.5 34.2-45.3 87.7-55.3 151.6zM8.1 192h123.1c-2.1 20.6-3.2 42-3.2 64s1.1 43.4 3.2 64H8.1C2.8 299.5 0 278.1 0 256s2.8-43.5 8.1-64zm186.6 254.6c-11.6-26-20.9-58.2-27-94.6h176.6c-6.1 36.4-15.5 68.6-27 94.6-10.5 23.6-22.2 40.7-33.5 51.5-11.2 10.7-20.5 13.9-27.8 13.9s-16.6-3.2-27.8-13.8c-11.3-10.8-23-27.9-33.5-51.5zM135.3 352c10 63.9 29.8 117.4 55.3 151.6-78.4-20.7-142-77.5-172-151.6h116.7zm358.1 0c-30 74.1-93.6 130.9-171.9 151.6 25.5-34.2 45.2-87.7 55.3-151.6h116.6z"/></svg>
</a>
<a href="https://labs.etsi.org/rep/osl" target="_blank" rel="noopener" title="labs.etsi.org" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="m503.5 204.6-.7-1.8-69.7-181.78c-1.4-3.57-3.9-6.59-7.2-8.64-2.4-1.55-5.1-2.515-8-2.81-2.9-.295-5.7.083-8.4 1.11-2.7 1.02-5.1 2.66-7.1 4.78-1.9 2.12-3.3 4.67-4.1 7.44l-47 144H160.8l-47.1-144c-.8-2.77-2.2-5.31-4.1-7.43-2-2.12-4.4-3.75-7.1-4.77a18.1 18.1 0 0 0-8.38-1.113 18.4 18.4 0 0 0-8.04 2.793 18.09 18.09 0 0 0-7.16 8.64L9.267 202.8l-.724 1.8a129.57 129.57 0 0 0-3.52 82c7.747 26.9 24.047 50.7 46.447 67.6l.27.2.59.4 105.97 79.5 52.6 39.7 32 24.2c3.7 1.9 8.3 4.3 13 4.3 4.7 0 9.3-2.4 13-4.3l32-24.2 52.6-39.7 106.7-79.9.3-.3c22.4-16.9 38.7-40.6 45.6-67.5 8.6-27 7.4-55.8-2.6-82z"/></svg>
</a>
<a href="https://www.linkedin.com/company/openslice/" target="_blank" rel="noopener" title="www.linkedin.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg>
</a>
<a href="https://twitter.com/OpensliceOSS" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8l164.9-188.5L26.8 48h145.6l100.5 132.9L389.2 48zm-24.8 373.8h39.1L151.1 88h-42l255.3 333.8z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<div class="md-progress" data-md-component="progress" role="progressbar"></div>
Dimitrios Giannopoulos
committed
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
Dimitrios Giannopoulos
committed
Dimitrios Giannopoulos
committed
<script src="assets/javascripts/bundle.8fd75fb4.min.js"></script>
Dimitrios Giannopoulos
committed
</body>
</html>