Newer
Older
<!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 OCF Documentation page">
<meta name="author" content="OpenCAPIF by ETSI">
<link rel="canonical" href="https://ocf.etsi.org/develop/gettingstarted/howtorun/">
<link rel="prev" href="../../architecture/">
<link rel="next" href="../../testing/testplan/">
<link rel="icon" href="../../images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
<title>How to Run - ETSI SDG OCF Documentation</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../stylesheets/extra.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#how-to-run" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="ETSI SDG OCF Documentation" class="md-header__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">
<img src="../../images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
ETSI SDG OCF Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
How to Run
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://labs.etsi.org/rep/ocf" 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.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 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>
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
</div>
<div class="md-source__repository">
OCF 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 OCF Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG OCF Documentation" data-md-component="logo">
<img src="../../images/logos/Open CAPIF Logo Screen_B_W Slogan NEG.png" alt="logo">
</a>
ETSI SDG OCF Documentation
</label>
<div class="md-nav__source">
<a href="https://labs.etsi.org/rep/ocf" 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.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 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>
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
</div>
<div class="md-source__repository">
OCF GitLab
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<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">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
<li class="md-nav__item">
<a href="../../releasenotes/" class="md-nav__link">
<span class="md-ellipsis">
Release Notes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
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
</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">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
How to Run
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
How to Run
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
<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-folder-to-download-the-project" class="md-nav__link">
<span class="md-ellipsis">
1. Create a folder to download the project
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-download-the-deployment-script" class="md-nav__link">
<span class="md-ellipsis">
2. Download the deployment script
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-run-the-deployment-script" class="md-nav__link">
<span class="md-ellipsis">
3. Run the deployment script
</span>
</a>
</li>
</ul>
</nav>
</li>
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
<li class="md-nav__item">
<a href="#run-all-capif-services-locally-with-docker-images" class="md-nav__link">
<span class="md-ellipsis">
Run All CAPIF Services locally with Docker images
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack" class="md-nav__link">
<span class="md-ellipsis">
Run All CAPIF Services locally with Docker images and deploy monitoring stack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-each-service-using-docker" class="md-nav__link">
<span class="md-ellipsis">
Run each service using Docker
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-each-service-using-python" class="md-nav__link">
<span class="md-ellipsis">
Run each service using Python
</span>
</a>
<nav class="md-nav" aria-label="Run each service using Python">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#start-your-testing-with-opencapif" class="md-nav__link">
<span class="md-ellipsis">
Start Your Testing with OpenCAPIF
</span>
</a>
</li>
</ul>
</nav>
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Testing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Testing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../testing/testplan/" class="md-nav__link">
<span class="md-ellipsis">
Test Plan
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../testing/robotframework/" class="md-nav__link">
<span class="md-ellipsis">
Robot Framework
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../testing/postman/" class="md-nav__link">
<span class="md-ellipsis">
Postman
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Contribute
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Contribute
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../contribute/documenting/" class="md-nav__link">
<span class="md-ellipsis">
Documenting
</span>
</a>
</li>
</ul>
</nav>
</li>
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
<li class="md-nav__item">
<a href="../../FAQ/" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
<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-folder-to-download-the-project" class="md-nav__link">
<span class="md-ellipsis">
1. Create a folder to download the project
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-download-the-deployment-script" class="md-nav__link">
<span class="md-ellipsis">
2. Download the deployment script
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-run-the-deployment-script" class="md-nav__link">
<span class="md-ellipsis">
3. Run the deployment script
</span>
</a>
</li>
</ul>
</nav>
</li>
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
<li class="md-nav__item">
<a href="#run-all-capif-services-locally-with-docker-images" class="md-nav__link">
<span class="md-ellipsis">
Run All CAPIF Services locally with Docker images
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack" class="md-nav__link">
<span class="md-ellipsis">
Run All CAPIF Services locally with Docker images and deploy monitoring stack
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-each-service-using-docker" class="md-nav__link">
<span class="md-ellipsis">
Run each service using Docker
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#run-each-service-using-python" class="md-nav__link">
<span class="md-ellipsis">
Run each service using Python
</span>
</a>
<nav class="md-nav" aria-label="Run each service using Python">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#start-your-testing-with-opencapif" class="md-nav__link">
<span class="md-ellipsis">
Start Your Testing with OpenCAPIF
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="how-to-run">How to Run</h1>
<ol>
<li><a href="#downloading-the-project">Downloading the project</a> <ol>
<li><a href="#1-create-a-folder-to-download-the-project">Create a folder to download the project</a></li>
<li><a href="#2-download-the-deployment-script">Download the deployment script</a></li>
<li><a href="#3-run-the-deployment-script">Run the deployment script</a></li>
</ol>
</li>
<li>Run the services<ul>
<li><a href="#run-all-capif-services-locally-with-docker-images">Run <strong>all</strong> CAPIF Services locally with Docker images</a></li>
<li><a href="#run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack">Run <strong>all</strong> CAPIF Services locally with Docker images <em>and deploy monitoring stack</em></a></li>
<li><a href="#run-each-service-using-docker">Run <strong>each</strong> service using Docker</a></li>
<li><a href="#run-each-service-using-python">Run <strong>each</strong> service using Python</a></li>
</ul>
</li>
<li><a href="#start-your-testing-with-opencapif">Start your testing with OpenCAPIF</a></li>
</ol>
<blockquote>
<p>Capif services are developed under <a href="https://labs.etsi.org/rep/ocf/capif/-/tree/main/services">services folder</a>.</p>
</blockquote>
<h3 id="downloading-the-project">Downloading the project</h3>
<p>You can easily download CAPIF to run in local environment following next steps:</p>
<h4 id="1-create-a-folder-to-download-the-project">1. Create a folder to download the project</h4>
<pre><code>mkdir OpenCAPIF
cd OpenCAPIF
</code></pre>
<h4 id="2-download-the-deployment-script">2. Download the deployment script</h4>
Stavros-Anastasios Charismiadis
committed
<p>Download the deployment / environment preparation script (press <a href="https://labs.etsi.org/rep/ocf/capif/-/raw/staging/deploy.sh?inline=false">here</a> to directly download script):</p>
<pre><code>wget https://labs.etsi.org/rep/ocf/capif/-/raw/staging/deploy.sh
</code></pre>
<p>Make it executable:</p>
<pre><code>chmod +x deploy.sh
</code></pre>
<h4 id="3-run-the-deployment-script">3. Run the deployment script</h4>
<p>This script selects the branch for capif repository project to pull from.</p>
<p>If you run the script without selecting a branch the the main branch is going to be selected.</p>
<p>We recommend:</p>
<ul>
<li><strong>main</strong> branch for the most stable experience and <strong>staging</strong> branch for an experience with the latest features (for staging branch installation, it is strongly advisable that you may as well follow the staging documentation)</li>
</ul>
<pre><code># ./deploy.sh [branch to fetch] [true or false (default) to install monitoring stack or not]
sudo ./deploy.sh staging
</code></pre>
<blockquote>
<p><strong>We recommend running the deploy.sh script with root permissions! In other case, some directories may not be accessible by the project building tools and hinder the smooth installation.</strong></p>
</blockquote>
<h3 id="run-all-capif-services-locally-with-docker-images">Run All CAPIF Services locally with Docker images</h3>
<p>To run using docker and docker compose, version 2.10 or higher, you must ensure you have those tools installed in your machine. Also to simplify the process, we have 3 scripts allowing docker images to deploy, check and cleanup.</p>
<p>All these scripts are available under <strong><em>services</em></strong> directory.</p>
<p>To run CAPIF APIs locally using docker and docker-compose you can use run.sh script:</p>
<pre><code>./run.sh -h
Usage: ./run.sh <options>
-c : Setup different hostname for capif
-m : Launch monitoring service
-h : show this help
</code></pre>
<p>This script builds and runs all services using docker images, including mongodb and nginx locally and in the background, and imports ca.crt to nginx. By default monitoring is not activated and Nginx is deployed use <strong>capifcore</strong> as a hostname. </p>
<p>Some examples of use:</p>
<pre><code># Default values, No monitoring and capifcore as CAPIF_HOSTNAME
./run.sh
# opencapif.etsi.org as CAPIF_HOSTNAME
./run.sh -c opencapif.etsi.org
# opencapif.etsi.org as CAPIF_HOSTNAME and monitoring activated
./run.sh -c opencapif.etsi.org -m
</code></pre>
<p>If you want to check if all CAPIF services are running properly in a local machine after executing run.sh, you can use:</p>
<pre><code>./check_services_are_running.sh
</code></pre>
<p>This shell script will return 0 if all services are running properly.</p>
<p>When we need to stop all CAPIF services, we can use next bash script:</p>
<pre><code>./clean_capif_docker_services.sh -a
</code></pre>
<p>NOTE: You can use different flags if you only want to stop some of them, please check the help using:</p>
<pre><code>./clean_capif_docker_services.sh -h
Usage: clean_capif_docker_services.sh <options>
-c : clean capif services
-v : clean vault service
-r : clean register service
-m : clean monitoring service
-a : clean all services
-h : show this help
</code></pre>
<p>This shell script will remove and clean all CAPIF services started previously with run.sh</p>
<p>On the other hand you can check logs using show_logs.sh script, please check options:</p>
<pre><code>./show_logs.sh
You must specify an option when running the script.
Usage: ./show_logs.sh <options>
-c : Show capif services
-v : Show vault service
-r : Show register service
-m : Show monitoring service
-a : Show all services
-f : Follow log output
-h : Show this help
</code></pre>
<blockquote>
<p>You can also use option -f in order to follow log output in real time</p>
</blockquote>
<h3 id="run-all-capif-services-locally-with-docker-images-and-deploy-monitoring-stack">Run All CAPIF Services locally with Docker images and deploy monitoring stack</h3>
<p>It is now possible to deploy a monitoring stack for CAPIF with Grafana, Prometheus, FluentBit, Loki, Cadvisor, Tempo and Opentelemetry.</p>
<p>To deploy CAPIF together with the monitoring stack, it is only necessary to execute the following.</p>
<pre><code>./run.sh -m true
</code></pre>
<p>After they have been built, the different panels can be consulted in Grafana at the url</p>
<pre><code>http://localhost:3000
</code></pre>
<blockquote>
<p>By default, the monitoring option is set to false. Once up, all data sources and dashboards are automatically provisioned.</p>
</blockquote>
<h3 id="run-each-service-using-docker">Run each service using Docker</h3>
<p>Also you can run OpenCAPIF service by service using docker:</p>
<pre><code>cd <Service>
docker build -t capif_security .
docker run -p 8080:8080 capif_security
</code></pre>
<h3 id="run-each-service-using-python">Run each service using Python</h3>
<p>Run using python</p>
<pre><code>cd <Service>
pip3 install -r requirements.txt
python3 -m <service>
</code></pre>
<h4 id="start-your-testing-with-opencapif">Start Your Testing with OpenCAPIF</h4>
<p>Related with OpenCAPIF Testing, the following sections help you to understand testing implemented and how to run it by yourself:</p>
<ul>
<li><a href="../../testing/testplan/" title="Test Plan">Test Plan Directory</a>: Here you can find the complete test plan definition that are accomplish by all versions released of OpenCAPIF.</li>
<li><a href="../../testing/robotframework/" title="Robot Framework">Testing with Robot Framework</a>: At this section you can find all information about how to run the test suite implemented using Robot Framework.</li>
<li><a href="../../testing/postman/" title="Postman">Testing with Postman</a>: Easy way to understand the complete basic OpenCAPIF flow, acting as invoker and provider.</li>
</ul>