Skip to content
Snippets Groups Projects
Normal view Permalink
index.html 73.2 KiB
Newer Older
yangalicace1's avatar
Deployed 5d16567 to v3.0.0 in public with MkDocs 1.6.1 and mike 2.1.3
yangalicace1 committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 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 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 

<!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 TFS Documentation page">
      
      
        <meta name="author" content="TeraflowSDN by ETSI">
      
      
        <link rel="canonical" href="https://tfs.etsi.org/v3.0.0/deployment_guide/">
      
      
        <link rel="prev" href="..">
      
      
        <link rel="next" href="../development_guide/">
      
      
      <link rel="icon" href="../images/favicon.png">
      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.44">
    
    
      
        <title>1. Deployment Guide - ETSI SDG TFS Documentation</title>
      
    
    
      <link rel="stylesheet" href="../assets/stylesheets/main.0253249f.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="0D47A1" data-md-color-accent="1565C0">
  
    
    <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="#11-configure-your-machine" 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 TFS Documentation" class="md-header__button md-logo" aria-label="ETSI SDG TFS Documentation" data-md-component="logo">
      
  <img src="../images/logos/TeraFlow SDN Logo Screen_B_W 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 TFS Documentation
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              1. Deployment Guide
            
          </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/tfs" 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.6.0 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>
  </div>
  <div class="md-source__repository">
    TFS 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 md-nav--integrated" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href=".." title="ETSI SDG TFS Documentation" class="md-nav__button md-logo" aria-label="ETSI SDG TFS Documentation" data-md-component="logo">
      
  <img src="../images/logos/TeraFlow SDN Logo Screen_B_W NEG.png" alt="logo">

    </a>
    ETSI SDG TFS Documentation
  </label>
  
    <div class="md-nav__source">
      <a href="https://labs.etsi.org/rep/tfs" 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.6.0 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>
  </div>
  <div class="md-source__repository">
    TFS GitLab
  </div>
</a>
    </div>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href=".." class="md-nav__link">
        
  
  <span class="md-ellipsis">
    0. Home
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
    
  
  
  
    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
      
      
      
        <label class="md-nav__link md-nav__link--active" for="__toc">
          
  
  <span class="md-ellipsis">
    1. Deployment Guide
  </span>
  

          <span class="md-nav__icon md-icon"></span>
        </label>
      
      <a href="./" class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    1. Deployment Guide
  </span>
  

      </a>
      
        

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon"></span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#11-configure-your-machine" class="md-nav__link">
    <span class="md-ellipsis">
      1.1. Configure your Machine
    </span>
  </a>
  
    <nav class="md-nav" aria-label="1.1. Configure your Machine">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#111-physical-server" class="md-nav__link">
    <span class="md-ellipsis">
      1.1.1. Physical Server
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#112-oracle-virtual-box" class="md-nav__link">
    <span class="md-ellipsis">
      1.1.2. Oracle Virtual Box
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#113-vmware-fusion" class="md-nav__link">
    <span class="md-ellipsis">
      1.1.3. VMWare Fusion
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#114-openstack" class="md-nav__link">
    <span class="md-ellipsis">
      1.1.4. OpenStack
    </span>
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#115-vagrant-box" class="md-nav__link">
    <span class="md-ellipsis">
      1.1.5. Vagrant Box
    </span>
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#12-install-microk8s" class="md-nav__link">
    <span class="md-ellipsis">
      1.2. Install MicroK8s
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#13-deploy-teraflowsdn" class="md-nav__link">
    <span class="md-ellipsis">
      1.3. Deploy TeraFlowSDN
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#14-webui-and-grafana-dashboards" class="md-nav__link">
    <span class="md-ellipsis">
      1.4. WebUI and Grafana Dashboards
    </span>
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#15-show-deployment-and-logs" class="md-nav__link">
    <span class="md-ellipsis">
      1.5. Show Deployment and Logs
    </span>
  </a>
  
</li>
      
    </ul>
  
</nav>
      
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../development_guide/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    2. Development Guide
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../run_experiments/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    3. Run Experiments
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../features_and_bugs/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    4. Feature and bugs
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../supported_sbis_and_network_elements/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    5. Supported SBIs and Network Elements
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../supported_nbis/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    6. Supported NBIs
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../supported_service_handlers/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    7. Supported Service Handlers
  </span>
  

      </a>
    </li>
  

    
      
      
  
  
  
  
    <li class="md-nav__item">
      <a href="../troubleshooting/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    8. Troubleshooting
  </span>
  

      </a>
    </li>
  

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


  <h1>1. Deployment Guide</h1>

<p>This section walks you through the process of deploying TeraFlowSDN on top of a machine running <a href="https://microk8s.io">MicroK8s Kubernetes platform</a>.
The guide includes the details on configuring and installing the machine, installing and 
configuring MicroK8s, and deploying and reporting the status of the TeraFlowSDN 
controller.</p>
<h2 id="11-configure-your-machine"><strong>1.1. Configure your Machine</strong></h2>
<p>In this section, we describe how to configure a machine (physical or virtual) to be used as the deployment, execution, and development environment for the ETSI TeraFlowSDN controller. Choose your preferred environment below and follow the instructions provided.</p>
<p><strong>NOTE</strong>: If you already have a remote physical server fitting the requirements specified in this section feel free to use it instead of deploying a local VM. Check <a href="#111-physical-server">1.1.1. Physical Server</a> for further details.</p>
<p>Virtualization platforms tested are:</p>
<ul>
<li><a href="#111-physical-server">Physical Server</a></li>
<li><a href="#112-oracle-virtual-box">Oracle Virtual Box</a></li>
<li><a href="#113-vmware-fusion">VMWare Fusion</a></li>
<li><a href="#114-openstack">OpenStack</a></li>
<li><a href="#115-vagrant-box">Vagrant Box</a></li>
</ul>
<h3 id="111-physical-server"><strong>1.1.1. Physical Server</strong></h3>
<p>This section describes how to configure a physical server for running ETSI TeraFlowSDN(TFS) controller.</p>
<h3><u>Server Specifications</u></h3>

<p><strong>Minimum Server Specifications for development and basic deployment</strong></p>
<ul>
<li>CPU: 4 cores</li>
<li>RAM: 8 GB</li>
<li>Disk: 60 GB</li>
<li>1 GbE NIC</li>
</ul>
<p><strong>Recommended Server Specifications for development and basic deployment</strong></p>
<ul>
<li>CPU: 6 cores</li>
<li>RAM: 12 GB</li>
<li>Disk: 80 GB</li>
<li>1 GbE NIC</li>
</ul>
<p><strong>Server Specifications for best development and deployment experience</strong></p>
<ul>
<li>CPU: 8 cores</li>
<li>RAM: 32 GB</li>
<li>Disk: 120 GB</li>
<li>1 GbE NIC</li>
</ul>
<p><strong>NOTE</strong>: the specifications listed above are provided as a reference. They depend also on the CPU clock frequency, the RAM memory, the disk technology and speed, etc.</p>
<p>For development purposes, it is recommended to run the VSCode IDE (or the IDE of your choice) in a more powerful server, for instance, the recommended server specifications for development and basic deployment.</p>
<p>Given that TeraFlowSDN follows a micro-services architecture, for the deployment, it might be better to use many clusterized servers with many slower cores than a single server with few highly performant cores.</p>
<h3><u>Clusterized Deployment</u></h3>
<p>You might consider creating a cluster of machines each featuring, at least, the minimum server specifications. That solution brings you scalability in the future.</p>
<h3><u>Networking</u></h3>
<p>No explicit indications are given in terms of networking besides that servers need access to the Internet for downloading dependencies, binaries, and packages while building and deploying the TeraFlowSDN components.</p>
<p>Besides that, the network requirements are essentially the same than that required for running a classical Kubernetes environment. To facilitate the deployment, we extensively use <a href="https://microk8s.io/">MicroK8s</a>, thus the network requirements are, essentially, the same demanded by MicroK8s, especially, if you consider creating a Kubernetes cluster.</p>
<p>As a reference, the other deployment solutions based on VMs assume the VM is connected to a virtual network configured with the IP range <code>10.0.2.0/24</code> and have the gateway at IP <code>10.0.2.1</code>. The VMs have the IP address <code>10.0.2.10</code>.</p>
<p>The minimum required ports to be accessible are:</p>
<ul>
<li>22/SSH     : for management purposes</li>
<li>80/HTTP    : for the TeraFlowSDN WebUI and Grafana dashboard</li>
<li>8081/HTTPS : for the CockroachDB WebUI</li>
</ul>
<p>Other ports might be required if you consider to deploy addons such as Kubernetes observability, etc. The details on these ports are left appart given they might vary depending on the Kubernetes environment you use.</p>
<h3><u>Operating System</u></h3>

<p>The recommended Operating System for deploying TeraFlowSDN is <a href="https://releases.ubuntu.com/jammy/">Ubuntu Server 22.04 LTS</a> or <a href="https://releases.ubuntu.com/focal/">Ubuntu Server 20.04 LTS</a>. Other version might work, but we have not tested them. We strongly recommend using Long Term Support (LTS) versions as they provide better stability.</p>
<p>Below we provide some installation guidelines:</p>
<ul>
<li>Installation Language: English</li>
<li>Autodetect your keyboard</li>
<li>If asked, select "Ubuntu Server" (do not select "Ubuntu Server (minimized)").</li>
<li>Configure static network specifications (adapt them based on your particular setup):</li>
</ul>
<table>
<thead>
<tr>
<th>Interface</th>
<th>IPv4 Method</th>
<th>Subnet</th>
<th>Address</th>
<th>Gateway</th>
<th>Name servers</th>
<th>Search domains</th>
</tr>
</thead>
<tbody>
<tr>
<td>enp0s3</td>
<td>Manual</td>
<td>10.0.2.0/24</td>
<td>10.0.2.10</td>
<td>10.0.2.1</td>
<td>8.8.8.8,8.8.4.4</td>
<td><empty></td>
</tr>
</tbody>
</table>
<ul>
<li>Leave proxy and mirror addresses as they are</li>
<li>Let the installer self-upgrade (if asked).</li>
<li>Use an entire disk for the installation<ul>
<li>Disable setup of the disk as LVM group</li>
<li>Double check that NO swap space is allocated in the partition table. Kubernetes does not work properly with SWAP.</li>
</ul>
</li>
<li>Configure your user and system names:<ul>
<li>User name: <code>TeraFlowSDN</code></li>
<li>Server's name: <code>tfs-vm</code></li>
<li>Username: <code>tfs</code></li>
<li>Password: <code>tfs123</code></li>
</ul>
</li>
<li>Install Open SSH Server<ul>
<li>Import SSH keys, if any.</li>
</ul>
</li>
<li>Featured Server Snaps<ul>
<li>Do not install featured server snaps. It will be done manually later to illustrate how to uninstall and reinstall them in case of trouble with.</li>
</ul>
</li>
<li>Let the system install and upgrade the packages.<ul>
<li>This operation might take some minutes depending on how old is the Optical Drive ISO image you use and your Internet connection speed.</li>
</ul>
</li>
<li>Restart the VM when the installation is completed.</li>
</ul>
<h3><u>Upgrade the Ubuntu distribution</u></h3>

<pre><code class="language-bash">sudo apt-get update -y
sudo apt-get dist-upgrade -y
</code></pre>
<ul>
<li>If asked to restart services, restart the default ones proposed.</li>
<li>Restart the VM when the installation is completed.</li>
</ul>
<h3 id="112-oracle-virtual-box"><strong>1.1.2. Oracle Virtual Box</strong></h3>
<p>This section describes how to configure a VM for running ETSI TeraFlowSDN(TFS) controller using <a href="https://www.virtualbox.org/">Oracle VirtualBox</a>. It has been tested with VirtualBox up to version 6.1.40 r154048.</p>
<h3><u>Create a NAT Network in VirtualBox</u></h3>
<p>In "Oracle VM VirtualBox Manager", Menu "File &gt; Preferences... &gt; Network", create a NAT 
network with the following specifications:</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>CIDR</th>
<th>DHCP</th>
<th>IPv6</th>
</tr>
</thead>
<tbody>
<tr>
<td>TFS-NAT-Net</td>
<td>10.0.2.0/24</td>
<td>Disabled</td>
<td>Disabled</td>
</tr>
</tbody>
</table>
<p>Within the newly created "TFS-NAT-Net" NAT network, configure the following IPv4 
forwarding rules:</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Protocol</th>
<th>Host IP</th>
<th>Host Port</th>
<th>Guest IP</th>
<th>Guest Port</th>
</tr>
</thead>
<tbody>
<tr>
<td>SSH</td>
<td>TCP</td>
<td>127.0.0.1</td>
<td>2200</td>
<td>10.0.2.10</td>
<td>22</td>
</tr>
<tr>
<td>HTTP</td>
<td>TCP</td>
<td>127.0.0.1</td>
<td>8080</td>
<td>10.0.2.10</td>
<td>80</td>
</tr>
</tbody>
</table>
<p><strong>Note</strong>: IP address 10.0.2.10 is the one that will be assigned to the VM.</p>
<h3><u>Create VM in VirtualBox:</u></h3>

<ul>
<li>Name: TFS-VM</li>
<li>Type/Version: Linux / Ubuntu (64-bit)</li>
<li>CPU (*): 4 vCPUs @ 100% execution capacity</li>
<li>RAM: 8 GB</li>
<li>Disk: 60 GB, Virtual Disk Image (VDI), Dynamically allocated</li>
<li>Optical Drive ISO Image: "ubuntu-22.04.X-live-server-amd64.iso"<ul>
<li>Download the latest Long Term Support (LTS) version of the <em>Ubuntu Server</em> image from <a href="https://releases.ubuntu.com/22.04/">Ubuntu 22.04 LTS</a>, e.g., "ubuntu-22.04.X-live-server-amd64.iso".</li>
<li><strong>Note</strong>: use Ubuntu Server image instead of Ubuntu Desktop to create a lightweight VM.</li>
</ul>
</li>
<li>Network Adapter 1 (*): enabled, attached to NAT Network "TFS-NAT-Net"</li>
<li>Minor adjustments (*):<ul>
<li>Audio: disabled</li>
<li>Boot order: disable "Floppy"</li>
</ul>
</li>
</ul>
<p><strong>Note</strong>: (*) settings to be editing after the VM is created.</p>
<h3><u>Install Ubuntu 22.04 LTS Operating System</u></h3>

<p>In "Oracle VM VirtualBox Manager", start the VM in normal mode, and follow the 
installation procedure.
Below we provide some installation guidelines:</p>
<ul>
<li>Installation Language: English</li>
<li>Autodetect your keyboard</li>
<li>If asked, select "Ubuntu Server" (do not select "Ubuntu Server (minimized)").</li>
<li>Configure static network specifications:</li>
</ul>
<table>
<thead>
<tr>
<th>Interface</th>
<th>IPv4 Method</th>
<th>Subnet</th>
<th>Address</th>
<th>Gateway</th>
<th>Name servers</th>
<th>Search domains</th>
</tr>
</thead>
<tbody>
<tr>
<td>enp0s3</td>
<td>Manual</td>
<td>10.0.2.0/24</td>
<td>10.0.2.10</td>
<td>10.0.2.1</td>
<td>8.8.8.8,8.8.4.4</td>
<td><empty></td>
</tr>
</tbody>
</table>
<ul>
<li>Leave proxy and mirror addresses as they are</li>
<li>Let the installer self-upgrade (if asked).</li>
<li>Use an entire disk for the installation<ul>
<li>Disable setup of the disk as LVM group</li>
<li>Double check that NO swap space is allocated in the partition table. Kubernetes does not work properly with SWAP.</li>
</ul>
</li>
<li>Configure your user and system names:<ul>
<li>User name: TeraFlowSDN</li>
<li>Server's name: tfs-vm</li>
<li>Username: tfs</li>
<li>Password: tfs123</li>
</ul>
</li>
<li>Install Open SSH Server<ul>
<li>Import SSH keys, if any.</li>
</ul>
</li>
<li>Featured Server Snaps<ul>
<li>Do not install featured server snaps. It will be done manually later to illustrate how to uninstall and reinstall them in case of trouble with.</li>
</ul>
</li>
<li>Let the system install and upgrade the packages.<ul>
<li>This operation might take some minutes depending on how old is the Optical Drive ISO image you use and your Internet connection speed.</li>
</ul>
</li>
<li>Restart the VM when the installation is completed.</li>
</ul>
<p><strong>Upgrade the Ubuntu distribution</strong></p>
<pre><code class="language-bash">sudo apt-get update -y
sudo apt-get dist-upgrade -y
</code></pre>
<ul>
<li>If asked to restart services, restart the default ones proposed.</li>
<li>Restart the VM when the installation is completed.</li>
</ul>
<p><strong>Install VirtualBox Guest Additions</strong></p>
<p>On VirtualBox Manager, open the VM main screen. If you are running the VM in headless 
mode, right click over the VM in the VirtualBox Manager window and click "Show".
If a dialog informing about how to leave the interface of the VM is shown, confirm 
pressing "Switch" button. The interface of the VM should appear.</p>
<p>Click menu "Device &gt; Insert Guest Additions CD image..."</p>
<p>On the VM terminal, type:</p>
<pre><code class="language-bash">sudo apt-get install -y linux-headers-$(uname -r) build-essential dkms
  # This command might take some minutes depending on your VM specs and your Internet access speed.
sudo mount /dev/cdrom /mnt/
cd /mnt/
sudo ./VBoxLinuxAdditions.run
  # This command might take some minutes depending on your VM specs.
sudo reboot
</code></pre>
<h3 id="113-vmware-fusion"><strong>1.1.3. VMWare Fusion</strong></h3>
<p>This section describes how to configure a VM for running ETSI TeraFlowSDN(TFS) controller using <a href="https://www.vmware.com/products/fusion.html">VMWare Fusion</a>. It has been tested with VMWare Fusion version 12 and 13.</p>
<h3><u>Create VM in VMWare Fusion:</u></h3>

<p>In "VMWare Fusion" manager, create a new network from the "Settings/Network" menu.</p>
<ul>
<li>Unlock to make changes</li>
<li>Press the + icon and create a new network</li>
<li>Change the name to TFS-NAT-Net</li>
<li>Check "Allow virtual machines on this network to connect to external network (NAT)"</li>
<li>Do not check "Enable IPv6"</li>
<li>Add port forwarding for HTTP and SSH</li>
<li>Uncheck "Provide address on this network via DHCP"</li>
</ul>
<p>Create a new VM an Ubuntu 22.04.1 ISO:</p>
<ul>
<li>Display Name: TeraFlowSDN</li>
<li>Username: tfs</li>
<li>Password: tfs123</li>
</ul>
<p>On the next screen press "Customize Settings", save the VM and in "Settings" change:</p>
<ul>
<li>Change to use 4 CPUs</li>
<li>Change to access 8 GB of RAM</li>
<li>Change disk to size 60 GB</li>
<li>Change the network interface to use the previously created TFS-NAT-Net</li>
</ul>
<p>Run the VM to start the installation.</p>
<h3><u>Install Ubuntu 22.04.1 LTS Operating System</u></h3>

<p>The installation will be automatic, without any configuration required.</p>
<ul>
<li>
<p>Configure the guest IP, gateway and DNS:</p>
<p>Using the Network Settings for the wired connection, set the IP to 10.0.2.10,
the mask to 255.255.255.0, the gateway to 10.0.2.2 and the DNS to 10.0.2.2.</p>
</li>
<li>
<p>Disable and remove swap file:</p>
<p>$ sudo swapoff -a
$ sudo rm /swapfile</p>
<p>Then you can remove or comment the /swapfile entry in /etc/fstab</p>
</li>
<li>
<p>Install Open SSH Server</p>
<ul>
<li>Import SSH keys, if any.</li>
</ul>
</li>
<li>
<p>Restart the VM when the installation is completed.</p>
</li>
</ul>
<h3><u>Upgrade the Ubuntu distribution</u></h3>

<pre><code class="language-bash">sudo apt-get update -y
sudo apt-get dist-upgrade -y
</code></pre>
<h3 id="114-openstack"><strong>1.1.4. OpenStack</strong></h3>
<p>This section describes how to configure a VM for running ETSI TeraFlowSDN(TFS) controller using <a href="https://www.openstack.org/">OpenStack</a>. It has been tested with OpenStack Kolla up to Yoga version. </p>
<h3><u>Create a Security Group in OpenStack</h3>
<p></u>
In OpenStack, go to Project - Network - Security Groups - Create Security Group with name TFS</p>
<p>Add the following rules:</p>
<table>
<thead>
<tr>
<th>Direction</th>
<th>Ether Type</th>
<th>IP Protocol</th>
<th>Port Range</th>
<th>Remote IP Prefix</th>
</tr>
</thead>
<tbody>
<tr>
<td>Ingress</td>
<td>IPv4</td>
<td>TCP</td>
<td>22 (SSH)</td>
<td>0.0.0.0/0</td>
</tr>
<tr>
<td>Ingress</td>
<td>IPv4</td>
<td>TCP</td>
<td>2200</td>
<td>0.0.0.0/0</td>
</tr>
<tr>
<td>Ingress</td>
<td>IPv4</td>
<td>TCP</td>
<td>8080</td>
<td>0.0.0.0/0</td>
</tr>
<tr>
<td>Ingress</td>
<td>IPv4</td>
<td>TCP</td>
<td>80</td>
<td>0.0.0.0/0</td>
</tr>
<tr>
<td>Egress</td>
<td>IPv4</td>
<td>Any</td>
<td>Any</td>
<td>0.0.0.0/0</td>
</tr>
<tr>
<td>Egress</td>
<td>IPv6</td>
<td>Any</td>
<td>Any</td>
<td>::/0</td>
</tr>
</tbody>
</table>
<p><strong>Note</strong>: The IP address will be assigned depending on the network you have configured inside OpenStack. This IP will have to be modified in TeraFlow configuration files which by default use IP 10.0.2.10</p>
<h3><u>Create a flavour</h3>
<p></u></p>
<p><strong>From dashboard (Horizon)</strong></p>
<p>Go to Admin - Compute - Flavors and press Create Flavor</p>
<ul>
<li>Name: TFS</li>
<li>VCPUs: 4</li>
<li>RAM (MB): 8192</li>
<li>Root Disk (GB): 60</li>
</ul>
<p><strong>From CLI</strong></p>
<pre><code> openstack flavor create TFS --id auto --ram 8192 --disk 60 --vcpus 8
</code></pre>
<h3><u>Create an instance in OpenStack:</h3>
<p></u></p>
<ul>
<li>Instance name: TFS-VM</li>
<li>Origin: [Ubuntu-22.04 cloud image] (https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64.img)</li>
<li>Create new volume: No</li>
<li>Flavor: TFS</li>
<li>Networks: extnet </li>
<li>Security Groups: TFS</li>
<li>Configuration: Include the following cloud-config</li>
</ul>
<pre><code>#cloud-config
# Modifies the password for the VM instance
username: ubuntu
password: &lt;your-password&gt;
chpasswd: { expire: False }
Show full blame