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/develop/getting_started/deployment/kubernetes/">

Dimitrios Giannopoulos
committed
<link rel="prev" href="../docker_compose/">

Dimitrios Giannopoulos
committed
<link rel="next" href="../../portals/">

Dimitrios Giannopoulos
committed
<link rel="icon" href="../../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.50">

Dimitrios Giannopoulos
committed
<title>Kubernetes - ETSI SDG OSL Documentation</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.a40c8224.min.css">

Dimitrios Giannopoulos
committed
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">

Dimitrios Giannopoulos
committed
<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>

Dimitrios Giannopoulos
committed
<link href="../../../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
html.glightbox-open { overflow: initial; height: 100%; }
.gslide-title { margin-top: 0px; user-select: text; }
.gslide-desc { color: #666; user-select: text; }
.gslide-image img { background: white; }
.gscrollbar-fixer { padding-right: 15px; }
.gdesc-inner { font-size: 0.75rem; }
body[data-md-color-scheme="slate"] .gdesc-inner { background: var(--md-default-bg-color);}
body[data-md-color-scheme="slate"] .gslide-title { color: var(--md-default-fg-color);}
body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color);}</style> <script src="../../../assets/javascripts/glightbox.min.js"></script></head>

Dimitrios Giannopoulos
committed
<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">

Dimitrios Giannopoulos
committed
<a href="#openslice-deployment-guide-with-kubernetes" class="md-skip">
Skip to content
</a>

Dimitrios Giannopoulos
committed
</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">

Dimitrios Giannopoulos
committed
<img src="../../../images/logo_osl.png" alt="logo">

Dimitrios Giannopoulos
committed
</a>
<label class="md-header__button md-icon" for="__drawer">

Dimitrios Giannopoulos
committed
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>

Dimitrios Giannopoulos
committed
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
</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">
Kubernetes
</span>
</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.7.2 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 2024 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.81s-5.7.083-8.4 1.11c-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.1 18.1 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.3s9.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-82"/></svg>

Dimitrios Giannopoulos
committed
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
</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">
<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">

Dimitrios Giannopoulos
committed
<img src="../../../images/logo_osl.png" alt="logo">

Dimitrios Giannopoulos
committed
</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.7.2 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 2024 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.81s-5.7.083-8.4 1.11c-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.1 18.1 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.3s9.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-82"/></svg>

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
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
<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="false">
<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">
<a href="../../.." class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../deployment_examples/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Deployment examples

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../history/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
History
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../etsi_osl/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
OpenSlice under ETSI

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
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
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<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="true">
<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 md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1" checked>
<label class="md-nav__link" for="__nav_2_1" id="__nav_2_1_label" tabindex="0">
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Deployment

Dimitrios Giannopoulos
committed
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2_1">
<span class="md-nav__icon md-icon"></span>

Dimitrios Giannopoulos
committed
Deployment

Dimitrios Giannopoulos
committed
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../introduction/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Introduction

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../docker_compose/" class="md-nav__link">

Dimitrios Giannopoulos
committed
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
<span class="md-ellipsis">
Docker Compose
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Kubernetes
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Kubernetes
</span>
</a>

Dimitrios Giannopoulos
committed
<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>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="#requirements" class="md-nav__link">
<span class="md-ellipsis">
Requirements
</span>
</a>
<nav class="md-nav" aria-label="Requirements">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hardware-requirements" class="md-nav__link">
<span class="md-ellipsis">
Hardware requirements

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#software-requirements" class="md-nav__link">
<span class="md-ellipsis">
Software Requirements

Dimitrios Giannopoulos
committed
</span>
</a>
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
</li>
<li class="md-nav__item">
<a href="#exposure" class="md-nav__link">
<span class="md-ellipsis">
Exposure
</span>
</a>
<nav class="md-nav" aria-label="Exposure">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-load-balancer" class="md-nav__link">
<span class="md-ellipsis">
Option 1 - Load balancer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-ingress" class="md-nav__link">
<span class="md-ellipsis">
Option 2 - Ingress
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
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
</li>
<li class="md-nav__item">
<a href="#additional-configuration" class="md-nav__link">
<span class="md-ellipsis">
Additional Configuration
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#preparing-the-environment" class="md-nav__link">
<span class="md-ellipsis">
Preparing the environment
</span>
</a>
<nav class="md-nav" aria-label="Preparing the environment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-setting-up-a-kubernetes-cluster" class="md-nav__link">
<span class="md-ellipsis">
1. Setting Up A Kubernetes Cluster
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-installing-helm" class="md-nav__link">
<span class="md-ellipsis">
2. Installing Helm
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#downloading-the-project" class="md-nav__link">
<span class="md-ellipsis">
Downloading the project
</span>
</a>
<nav class="md-nav" aria-label="Downloading the project">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-create-a-new-folder-to-download-the-project" class="md-nav__link">
<span class="md-ellipsis">
1. Create a new folder to download the project
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-download-the-project-code" class="md-nav__link">
<span class="md-ellipsis">
2. Download the project code
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-prerequisites-before-deployment" class="md-nav__link">
<span class="md-ellipsis">
3. Prerequisites before deployment
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#configure-helm-chart" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Configure Helm Chart

Dimitrios Giannopoulos
committed
</span>
</a>
<nav class="md-nav" aria-label="Configure Helm Chart">

Dimitrios Giannopoulos
committed
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#database" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Database

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#keycloak" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Keycloak

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cridge" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
CRIDGE

Dimitrios Giannopoulos
committed
</span>
</a>
<nav class="md-nav" aria-label="CRIDGE">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#bundled-cridge-deployment-with-the-openslice-helm-chart-same-cluster-environment" class="md-nav__link">
<span class="md-ellipsis">
Bundled CRIDGE deployment with the OpenSlice Helm chart (same cluster environment)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#standalone-cridge-deployment" class="md-nav__link">
<span class="md-ellipsis">
Standalone CRIDGE deployment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#management-of-multiple-kubernetes-clusters" class="md-nav__link">
<span class="md-ellipsis">
Management of multiple Kubernetes Clusters
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="#external-services-optional" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
External Services (optional)

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#application-and-logging" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Application and Logging

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ingress-and-root-url" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Ingress and Root URL

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="#persistent-volume-for-mysql" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Persistent Volume for MySQL

Dimitrios Giannopoulos
committed
</span>
</a>

Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="#tcp-forwarding-for-artemis" class="md-nav__link">
<span class="md-ellipsis">
TCP Forwarding for Artemis
</span>
</a>

Dimitrios Giannopoulos
committed
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="#web-ui" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Web UI

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tmf-web-ui" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
TMF Web UI

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="#deploy-the-helm-chart" class="md-nav__link">
<span class="md-ellipsis">
Deploy the Helm Chart
</span>
</a>

Dimitrios Giannopoulos
committed
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
</li>
<li class="md-nav__item">
<a href="#validating-deployments-and-container-monitoring" class="md-nav__link">
<span class="md-ellipsis">
Validating deployments and container monitoring
</span>
</a>
<nav class="md-nav" aria-label="Validating deployments and container monitoring">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#checking-the-status-of-your-applications-deployment" class="md-nav__link">
<span class="md-ellipsis">
Checking the Status of your application's deployment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#accessing-logs-for-troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
Accessing Logs for Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-installation-steps-mandatory" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Post installation steps (mandatory)

Dimitrios Giannopoulos
committed
</span>
</a>
<nav class="md-nav" aria-label="Post installation steps (mandatory)">

Dimitrios Giannopoulos
committed
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
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#configure-keycloak-server" class="md-nav__link">
<span class="md-ellipsis">
Configure Keycloak server
</span>
</a>
<nav class="md-nav" aria-label="Configure Keycloak server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-configure-email" class="md-nav__link">
<span class="md-ellipsis">
1. Configure email
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-add-an-openslice-admin-user" class="md-nav__link">
<span class="md-ellipsis">
2. Add an OpenSlice admin user
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#nfv-orchestrator-configuration" class="md-nav__link">
<span class="md-ellipsis">
NFV Orchestrator Configuration
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../portals/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Portals

Dimitrios Giannopoulos
committed
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
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3" >
<label class="md-nav__link" for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
<span class="md-ellipsis">
Configuration/Management
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_3">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>

Dimitrios Giannopoulos
committed
Configuration/Management

Dimitrios Giannopoulos
committed
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../configuration/config_intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../configuration/role_keycloak_management/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Role/Keycloak management

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../configuration/nfvo_config/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
NFV Orchestrator Configuration
</span>
</a>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_4" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_2_3_4" id="__nav_2_3_4_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Advanced topics
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_3_4">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
Advanced topics
</label>
<ul class="md-nav__list" data-md-scrollfix>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../configuration/consuming_services_from_external_partners/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Consuming Services From External OSS
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
NaaS

Dimitrios Giannopoulos
committed
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>

Dimitrios Giannopoulos
committed
NaaS

Dimitrios Giannopoulos
committed
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../naas/introduction/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Introduction

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Services

Dimitrios Giannopoulos
committed
</span>

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
Services
</label>
<ul class="md-nav__list" data-md-scrollfix>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../naas/service_catalog/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Service Catalogs

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../naas/service_spec/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Service Specification

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../naas/service_ordering/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Service Ordering
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../naas/service_inventory/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Service Inventory

Dimitrios Giannopoulos
committed
</span>

Dimitrios Giannopoulos
committed
</a>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../naas/gst_to_tmf/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
GSMA GST to TMF Service

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_3" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Resources

Dimitrios Giannopoulos
committed
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>

Dimitrios Giannopoulos
committed
Resources

Dimitrios Giannopoulos
committed
</label>
<ul class="md-nav__list" data-md-scrollfix>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../naas/resource_catalog/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Resources Catalogs

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../naas/resource_spec/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Resources Specification

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../naas/resource_inventory/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Resources Inventory

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_4" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_3_4" id="__nav_3_4_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Service orchestration

Dimitrios Giannopoulos
committed
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>

Dimitrios Giannopoulos
committed
Service orchestration

Dimitrios Giannopoulos
committed
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../naas/so_intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Introduction

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../naas/lcm_intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Service Lifecycle management

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../naas/lcm_rules_intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
LCM Rules Introduction

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_4_4" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_3_4_4" id="__nav_3_4_4_label" tabindex="0">

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
From Service order to services/resources

Dimitrios Giannopoulos
committed
</span>

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_4_4">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
From Service order to services/resources
</label>
<ul class="md-nav__list" data-md-scrollfix>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../naas/so_servicespec_to_services_kubernetes/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Exposing Kubernetes services

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../naas/so_servicespec_to_services_nfv/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Exposing NFV Services

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="../../../naas/exposed_apis/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Supported TMFORUM exposed APIs

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6" >
<label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="0">
<span class="md-ellipsis">
NFV support
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_6">
<span class="md-nav__icon md-icon"></span>
NFV support
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../naas/nfv/intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../naas/nfv/nfvservices/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
NFV Services

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Service design

Dimitrios Giannopoulos
committed
</span>

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
Service design
</label>
<ul class="md-nav__list" data-md-scrollfix>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../service_design/intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Introduction

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../service_design/catalogs/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Catalogs
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Support for Kubernetes
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
Support for Kubernetes
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../service_design/kubernetes/intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Introduction

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../service_design/kubernetes/exposing_kubernetes_resources/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Exposing Kubernetes Resources
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../service_design/kubernetes/design_helm_aas/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Design Helm as a Service

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Support for NFV
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
Support for NFV
</label>
<ul class="md-nav__list" data-md-scrollfix>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../service_design/nfv/design_nfv_services/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Design NFV Services

Dimitrios Giannopoulos
committed
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
</span>
</a>
</li>
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_5" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_4_5" id="__nav_4_5_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
LCM Rules
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_5">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
LCM Rules
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../service_design/lcmrules/intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../service_design/lcmrules/specification/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Specification

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../service_design/lcmrules/examples/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Typical Examples

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_6" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_4_6" id="__nav_4_6_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Examples

Dimitrios Giannopoulos
committed
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_6">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
Examples

Dimitrios Giannopoulos
committed
</label>
<ul class="md-nav__list" data-md-scrollfix>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../service_design/examples/intro/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../service_design/examples/calculator_crd_aas/calculator_crd_aas/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Calculator CRD aaS

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../service_design/examples/jenkins_helm_install_aas/jenkins_helm_install_aas/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Jenkins Helm Installation aaS

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Service Ordering
</span>
<span class="md-nav__icon md-icon"></span>

Dimitrios Giannopoulos
committed
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
Service Ordering
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../service_ordering/ordering_services/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Ordering Services from catalogs

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">

Dimitrios Giannopoulos
committed
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Design & Architecture

Dimitrios Giannopoulos
committed
</span>
<span class="md-nav__icon md-icon"></span>
</label>

Dimitrios Giannopoulos
committed
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">

Dimitrios Giannopoulos
committed
<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">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../architecture/cridge/cridge_introduction/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
CRIDGE

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../architecture/messagebus/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Message bus
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../architecture/osom/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
OSOM
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../architecture/oauth/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Authentication
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
APIs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_6">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>
APIs
</label>
<ul class="md-nav__list" data-md-scrollfix>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../architecture/tmfapi/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
TMF API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../architecture/nfvapi/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
NFV API
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../architecture/issuemgt/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Issue management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../architecture/centrallog/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Central logging
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >

Dimitrios Giannopoulos
committed
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">

Dimitrios Giannopoulos
committed
Contributing to OSL

Dimitrios Giannopoulos
committed
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">

Dimitrios Giannopoulos
committed
<span class="md-nav__icon md-icon"></span>

Dimitrios Giannopoulos
committed
Contributing to OSL

Dimitrios Giannopoulos
committed
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../contributing/developing/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Developing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../contributing/documenting/" class="md-nav__link">
<span class="md-ellipsis">
Documenting
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
</ul>
</nav>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="../../../terminology/" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Terminology
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
</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">

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed

Dimitrios Giannopoulos
committed
<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>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="#requirements" class="md-nav__link">
<span class="md-ellipsis">
Requirements
</span>
</a>
<nav class="md-nav" aria-label="Requirements">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hardware-requirements" class="md-nav__link">
<span class="md-ellipsis">
Hardware requirements

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#software-requirements" class="md-nav__link">
<span class="md-ellipsis">
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
Software Requirements
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#exposure" class="md-nav__link">
<span class="md-ellipsis">
Exposure
</span>
</a>
<nav class="md-nav" aria-label="Exposure">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#option-1-load-balancer" class="md-nav__link">
<span class="md-ellipsis">
Option 1 - Load balancer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#option-2-ingress" class="md-nav__link">
<span class="md-ellipsis">
Option 2 - Ingress

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
</li>
<li class="md-nav__item">
<a href="#additional-configuration" class="md-nav__link">
<span class="md-ellipsis">
Additional Configuration
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#preparing-the-environment" class="md-nav__link">
<span class="md-ellipsis">
Preparing the environment
</span>
</a>
<nav class="md-nav" aria-label="Preparing the environment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-setting-up-a-kubernetes-cluster" class="md-nav__link">
<span class="md-ellipsis">
1. Setting Up A Kubernetes Cluster
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-installing-helm" class="md-nav__link">
<span class="md-ellipsis">
2. Installing Helm
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#downloading-the-project" class="md-nav__link">
<span class="md-ellipsis">
Downloading the project
</span>
</a>
<nav class="md-nav" aria-label="Downloading the project">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-create-a-new-folder-to-download-the-project" class="md-nav__link">
<span class="md-ellipsis">
1. Create a new folder to download the project
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-download-the-project-code" class="md-nav__link">
<span class="md-ellipsis">
2. Download the project code
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-prerequisites-before-deployment" class="md-nav__link">
<span class="md-ellipsis">
3. Prerequisites before deployment
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#configure-helm-chart" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Configure Helm Chart

Dimitrios Giannopoulos
committed
</span>
</a>
<nav class="md-nav" aria-label="Configure Helm Chart">

Dimitrios Giannopoulos
committed
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#database" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Database

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#keycloak" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Keycloak

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cridge" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
CRIDGE

Dimitrios Giannopoulos
committed
</span>
</a>
<nav class="md-nav" aria-label="CRIDGE">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#bundled-cridge-deployment-with-the-openslice-helm-chart-same-cluster-environment" class="md-nav__link">
<span class="md-ellipsis">
Bundled CRIDGE deployment with the OpenSlice Helm chart (same cluster environment)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#standalone-cridge-deployment" class="md-nav__link">
<span class="md-ellipsis">
Standalone CRIDGE deployment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#management-of-multiple-kubernetes-clusters" class="md-nav__link">
<span class="md-ellipsis">
Management of multiple Kubernetes Clusters
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="#external-services-optional" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
External Services (optional)

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#application-and-logging" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Application and Logging

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#ingress-and-root-url" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Ingress and Root URL

Dimitrios Giannopoulos
committed
</span>
</a>
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="#persistent-volume-for-mysql" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Persistent Volume for MySQL

Dimitrios Giannopoulos
committed
</span>
</a>

Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="#tcp-forwarding-for-artemis" class="md-nav__link">
<span class="md-ellipsis">
TCP Forwarding for Artemis
</span>
</a>

Dimitrios Giannopoulos
committed
</li>

Dimitrios Giannopoulos
committed
<li class="md-nav__item">
<a href="#web-ui" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Web UI

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tmf-web-ui" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
TMF Web UI

Dimitrios Giannopoulos
committed
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
<li class="md-nav__item">
<a href="#deploy-the-helm-chart" class="md-nav__link">
<span class="md-ellipsis">
Deploy the Helm Chart
</span>
</a>

Dimitrios Giannopoulos
committed
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
</li>
<li class="md-nav__item">
<a href="#validating-deployments-and-container-monitoring" class="md-nav__link">
<span class="md-ellipsis">
Validating deployments and container monitoring
</span>
</a>
<nav class="md-nav" aria-label="Validating deployments and container monitoring">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#checking-the-status-of-your-applications-deployment" class="md-nav__link">
<span class="md-ellipsis">
Checking the Status of your application's deployment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#accessing-logs-for-troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
Accessing Logs for Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#post-installation-steps-mandatory" class="md-nav__link">

Dimitrios Giannopoulos
committed
<span class="md-ellipsis">
Post installation steps (mandatory)

Dimitrios Giannopoulos
committed
</span>
</a>
<nav class="md-nav" aria-label="Post installation steps (mandatory)">

Dimitrios Giannopoulos
committed
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#configure-keycloak-server" class="md-nav__link">
<span class="md-ellipsis">
Configure Keycloak server
</span>
</a>
<nav class="md-nav" aria-label="Configure Keycloak server">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-configure-email" class="md-nav__link">
<span class="md-ellipsis">
1. Configure email
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-add-an-openslice-admin-user" class="md-nav__link">
<span class="md-ellipsis">
2. Add an OpenSlice admin user
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#nfv-orchestrator-configuration" class="md-nav__link">
<span class="md-ellipsis">
NFV Orchestrator Configuration
</span>
</a>
</li>
</ul>
</nav>

Dimitrios Giannopoulos
committed
</li>
</ul>

Dimitrios Giannopoulos
committed
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">

Dimitrios Giannopoulos
committed
<h1 id="openslice-deployment-guide-with-kubernetes">OpenSlice Deployment Guide with Kubernetes</h1>
<p><strong>Intended Audience: OpenSlice Administrators</strong></p>

Dimitrios Giannopoulos
committed
<h2 id="requirements">Requirements</h2>
<h3 id="hardware-requirements">Hardware requirements</h3>

Dimitrios Giannopoulos
committed
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
<table>
<thead>
<tr>
<th><strong>Minimum Hardware Requirements</strong></th>
<th><strong>Recommended 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>30 GB storage</td>
<td>50 GB storage</td>
</tr>
</tbody>
</table>
<h3 id="software-requirements">Software Requirements</h3>

Dimitrios Giannopoulos
committed
<ul>
<li><strong>git:</strong> For cloning the project repository.</li>
<li><strong>Kubernetes:</strong> A running cluster where OpenSlice will be deployed. <ul>
<li><strong>Disclaimer:</strong> The current manual setup of Persistent Volumes using <code>hostPath</code> is designed to operate with <strong>only a single worker node</strong>. This setup will not support data persistence if a pod is rescheduled to another node.</li>
</ul>
</li>
<li><strong>Helm:</strong> For managing the deployment of OpenSlice.</li>
<li>
<p><strong>Ingress Controller:</strong> Ingress exposes HTTP and HTTPS routes from outside the cluster to services within the cluster. Traffic routing is controlled by rules defined on the Ingress resource. An Ingress may be configured to give Services externally-reachable URLs, load balance traffic, terminate SSL / TLS, and offer name-based virtual hosting. An Ingress controller is responsible for fulfilling the Ingress, usually with a load balancer, though it may also configure your edge router or additional frontends to help handle the traffic. You must have an Ingress controller to satisfy an Ingress.</p>
<ul>
<li>
<p><strong>Nginx Ingress Controller (Kubernetes Community Edition):</strong> The ingress resource is configured to use an Nginx type ingress controller. </p>
<ul>
<li>If you need to expose the message bus service (Artemis), which communicates using the TCP protocol, you must use version <strong>>= 1.9.13</strong> of the Nginx Ingress Controller (a prerequisite for <a href="#management-of-multiple-kubernetes-clusters">managing multiple kubernetes clusters</a>). This version or higher includes the required functionality to handle TCP services. Otherwise, earlier versions may suffice depending on your configuration.</li>
<li>
<p>To install or upgrade to the required version, run the following command:</p>
<p><div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>helm<span class="w"> </span>upgrade<span class="w"> </span>nginx-ingress<span class="w"> </span>ingress-nginx/ingress-nginx<span class="w"> </span>--namespace<span class="w"> </span>ingress<span class="w"> </span><span class="se">\</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>--set<span class="w"> </span>tcp.61616<span class="o">=</span><span class="s2">"<openslice-namespace>/<openslice-helm-release-name>-artemis:61616"</span>
</span></code></pre></div>
Replace <code><helm-release-name></code> with the name of your OpenSlice Helm release.</p>
</li>
<li>
<p>More details regarding the Nginx Ingress Controller (Kubernetes Community Edition) can be found <a href="https://kubernetes.github.io/ingress-nginx/deploy/">here</a>.</p>
</li>
</ul>
</li>
<li>
<p><strong>Other Ingress Controller:</strong> For non-Nginx ingress controllers, modify <code>[repo-root]/kubernetes/helm/openslice/templates/openslice-ingress.yaml</code> to meet your controller’s requirements.</p>
</li>

Dimitrios Giannopoulos
committed
</ul>
</li>
</ul>
<h3 id="exposure">Exposure</h3>
<h4 id="option-1-load-balancer">Option 1 - Load balancer</h4>
<ul>

Dimitrios Giannopoulos
committed
<li><strong>Network Load Balancer:</strong> Required for exposing the service (e.g., GCP, AWS, Azure, MetalLB).</li>
<li><strong>Domain/IP Address:</strong> Necessary for accessing the application. This should be configured in <code>[repo-root]/kubernetes/helm/openslice/values.yaml</code> under <code>rooturl</code>.</li>
</ul>
<h4 id="option-2-ingress">Option 2 - Ingress</h4>
<ul>
<li><strong>Ingress Controller with NodePort:</strong> You can expose the application using the NodePort of the Ingress Controller's service.</li>
<li><strong>IP Address and Port:</strong> Use the IP address of the <strong>master node</strong> and the assigned NodePort to access the application. This should be configured in <code>[repo-root]/kubernetes/helm/openslice/values.yaml</code> under <code>rooturl</code>.</li>
</ul>
<p>For example:
<div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>rooturl: http://<master-node-ip>:<nodeport>
</span></code></pre></div></p>

Dimitrios Giannopoulos
committed
<h3 id="additional-configuration">Additional Configuration</h3>
<ul>
<li><strong>Storage Class:</strong> In a production environment, specify your <code>storageClass</code> in <code>[repo-root]/kubernetes/helm/openslice/values.yaml</code> under <code>storageClass</code>. If not defined, PVs will be created and managed manually.</li>

Dimitrios Giannopoulos
committed
</ul>
<blockquote>
<p><strong>Disclaimer:</strong> Before deploying, confirm that your storage system supports claims of one 10G and two 1G volumes.</p>
</blockquote>

Dimitrios Giannopoulos
committed
<h2 id="preparing-the-environment">Preparing the environment</h2>
<h3 id="1-setting-up-a-kubernetes-cluster">1. Setting Up A Kubernetes Cluster</h3>
<p>Refer to the official Kubernetes documentation for setting up a cluster. Ensure your cluster meets the hardware requirements specified above.</p>
<h3 id="2-installing-helm">2. Installing Helm</h3>
<p>Helm must be installed on your machine to deploy OpenSlice via Helm charts. Follow the <a href="https://helm.sh/docs/intro/install/">official Helm installation guide</a>.</p>
<h2 id="downloading-the-project">Downloading the project</h2>
<h3 id="1-create-a-new-folder-to-download-the-project">1. Create a new folder to download the project</h3>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>mkdir<span class="w"> </span>openslice
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="nb">cd</span><span class="w"> </span>openslice
</span></code></pre></div>

Dimitrios Giannopoulos
committed
<h3 id="2-download-the-project-code">2. Download the project code</h3>
<p>Clone the project code from the GitLab repository.
<strong>Note:</strong> This process will be simplified once the charts are published in the GitLab registry, requiring only the chart to be pulled.</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://labs.etsi.org/rep/osl/code/org.etsi.osl.main.git
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.main/kubernetes/helm/openslice/
</span></code></pre></div>

Dimitrios Giannopoulos
committed
<h3 id="3-prerequisites-before-deployment">3. Prerequisites before deployment</h3>
<p>Before deploying the Helm chart, ensure you have configured the necessary components as detailed in the following section, i.e. <a href="#configure-helm-chart">Configure Helm Chart Services</a>.</p>

Dimitrios Giannopoulos
committed
<p>We recommend:</p>
<ul>
<li>main branch for the most stable experience and</li>
<li>develop branch for an experience with the latest features (for develop branch installation, it is strongly advisable that you may as well follow the <a href="https://osl.etsi.org/documentation/develop/">develop documentation</a>)</li>

Dimitrios Giannopoulos
committed
</ul>
<h2 id="configure-helm-chart">Configure Helm Chart</h2>

Dimitrios Giannopoulos
committed
<p>When deploying OpenSlice with Helm, service configurations are handled through the <code>values.yaml</code> file. This file allows you to define all necessary configurations for your deployment, including database credentials, service URLs, and logging levels. Below are examples of how to configure your services in Helm based on your provided values.</p>
<h3 id="database">Database</h3>

Dimitrios Giannopoulos
committed
<p>To configure MySQL and other related services, you can directly set the values in your <code>values.yaml</code> file under the <code>oscreds</code> and <code>mysql</code> sections. For example:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nt">oscreds</span><span class="p">:</span>
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nt">mysql</span><span class="p">:</span>
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"root"</span>
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"letmein"</span>
</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w"> </span><span class="nt">openslicedb</span><span class="p">:</span><span class="w"> </span><span class="s">"osdb"</span>
</span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="w"> </span><span class="nt">keycloak</span><span class="p">:</span><span class="w"> </span>
</span><span id="__span-4-7"><a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="s">"keycloak"</span>
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"keycloak"</span>
</span><span id="__span-4-9"><a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a><span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"password"</span>
</span><span id="__span-4-10"><a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a><span class="w"> </span><span class="nt">adminpassword</span><span class="p">:</span><span class="w"> </span><span class="s">"Pa55w0rd"</span>
</span><span id="__span-4-11"><a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a><span class="w"> </span><span class="nt">portal</span><span class="p">:</span>
</span><span id="__span-4-12"><a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a><span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="s">"osdb"</span>
</span><span id="__span-4-13"><a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a><span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"portaluser"</span>
</span><span id="__span-4-14"><a id="__codelineno-4-14" name="__codelineno-4-14" href="#__codelineno-4-14"></a><span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"12345"</span>
</span></code></pre></div>
<h3 id="keycloak">Keycloak</h3>

Dimitrios Giannopoulos
committed
<p>Keycloak settings, including the database and admin password, are part of the <code>oscreds.mysql.keycloak</code> section. If you need to adjust Keycloak-specific settings like realms or client configurations, you'll likely need to customize your Helm chart further or manage these settings directly within Keycloak after deployment. The Keycloak realm configuration that is imported by default can be found under <code>kubernetes/helm/openslice/files/keycloak-init/realm-export.json</code>.</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nt">oscreds</span><span class="p">:</span>
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">mysql</span><span class="p">:</span>
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="nt">keycloak</span><span class="p">:</span><span class="w"> </span>
</span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="nt">database</span><span class="p">:</span><span class="w"> </span><span class="s">"keycloak"</span>
</span><span id="__span-5-5"><a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span><span class="nt">username</span><span class="p">:</span><span class="w"> </span><span class="s">"keycloak"</span>
</span><span id="__span-5-6"><a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="w"> </span><span class="nt">password</span><span class="p">:</span><span class="w"> </span><span class="s">"password"</span>
</span><span id="__span-5-7"><a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="w"> </span><span class="nt">adminpassword</span><span class="p">:</span><span class="w"> </span><span class="s">"Pa55w0rd"</span>
</span></code></pre></div>
<h3 id="cridge">CRIDGE</h3>
<p>To create and manage Kubernetes Custom Resources (CRs), you have to install and configure the CRIDGE component. </p>
<p>For CRIDGE to work properly, you need to provide a <strong>cluster-wide scope kubeconfig</strong> file (typically located at <code>/home/{user}/.kube</code> directory of the Kubernetes Cluster's host). This kubeconfig file allows CRIDGE to communicate with your Kubernetes cluster.</p>
<p>There are two ways to install CRIDGE:</p>
<h4 id="bundled-cridge-deployment-with-the-openslice-helm-chart-same-cluster-environment"><strong>Bundled CRIDGE deployment with the OpenSlice Helm chart (same cluster environment)</strong></h4>
<p>By default, the OpenSlice Helm chart also deploys CRIDGE alongside the bundle. To configure CRIDGE, there are three different ways to provide this kubeconfig file during deployment:</p>
<ol>
<li>
<p><strong>Manual Copy to Helm Files Directory</strong>:</p>
<ul>
<li>Copy the kubeconfig file to the following directory:<br />
<code>org.etsi.osl.main/kubernetes/helm/openslice/files/org.etsi.osl.cridge</code>.</li>
<li>The deployment process will automatically copy the file into the <code>/root/.kube</code> directory of the CRIDGE container.</li>
<li><strong>Note:</strong> This method expects the kubeconfig file to be named exactly <code>kubeconfig.yaml</code> in the specified directory.</li>
</ul>
</li>
<li>
<p><strong>Passing the Kubeconfig File Using Helm (<code>--set-file</code>)</strong>:</p>

Dimitrios Giannopoulos
committed
<ul>
<li>
<p>If you do not wish to manually copy the file, you can pass it directly during the Helm installation using the <code>--set-file</code> option, at the final <a href="#deploy-the-helm-chart">deployment process</a>:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>--set-file<span class="w"> </span>cridge.kubeconfig.raw<span class="o">=</span>path/to/kubeconfig.yaml
</span></code></pre></div>
</li>
<li>
<p>This method reads the specified kubeconfig file and mounts it into the CRIDGE container during deployment.</p>
</li>
</ul>
</li>
<li>
<p><strong>Passing a Base64-Encoded Kubeconfig Using Helm (<code>--set</code>)</strong>:</p>
<ul>
<li>
<p>Alternatively, you can pass the kubeconfig as a base64-encoded string, during the Helm installation using the <code>--set</code> option, at the final <a href="#deploy-the-helm-chart">deployment process</a>:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>--set<span class="w"> </span>cridge.kubeconfig.base64<span class="o">=</span><span class="s2">"</span><span class="k">$(</span>base64<span class="w"> </span>path/to/kubeconfig.yaml<span class="k">)</span><span class="s2">"</span>
</span></code></pre></div>
</li>
<li>
<p>This method encodes the kubeconfig content and passes it directly to the CRIDGE container.</p>
</li>
</ul>
</li>
</ol>

Dimitrios Giannopoulos
committed
<blockquote>
<p><strong>Note:</strong> Regardless of the method you choose, if you're using a non-standard kubeconfig file name, make sure to adjust the references or rename the file as needed.</p>

Dimitrios Giannopoulos
committed
</blockquote>
<h4 id="standalone-cridge-deployment"><strong>Standalone CRIDGE deployment</strong></h4>
<p>There can be cases where a separate deployment of CRIDGE, apart from the bundled OpenSlice deployment, may be needed. These cases comprise:</p>
<ul>
<li>remote cluster management, different from the one OpenSlice is installed</li>
<li>more control over the component (e.g. multiple component instances / clusters)</li>
</ul>
<p>In this case, initially you have to disable CRIDGE from deploying with the rest of OpenSlice. To do so, in the <code>values.yaml</code> of OpenSlice Helm chart, you have to change the <code>cridge.enabled</code> flag to <code>false</code>.</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="nt">cridge</span><span class="p">:</span>
</span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
</span></code></pre></div>
<p>Following, clone the CRIDGE project from the GitLab, which also includes the respective standalone Helm chart.</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://labs.etsi.org/rep/osl/code/org.etsi.osl.cridge.git
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="nb">cd</span><span class="w"> </span>org.etsi.osl.cridge/helm/cridge/
</span></code></pre></div>
<p>Similarly, to configure CRIDGE, there are three different ways to provide this kubeconfig file during deployment:</p>
<ol>
<li>
<p><strong>Manual Copy to Helm Files Directory</strong>:</p>
<ul>
<li>Copy the kubeconfig file to the following directory:<br />
<code>org.etsi.osl.cridge/helm/cridge/files/org.etsi.osl.cridge</code>.</li>
<li>The deployment process will automatically copy the file into the <code>/root/.kube</code> directory of the CRIDGE container.</li>
<li><strong>Note:</strong> This method expects the kubeconfig file to be named exactly <code>kubeconfig.yaml</code> in the specified directory.</li>
</ul>
</li>
<li>
<p><strong>Passing the Kubeconfig File Using Helm (<code>--set-file</code>)</strong>:</p>
<ul>
<li>
<p>If you do not wish to manually copy the file, you can pass it directly during the Helm installation using the <code>--set-file</code> option:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>helm<span class="w"> </span>install<span class="w"> </span>cridge-release<span class="w"> </span>.<span class="w"> </span>--set-file<span class="w"> </span>kubeconfig.raw<span class="o">=</span>path/to/kubeconfig.yaml
</span></code></pre></div>
</li>
<li>
<p>This method reads the specified kubeconfig file and mounts it into the CRIDGE container during deployment.</p>
</li>
</ul>
</li>
<li>
<p><strong>Passing a Base64-Encoded Kubeconfig Using Helm (<code>--set</code>)</strong>:</p>

Dimitrios Giannopoulos
committed
<ul>
<li>
<p>Alternatively, you can pass the kubeconfig as a base64-encoded string:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>helm<span class="w"> </span>install<span class="w"> </span>cridge-release<span class="w"> </span>.<span class="w"> </span>--set<span class="w"> </span>kubeconfig.base64<span class="o">=</span><span class="s2">"</span><span class="k">$(</span>base64<span class="w"> </span>path/to/kubeconfig.yaml<span class="k">)</span><span class="s2">"</span>
</span></code></pre></div>
</li>
<li>
<p>This method encodes the kubeconfig content and passes it directly to the CRIDGE container.</p>
</li>

Dimitrios Giannopoulos
committed
</ul>
</li>
</ol>
<blockquote>
<p><strong>Note:</strong> Regardless of the method you choose, if you're using a non-standard kubeconfig file name, make sure to adjust the references or rename the file as needed.</p>
<p><strong>Important Note:</strong> If you are deploying CRIDGE in the same cluster and namespace as OpenSlice, no additional configuration is required for the message bus broker URL and OpenSlice communicates with CRIDGE directly. However, if CRIDGE is installed in a <strong>separate Kubernetes cluster</strong> from the one hosting OpenSlice, it is important to configure the <code>values.yaml</code> file for the CRIDGE Helm chart to point to the correct message bus broker URL. Please see <a href="#software-requirements">Nginx Ingress Controller (Kubernetes Community Edition) configuration</a> on how to properly expose the message bus in such scenario.</p>
</blockquote>
<p>In the <code>values.yaml</code> of the CRIDGE Helm chart, you must set <code>oscreds.activemq.brokerUrl</code> to point to the IP address of the ingress controller in the OpenSlice cluster, as shown below:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="nt">oscreds</span><span class="p">:</span>
</span><span id="__span-12-2"><a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="w"> </span><span class="nt">activemq</span><span class="p">:</span>
</span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="w"> </span><span class="nt">brokerUrl</span><span class="p">:</span><span class="w"> </span><span class="s">"tcp://<openslice-rootURL>:61616?jms.watchTopicAdvisories=false"</span>
</span></code></pre></div>
<h4 id="management-of-multiple-kubernetes-clusters">Management of multiple Kubernetes Clusters</h4>
<p>OpenSlice also offers management support of <em>multiple Kubernetes Clusters</em> simultaneously. </p>
<p>For this, you will have to replicate the steps in <a href="#standalone-cridge-deployment">Standalone CRIDGE deployment</a> for every Cluster. Each CRIDGE instance will be in charged with the management of one Kubernetes Cluster.</p>
<h3 id="external-services-optional">External Services (optional)</h3>

Dimitrios Giannopoulos
committed
<p>For configuring optional external services like Bugzilla and CentralLog, specify their URLs and credentials in the <code>values.yaml</code> file:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="nt">bugzillaurl</span><span class="p">:</span><span class="w"> </span><span class="s">"example.com:443/bugzilla"</span>
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="nt">bugzillakey</span><span class="p">:</span><span class="w"> </span><span class="s">"VH2Vw0iI5aYgALFFzVDWqhACwt6Hu3bXla9kSC1Z"</span>
</span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="nt">main_operations_product</span><span class="p">:</span><span class="w"> </span><span class="s">"Main</span><span class="nv"> </span><span class="s">Site</span><span class="nv"> </span><span class="s">Operations"</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">// this is the default product to issue tickets</span>
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="nt">centrallogurl</span><span class="p">:</span><span class="w"> </span><span class="s">"http://elk_ip:elk_port/index_name/_doc"</span>
</span></code></pre></div>

Dimitrios Giannopoulos
committed
<p>Bugzilla should have the following components under the specified product: </p>
<ul>
<li>NSD Deployment Request: Component used to schedule deployment req </li>
<li>Onboarding: Issues related to VNF/NSD Onboarding </li>
<li>Operations Support: Default component for operations support </li>
<li>Validation: Use to track validation processes of VNFs and NSDs </li>
<li>VPN Credentials/Access: Used for requesting VPN Credentials/Access </li>
</ul>
<p>Also in the 'Main Site Operations' product, a version named 'unspecified' must be created.</p>
<h3 id="application-and-logging">Application and Logging</h3>

Dimitrios Giannopoulos
committed
<p>Application-specific configurations, such as OAuth client secrets, can be set in the <code>spring</code> section:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="nt">spring</span><span class="p">:</span>
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a><span class="w"> </span><span class="nt">oauthClientSecret</span><span class="p">:</span><span class="w"> </span><span class="s">"secret"</span>
</span></code></pre></div>
<h3 id="ingress-and-root-url">Ingress and Root URL</h3>

Dimitrios Giannopoulos
committed
<p>To configure the ingress controller and root URL for OpenSlice, update the rooturl field with your ingress load balancer IP or domain. This setting is crucial for external access to your application:</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="nt">rooturl</span><span class="p">:</span><span class="w"> </span><span class="s">"http://openslice.com"</span><span class="w"> </span><span class="c1"># Example domain</span>
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="c1"># or</span>
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="nt">rooturl</span><span class="p">:</span><span class="w"> </span><span class="s">"http://3.15.198.35:8080"</span><span class="w"> </span><span class="c1"># Example IP with port</span>
</span></code></pre></div>
<h3 id="persistent-volume-for-mysql">Persistent Volume for MySQL</h3>

Dimitrios Giannopoulos
committed
<p>For persistent storage, especially for MySQL, define the storage size under the <code>mysql</code> section. This ensures that your database retains data across pod restarts and deployments.</p>
<div class="language-yaml highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="nt">mysql</span><span class="p">:</span>
</span><span id="__span-16-2"><a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="w"> </span><span class="nt">storage</span><span class="p">:</span><span class="w"> </span><span class="s">"10Gi"</span>
</span></code></pre></div>
<h3 id="tcp-forwarding-for-artemis">TCP Forwarding for Artemis</h3>
<p>To expose the message bus service (Artemis) via the ingress controller, it’s essential to configure TCP traffic forwarding. Artemis listens on port <code>61616</code>, and this traffic needs to be directed to the Artemis service within your Kubernetes cluster.</p>
<p>In the <a href="#software-requirements">Ingress Controller Setup</a> section, you already configured the Nginx ingress controller to handle this TCP forwarding. By setting the rule for port <code>61616</code>, traffic arriving at the ingress will be forwarded to the Artemis service defined in your Helm release.</p>
<p>This setup ensures that the message bus service is accessible externally via the ingress controller, completing the necessary configuration for Artemis.</p>
<h3 id="web-ui">Web UI</h3>

Dimitrios Giannopoulos
committed
<p>In folder <code>kubernetes/helm/openslice/files/org.etsi.osl.portal.web/src/js</code> you must make a copy of <code>config.js.default</code> file and rename it to <code>config.js</code>. </p>
<p>This is <strong>mandatory</strong> for the configuration file to be discoverable.</p>
<p>Edit the <code>config.js</code> configuration file with your static configuration, if needed.</p>
<div class="language-js highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="p">{</span>
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="w"> </span><span class="nx">TITLE</span><span class="o">:</span><span class="w"> </span><span class="s2">"OpenSlice by ETSI"</span><span class="p">,</span>
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a><span class="w"> </span><span class="nx">WIKI</span><span class="o">:</span><span class="w"> </span><span class="s2">"https://osl.etsi.org/documentation/"</span><span class="p">,</span>
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a><span class="w"> </span><span class="nx">BUGZILLA</span><span class="o">:</span><span class="w"> </span><span class="s2">"{{ .Values.rooturl }}/bugzilla"</span><span class="p">,</span>
</span><span id="__span-17-5"><a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a><span class="w"> </span><span class="nx">STATUS</span><span class="o">:</span><span class="w"> </span><span class="s2">"{{ .Values.rooturl }}/status"</span><span class="p">,</span>
</span><span id="__span-17-6"><a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a><span class="w"> </span><span class="nx">APIURL</span><span class="o">:</span><span class="w"> </span><span class="s2">"{{ .Values.rooturl }}"</span><span class="p">,</span>
</span><span id="__span-17-7"><a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a><span class="w"> </span><span class="nx">WEBURL</span><span class="o">:</span><span class="w"> </span><span class="s2">"{{ .Values.rooturl }}/nfvportal"</span><span class="p">,</span>
</span><span id="__span-17-8"><a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a><span class="w"> </span><span class="nx">APIOAUTHURL</span><span class="o">:</span><span class="w"> </span><span class="s2">"{{ .Values.rooturl }}/auth/realms/openslice"</span><span class="p">,</span>
</span><span id="__span-17-9"><a id="__codelineno-17-9" name="__codelineno-17-9" href="#__codelineno-17-9"></a><span class="w"> </span><span class="nx">APITMFURL</span><span class="o">:</span><span class="w"> </span><span class="s2">"{{ .Values.rooturl }}/tmf-api/serviceCatalogManagement/v4"</span>
</span><span id="__span-17-10"><a id="__codelineno-17-10" name="__codelineno-17-10" href="#__codelineno-17-10"></a><span class="p">}</span>
</span></code></pre></div>
<h3 id="tmf-web-ui">TMF Web UI</h3>

Dimitrios Giannopoulos
committed
<p>In the folder <code>kubernetes/helm/openslice/files/org.etsi.osl.tmf.web/src/assets/config</code> there are 3 files available for configuration:</p>
<ul>
<li>config.prod.default.json (Basic information + API configuration)</li>
<li>theming.default.scss (CSS color palette theming)</li>
<li>config.theming.default.json (HTML configuration - Logo, Favicon, Footer)</li>
</ul>
<p>You must make a copy of files:</p>
<ul>
<li><code>config.prod.default.json</code> and rename it to <code>config.prod.json</code></li>
<li><code>theming.default.scss</code> and rename it to <code>theming.scss</code></li>
</ul>
<p>The 2 files above (i.e. config.prod.json, theming.scss) are essential for the successful deployment of OpenSlice, and executing the above steps is <strong>mandatory</strong> for the configuration files to be discoverable.</p>
<p>Ensure that you check the <code>config.prod.json</code> and <code>theming.scss</code> files and readjust to your deployment if needed.</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="c1"># Starting from the root project directory</span>
</span><span id="__span-18-2"><a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="nb">cd</span><span class="w"> </span>kubernetes/helm/openslice/files/org.etsi.osl.tmf.web/src/assets/config
</span></code></pre></div>

Dimitrios Giannopoulos
committed
<p>E.g. You may edit "TITLE", "WIKI", etc properties with your domain title. Also configure TMF's API and Keycloak's location for the web application, if needed.</p>
<div class="language-json highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="p">{</span><span class="w"> </span>
</span><span id="__span-19-2"><a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a><span class="w"> </span><span class="nt">"TITLE"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OpenSlice by ETSI"</span><span class="p">,</span>
</span><span id="__span-19-3"><a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a><span class="w"> </span><span class="nt">"PORTALVERSION"</span><span class="p">:</span><span class="s2">"develop"</span><span class="p">,</span>
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
</span><span id="__span-19-4"><a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a><span class="w"> </span><span class="nt">"WIKI"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://osl.etsi.org/documentation"</span><span class="p">,</span>
</span><span id="__span-19-5"><a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a><span class="w"> </span><span class="nt">"BUGZILLA"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/bugzilla/"</span><span class="p">,</span>
</span><span id="__span-19-6"><a id="__codelineno-19-6" name="__codelineno-19-6" href="#__codelineno-19-6"></a><span class="w"> </span><span class="nt">"STATUS"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/status/"</span><span class="p">,</span>
</span><span id="__span-19-7"><a id="__codelineno-19-7" name="__codelineno-19-7" href="#__codelineno-19-7"></a><span class="w"> </span><span class="nt">"WEBURL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}"</span><span class="p">,</span>
</span><span id="__span-19-8"><a id="__codelineno-19-8" name="__codelineno-19-8" href="#__codelineno-19-8"></a><span class="w"> </span><span class="nt">"PORTAL_REPO_APIURL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/osapi"</span><span class="p">,</span>
</span><span id="__span-19-9"><a id="__codelineno-19-9" name="__codelineno-19-9" href="#__codelineno-19-9"></a><span class="w"> </span><span class="nt">"ASSURANCE_SERVICE_MGMT_APIURL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/oas-api"</span><span class="p">,</span>
</span><span id="__span-19-10"><a id="__codelineno-19-10" name="__codelineno-19-10" href="#__codelineno-19-10"></a><span class="w"> </span><span class="nt">"APITMFURL"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/tmf-api"</span><span class="p">,</span>
</span><span id="__span-19-11"><a id="__codelineno-19-11" name="__codelineno-19-11" href="#__codelineno-19-11"></a><span class="w"> </span><span class="nt">"OAUTH_CONFIG"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
</span><span id="__span-19-12"><a id="__codelineno-19-12" name="__codelineno-19-12" href="#__codelineno-19-12"></a><span class="w"> </span><span class="nt">"issuer"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/auth/realms/openslice"</span><span class="p">,</span>
</span><span id="__span-19-13"><a id="__codelineno-19-13" name="__codelineno-19-13" href="#__codelineno-19-13"></a><span class="w"> </span><span class="nt">"loginUrl"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/auth/realms/openslice/protocol/openid-connect/auth"</span><span class="p">,</span>
</span><span id="__span-19-14"><a id="__codelineno-19-14" name="__codelineno-19-14" href="#__codelineno-19-14"></a><span class="w"> </span><span class="nt">"tokenEndpoint"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/auth/realms/openslice/protocol/openid-connect/token"</span><span class="p">,</span>
</span><span id="__span-19-15"><a id="__codelineno-19-15" name="__codelineno-19-15" href="#__codelineno-19-15"></a><span class="w"> </span><span class="nt">"userinfoEndpoint"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/auth/realms/openslice/protocol/openid-connect/userinfo"</span><span class="p">,</span>
</span><span id="__span-19-16"><a id="__codelineno-19-16" name="__codelineno-19-16" href="#__codelineno-19-16"></a><span class="w"> </span><span class="nt">"redirectUri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/redirect"</span><span class="p">,</span>
</span><span id="__span-19-17"><a id="__codelineno-19-17" name="__codelineno-19-17" href="#__codelineno-19-17"></a><span class="w"> </span><span class="nt">"logoutUrl"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}/auth/realms/openslice/protocol/openid-connect/logout"</span><span class="p">,</span><span class="w"> </span>
</span><span id="__span-19-18"><a id="__codelineno-19-18" name="__codelineno-19-18" href="#__codelineno-19-18"></a><span class="w"> </span><span class="nt">"postLogoutRedirectUri"</span><span class="p">:</span><span class="w"> </span><span class="s2">"{BASEURL}"</span><span class="p">,</span>
</span><span id="__span-19-19"><a id="__codelineno-19-19" name="__codelineno-19-19" href="#__codelineno-19-19"></a>
</span><span id="__span-19-20"><a id="__codelineno-19-20" name="__codelineno-19-20" href="#__codelineno-19-20"></a><span class="w"> </span><span class="nt">"responseType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"code"</span><span class="p">,</span>
</span><span id="__span-19-21"><a id="__codelineno-19-21" name="__codelineno-19-21" href="#__codelineno-19-21"></a><span class="w"> </span><span class="nt">"oidc"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
</span><span id="__span-19-22"><a id="__codelineno-19-22" name="__codelineno-19-22" href="#__codelineno-19-22"></a><span class="w"> </span><span class="nt">"clientId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"osapiWebClientId"</span><span class="p">,</span>
</span><span id="__span-19-23"><a id="__codelineno-19-23" name="__codelineno-19-23" href="#__codelineno-19-23"></a><span class="w"> </span><span class="nt">"dummyClientSecret"</span><span class="p">:</span><span class="w"> </span><span class="s2">"secret"</span><span class="p">,</span>
</span><span id="__span-19-24"><a id="__codelineno-19-24" name="__codelineno-19-24" href="#__codelineno-19-24"></a>
</span><span id="__span-19-25"><a id="__codelineno-19-25" name="__codelineno-19-25" href="#__codelineno-19-25"></a><span class="w"> </span><span class="nt">"requireHttps"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
</span><span id="__span-19-26"><a id="__codelineno-19-26" name="__codelineno-19-26" href="#__codelineno-19-26"></a><span class="w"> </span><span class="nt">"useHttpBasicAuth"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
</span><span id="__span-19-27"><a id="__codelineno-19-27" name="__codelineno-19-27" href="#__codelineno-19-27"></a><span class="w"> </span><span class="nt">"clearHashAfterLogin"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span>
</span><span id="__span-19-28"><a id="__codelineno-19-28" name="__codelineno-19-28" href="#__codelineno-19-28"></a>
</span><span id="__span-19-29"><a id="__codelineno-19-29" name="__codelineno-19-29" href="#__codelineno-19-29"></a><span class="w"> </span><span class="nt">"showDebugInformation"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span>
</span><span id="__span-19-30"><a id="__codelineno-19-30" name="__codelineno-19-30" href="#__codelineno-19-30"></a><span class="w"> </span><span class="p">}</span>
</span><span id="__span-19-31"><a id="__codelineno-19-31" name="__codelineno-19-31" href="#__codelineno-19-31"></a><span class="p">}</span>
</span></code></pre></div>

Dimitrios Giannopoulos
committed
<blockquote>

Dimitrios Giannopoulos
committed
<p>The {BASEURL} placeholder in the file automatically detects the Origin (Protocol://Domain:Port) of the deployment and applies it to every respective property. E.g. If you are attempting a local deployment of OpenSlice, then {BASEURL} is automatically translated to "http://localhost". Similarly, you may use {BASEURL} to translate to a public deployment configuration, e.g. "https://portal.openslice.eu".</p>

Dimitrios Giannopoulos
committed
</blockquote>
<p>If further customization, apart from the default provided, is needed for branding (Logo, Footer) then <code>config.theming.json</code> needs to be created in kubernetes/helm/openslice/files/org.etsi.osl.tmf.web/src/assets/config directory, as follows:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="c1"># Starting from the root project directory</span>
</span><span id="__span-20-2"><a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="nb">cd</span><span class="w"> </span>kubernetes/helm/openslice/files/org.etsi.osl.tmf.web/src/assets/config
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-21-1"><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>sudo<span class="w"> </span>cp<span class="w"> </span>config.theming.default.json<span class="w"> </span>config.theming.json
</span></code></pre></div>

Dimitrios Giannopoulos
committed
<h2 id="deploy-the-helm-chart">Deploy the Helm Chart</h2>

Dimitrios Giannopoulos
committed
<p>After configuring the services, and editing the <code>values.yaml</code> file accordingly, the helm install command can be performed.</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="nb">cd</span><span class="w"> </span>kubernetes/helm/openslice/
</span><span id="__span-22-2"><a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a>helm<span class="w"> </span>install<span class="w"> </span>myopenslice<span class="w"> </span>.<span class="w"> </span>--namespace<span class="w"> </span>openslice<span class="w"> </span>--create-namespace
</span></code></pre></div>

Dimitrios Giannopoulos
committed
<h2 id="validating-deployments-and-container-monitoring">Validating deployments and container monitoring</h2>
<p>In a Kubernetes environment, you can monitor the status of your deployments and containers using <code>kubectl</code>, the Kubernetes command-line tool, which provides powerful capabilities for inspecting the state of resources in your cluster.</p>
<h3 id="checking-the-status-of-your-applications-deployment">Checking the Status of your application's deployment</h3>
<p>To check the status of your deployment, use the following commands. The output should be similar:</p>
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
<p><div class="language-bash highlight"><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a>kubectl<span class="w"> </span>get<span class="w"> </span>pods<span class="w"> </span>-n<span class="w"> </span>openslice
</span><span id="__span-23-2"><a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a>
</span><span id="__span-23-3"><a id="__codelineno-23-3" name="__codelineno-23-3" href="#__codelineno-23-3"></a>NAME<span class="w"> </span>READY<span class="w"> </span>UP-TO-DATE<span class="w"> </span>AVAILABLE<span class="w"> </span>AGE
</span><span id="__span-23-4"><a id="__codelineno-23-4" name="__codelineno-23-4" href="#__codelineno-23-4"></a>myopenslice-artemis<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-5"><a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a>myopenslice-blockdiag<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-6"><a id="__codelineno-23-6" name="__codelineno-23-6" href="#__codelineno-23-6"></a>myopenslice-bugzilla<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-7"><a id="__codelineno-23-7" name="__codelineno-23-7" href="#__codelineno-23-7"></a>myopenslice-centrallog<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-8"><a id="__codelineno-23-8" name="__codelineno-23-8" href="#__codelineno-23-8"></a>myopenslice-cridge<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-9"><a id="__codelineno-23-9" name="__codelineno-23-9" href="#__codelineno-23-9"></a>myopenslice-keycloak<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-10"><a id="__codelineno-23-10" name="__codelineno-23-10" href="#__codelineno-23-10"></a>myopenslice-kroki<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-11"><a id="__codelineno-23-11" name="__codelineno-23-11" href="#__codelineno-23-11"></a>myopenslice-manoclient<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-12"><a id="__codelineno-23-12" name="__codelineno-23-12" href="#__codelineno-23-12"></a>myopenslice-oasapi<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-13"><a id="__codelineno-23-13" name="__codelineno-23-13" href="#__codelineno-23-13"></a>myopenslice-osom<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-14"><a id="__codelineno-23-14" name="__codelineno-23-14" href="#__codelineno-23-14"></a>myopenslice-osportalapi<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-15"><a id="__codelineno-23-15" name="__codelineno-23-15" href="#__codelineno-23-15"></a>myopenslice-osscapi<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-16"><a id="__codelineno-23-16" name="__codelineno-23-16" href="#__codelineno-23-16"></a>myopenslice-portalweb<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span><span id="__span-23-17"><a id="__codelineno-23-17" name="__codelineno-23-17" href="#__codelineno-23-17"></a>myopenslice-tmfweb<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>6m28s
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>kubectl<span class="w"> </span>get<span class="w"> </span>deployments<span class="w"> </span>-n<span class="w"> </span>openslice
</span><span id="__span-24-2"><a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a>
</span><span id="__span-24-3"><a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a>NAME<span class="w"> </span>READY<span class="w"> </span>UP-TO-DATE<span class="w"> </span>AVAILABLE<span class="w"> </span>AGE
</span><span id="__span-24-4"><a id="__codelineno-24-4" name="__codelineno-24-4" href="#__codelineno-24-4"></a>myopenslice-artemis<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-5"><a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a>myopenslice-blockdiag<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-6"><a id="__codelineno-24-6" name="__codelineno-24-6" href="#__codelineno-24-6"></a>myopenslice-bugzilla<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-7"><a id="__codelineno-24-7" name="__codelineno-24-7" href="#__codelineno-24-7"></a>myopenslice-centrallog<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-8"><a id="__codelineno-24-8" name="__codelineno-24-8" href="#__codelineno-24-8"></a>myopenslice-cridge<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-9"><a id="__codelineno-24-9" name="__codelineno-24-9" href="#__codelineno-24-9"></a>myopenslice-keycloak<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-10"><a id="__codelineno-24-10" name="__codelineno-24-10" href="#__codelineno-24-10"></a>myopenslice-kroki<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-11"><a id="__codelineno-24-11" name="__codelineno-24-11" href="#__codelineno-24-11"></a>myopenslice-manoclient<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-12"><a id="__codelineno-24-12" name="__codelineno-24-12" href="#__codelineno-24-12"></a>myopenslice-oasapi<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-13"><a id="__codelineno-24-13" name="__codelineno-24-13" href="#__codelineno-24-13"></a>myopenslice-osom<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-14"><a id="__codelineno-24-14" name="__codelineno-24-14" href="#__codelineno-24-14"></a>myopenslice-osportalapi<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-15"><a id="__codelineno-24-15" name="__codelineno-24-15" href="#__codelineno-24-15"></a>myopenslice-osscapi<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-16"><a id="__codelineno-24-16" name="__codelineno-24-16" href="#__codelineno-24-16"></a>myopenslice-portalweb<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span><span id="__span-24-17"><a id="__codelineno-24-17" name="__codelineno-24-17" href="#__codelineno-24-17"></a>myopenslice-tmfweb<span class="w"> </span><span class="m">1</span>/1<span class="w"> </span><span class="m">1</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>7m17s
</span></code></pre></div>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-25-1"><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a>kubectl<span class="w"> </span>get<span class="w"> </span>services<span class="w"> </span>-n<span class="w"> </span>openslice
</span><span id="__span-25-2"><a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a>
</span><span id="__span-25-3"><a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a>NAME<span class="w"> </span>TYPE<span class="w"> </span>CLUSTER-IP<span class="w"> </span>EXTERNAL-IP<span class="w"> </span>PORT<span class="o">(</span>S<span class="o">)</span><span class="w"> </span>AGE
</span><span id="__span-25-4"><a id="__codelineno-25-4" name="__codelineno-25-4" href="#__codelineno-25-4"></a>myopenslice-artemis<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.101.128.223<span class="w"> </span><none><span class="w"> </span><span class="m">8161</span>/TCP,61616/TCP,61613/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-5"><a id="__codelineno-25-5" name="__codelineno-25-5" href="#__codelineno-25-5"></a>myopenslice-blockdiag<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.109.196.90<span class="w"> </span><none><span class="w"> </span><span class="m">8001</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-6"><a id="__codelineno-25-6" name="__codelineno-25-6" href="#__codelineno-25-6"></a>myopenslice-bugzilla<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.107.10.101<span class="w"> </span><none><span class="w"> </span><span class="m">13010</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-7"><a id="__codelineno-25-7" name="__codelineno-25-7" href="#__codelineno-25-7"></a>myopenslice-centrallog<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.109.84.33<span class="w"> </span><none><span class="w"> </span><span class="m">13013</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-8"><a id="__codelineno-25-8" name="__codelineno-25-8" href="#__codelineno-25-8"></a>myopenslice-keycloak<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.104.172.73<span class="w"> </span><none><span class="w"> </span><span class="m">8080</span>/TCP,8443/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-9"><a id="__codelineno-25-9" name="__codelineno-25-9" href="#__codelineno-25-9"></a>myopenslice-kroki<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.106.92.111<span class="w"> </span><none><span class="w"> </span><span class="m">8000</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-10"><a id="__codelineno-25-10" name="__codelineno-25-10" href="#__codelineno-25-10"></a>myopenslice-manoclient<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.100.143.154<span class="w"> </span><none><span class="w"> </span><span class="m">13011</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-11"><a id="__codelineno-25-11" name="__codelineno-25-11" href="#__codelineno-25-11"></a>myopenslice-mysql<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.108.206.75<span class="w"> </span><none><span class="w"> </span><span class="m">3306</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-12"><a id="__codelineno-25-12" name="__codelineno-25-12" href="#__codelineno-25-12"></a>myopenslice-oasapi<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.100.107.66<span class="w"> </span><none><span class="w"> </span><span class="m">13101</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-13"><a id="__codelineno-25-13" name="__codelineno-25-13" href="#__codelineno-25-13"></a>myopenslice-osom<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.97.88.133<span class="w"> </span><none><span class="w"> </span><span class="m">13100</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-14"><a id="__codelineno-25-14" name="__codelineno-25-14" href="#__codelineno-25-14"></a>myopenslice-osportalapi<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.111.212.76<span class="w"> </span><none><span class="w"> </span><span class="m">13000</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-15"><a id="__codelineno-25-15" name="__codelineno-25-15" href="#__codelineno-25-15"></a>myopenslice-osscapi<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.101.84.220<span class="w"> </span><none><span class="w"> </span><span class="m">13082</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-16"><a id="__codelineno-25-16" name="__codelineno-25-16" href="#__codelineno-25-16"></a>myopenslice-portalweb<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.101.16.112<span class="w"> </span><none><span class="w"> </span><span class="m">80</span>/TCP<span class="w"> </span>7m43s
</span><span id="__span-25-17"><a id="__codelineno-25-17" name="__codelineno-25-17" href="#__codelineno-25-17"></a>myopenslice-tmfweb<span class="w"> </span>ClusterIP<span class="w"> </span><span class="m">10</span>.101.157.185<span class="w"> </span><none><span class="w"> </span><span class="m">80</span>/TCP<span class="w"> </span>7m43s
</span></code></pre></div></p>

Dimitrios Giannopoulos
committed
<h3 id="accessing-logs-for-troubleshooting">Accessing Logs for Troubleshooting</h3>
<p>If a pod is not in the expected state, you can access its logs for troubleshooting:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-26-1"><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a>kubectl<span class="w"> </span>logs<span class="w"> </span><pod-name><span class="w"> </span>-n<span class="w"> </span>openslice
</span></code></pre></div>
<h2 id="post-installation-steps-mandatory">Post installation steps (mandatory)</h2>
<p>After the successful deployment of OpenSlice, to ensure the end-to-end user experience, <strong>this section is mandatory</strong>. It contains crucial configuration in regard of authentication and user creation.</p>

Dimitrios Giannopoulos
committed
<h3 id="configure-keycloak-server">Configure Keycloak server</h3>
<p>The Keycloack server is managing authentication and running on a container at port 8080. It is also proxied to your host via the ingress resource under http://your-domain/auth. </p>
<ul>
<li>
<p>Navigate to http://your-domain/auth/ or https://your-domain/auth/, (http://ipaddress:8080/auth/ or https://ipaddress:8443/auth/ which are directly accessible without proxy) </p>
</li>
<li>
<p>Navigate to Administration Console </p>
</li>
<li>
<p>Login with the credentials from section <a href="#keycloak">Keycloak Configuration</a>. Default values are:</p>

Dimitrios Giannopoulos
committed
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
<ul>
<li>user: admin </li>
<li>password: Pa55w0rd</li>
</ul>
</li>
</ul>
<blockquote>
<p>This applies only if you are running in HTTP and get a message: HTTPS required.</p>
</blockquote>
<p>To resolve this issue <u>when running in HTTP</u>: </p>
<ul>
<li>Select the master realm from top left corner</li>
<li>Go to login Tab and select "Require SSL": None</li>
<li>Repeat for realm Openslice</li>
</ul>
<blockquote>
<p>If you are running in HTTPS, then "Require SSL" can be left unchanged to external requests.</p>
</blockquote>
<h4 id="1-configure-email">1. Configure email</h4>
<p>Keycloak allows new users to register. Subsequently, this will also allow new users to register to the OpenSlice portal.</p>
<p>Navigate to realm Openslice > Realm Settings > Login Tab > check User registration, Verify email, Forgot password etc.</p>
<p>Finally, enter the details of the mail server at the Email Tab.</p>
<blockquote>
<p>Email configuration is optional for test runs, but if not provided the above functionalities (e.g. external user registration) will not be possible.</p>
</blockquote>
<h4 id="2-add-an-openslice-admin-user">2. Add an OpenSlice admin user</h4>
<p>This step is mandatory so as to access the OpenSlice Web UI. To add an OpenSlice admin user you must:
- Navigate to realm Openslice > Users > Add user
- Set a password
- Upon creation, navigate to Role Mappings and add ADMIN to Assigned Roles list</p>
<blockquote>
<p>That user is different from the Keycloak admin user. It is required to login and browse the OpenSlice Web UI. The Role ADMIN guarantee full access through the OpenSlice UI, thus such a user is always required.</p>
</blockquote>
<h3 id="nfv-orchestrator-configuration">NFV Orchestrator Configuration</h3>
<p>After successfully deploying and configuring OpenSlice, you may configure its environment (e.g. the NFVO) that will facilitate the deployment of NFV artifacts.</p>
<p>See <a href="../../configuration/nfvo_config/">NFV Orchestrator Configuration</a>.</p>

Dimitrios Giannopoulos
committed
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
</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>

Dimitrios Giannopoulos
committed
<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 8z"/></svg>

Dimitrios Giannopoulos
committed
Back to top
</button>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../docker_compose/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Docker Compose">

Dimitrios Giannopoulos
committed
<div class="md-footer__button md-icon">

Dimitrios Giannopoulos
committed
<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 11z"/></svg>

Dimitrios Giannopoulos
committed
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Docker Compose
</div>
</div>
</a>
<a href="../../portals/" class="md-footer__link md-footer__link--next" aria-label="Next: Portals">

Dimitrios Giannopoulos
committed
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Portals

Dimitrios Giannopoulos
committed
</div>
</div>
<div class="md-footer__button md-icon">

Dimitrios Giannopoulos
committed
<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 11z"/></svg>

Dimitrios Giannopoulos
committed
</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">
Copyright © 2025 ETSI OSL

Dimitrios Giannopoulos
committed
</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.7.2 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 2024 Fonticons, Inc.--><path d="M352 256c0 22.2-1.2 43.6-3.3 64H163.4c-2.2-20.4-3.3-41.8-3.3-64s1.2-43.6 3.3-64h185.3c2.2 20.4 3.3 41.8 3.3 64m28.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-64m112.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.7m-209 0H18.6c30-74.1 93.6-130.9 172-151.6-25.5 34.2-45.3 87.7-55.3 151.6M8.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-64m186.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.6zm358.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.7z"/></svg>

Dimitrios Giannopoulos
committed
</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.7.2 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 2024 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.81s-5.7.083-8.4 1.11c-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.1 18.1 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.3s9.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-82"/></svg>

Dimitrios Giannopoulos
committed
</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.7.2 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 2024 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.3M135.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.5m282.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.9z"/></svg>

Dimitrios Giannopoulos
committed
</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.7.2 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 2024 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.9zm-24.8 373.8h39.1L151.1 88h-42z"/></svg>

Dimitrios Giannopoulos
committed
</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>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.f8cc74c7.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
<script src="../../../assets/javascripts/bundle.60a45f97.min.js"></script>

Dimitrios Giannopoulos
committed
<script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});
document$.subscribe(() => { lightbox.reload() });
</script></body>