Deployed 87f84000 to develop in public with MkDocs 1.6.1 and mike 2.1.3

    </span>

  </a>

    <nav class="md-nav" aria-label="Server Specifications">

      <ul class="md-nav__list">

</li>

          <li class="md-nav__item">

  <a href="#minimum-server-specifications-for-development-and-basic-deployment" class="md-nav__link">

  <a href="#clusterized-deployment" class="md-nav__link">

    <span class="md-ellipsis">

      Minimum Server Specifications for development and basic deployment

      Clusterized Deployment

    </span>

  </a>

</li>

          <li class="md-nav__item">

  <a href="#recommended-server-specifications-for-development-and-basic-deployment" class="md-nav__link">

  <a href="#networking" class="md-nav__link">

    <span class="md-ellipsis">

      Recommended Server Specifications for development and basic deployment

      Networking

    </span>

  </a>

</li>

          <li class="md-nav__item">

  <a href="#server-specifications-for-best-development-and-deployment-experience" class="md-nav__link">

  <a href="#operating-system" class="md-nav__link">

    <span class="md-ellipsis">

      Server Specifications for best development and deployment experience

      Operating System

    </span>

  </a>

</li>

          <li class="md-nav__item">

  <a href="#upgrade-the-ubuntu-distribution" class="md-nav__link">

    <span class="md-ellipsis">

      Upgrade the Ubuntu distribution

    </span>

  </a>

</li>

        <li class="md-nav__item">

  <a href="#clusterized-deployment" class="md-nav__link">

  <a href="#112-oracle-virtual-box" class="md-nav__link">

    <span class="md-ellipsis">

      Clusterized Deployment

      1.1.2. Oracle Virtual Box

    </span>

  </a>

</li>

    <nav class="md-nav" aria-label="1.1.2. Oracle Virtual Box">

      <ul class="md-nav__list">

          <li class="md-nav__item">

  <a href="#networking" class="md-nav__link">

  <a href="#create-a-nat-network-in-virtualbox" class="md-nav__link">

    <span class="md-ellipsis">

      Networking

      Create a NAT Network in VirtualBox

    </span>

  </a>

</li>

          <li class="md-nav__item">

  <a href="#operating-system" class="md-nav__link">

  <a href="#create-vm-in-virtualbox" class="md-nav__link">

    <span class="md-ellipsis">

      Operating System

      Create VM in VirtualBox:

    </span>

  </a>

</li>

          <li class="md-nav__item">

  <a href="#upgrade-the-ubuntu-distribution" class="md-nav__link">

  <a href="#install-ubuntu-2204-lts-operating-system" class="md-nav__link">

    <span class="md-ellipsis">

      Upgrade the Ubuntu distribution

      Install Ubuntu 22.04 LTS Operating System

    </span>

  </a>

</li>

    <nav class="md-nav" aria-label="Install Ubuntu 22.04 LTS Operating System">

      <ul class="md-nav__list">

      </ul>

    </nav>

          <li class="md-nav__item">

  <a href="#upgrade-the-ubuntu-distribution_1" class="md-nav__link">

    <span class="md-ellipsis">

      Upgrade the Ubuntu distribution

    </span>

  </a>

</li>

          <li class="md-nav__item">

  <a href="#112-oracle-virtual-box" class="md-nav__link">

  <a href="#install-virtualbox-guest-additions" class="md-nav__link">

    <span class="md-ellipsis">

      1.1.2. Oracle Virtual Box

      Install VirtualBox Guest Additions

    </span>

  </a>

</li>

      </ul>

    </nav>

</li>

      </ul>

    </nav>

</li>

        <li class="md-nav__item">

controller.</p>

<h1 id="11-configure-your-machine">1.1. Configure your Machine</h1>

<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="#1-1-1-physical-server">1.1.1. Physical Server</a> for further details.</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="#1-1-3-vmware-fusion">VMWare Fusion</a></li>

<li><a href="#1-1-4-openstack">'1.1.4. OpenStack'</a></li>

<li><a href="#1-1-5-vagrant-box">1.1.5. Vagrant Box</a></li>

<li><a href="#1-1-4-openstack">OpenStack'</a></li>

<li><a href="#1-1-5-vagrant-box">Vagrant Box</a></li>

</ul>

<h2 id="111-physical-server">1.1.1. Physical Server</h2>

<p>This page describes how to configure a physical server for running ETSI TeraFlowSDN(TFS) controller.</p>

<h3 id="server-specifications">Server Specifications</h3>

<h4 id="minimum-server-specifications-for-development-and-basic-deployment">Minimum Server Specifications for development and basic deployment</h4>

<ul>

<li>CPU: 4 cores</li>

<li>RAM: 8 GB</li>

<li>Disk: 60 GB</li>

<li>1 GbE NIC</li>

</ul>

<h4 id="recommended-server-specifications-for-development-and-basic-deployment">Recommended Server Specifications for development and basic deployment</h4>

<ul>

<li>CPU: 6 cores</li>

<li>RAM: 12 GB</li>

<li>Disk: 80 GB</li>

<li>1 GbE NIC</li>

</ul>

<h4 id="server-specifications-for-best-development-and-deployment-experience">Server Specifications for best development and deployment experience</h4>

<ul>

<li>CPU: 8 cores</li>

<li>RAM: 32 GB</li>

<li>Disk: 120 GB</li>

<li>1 GbE NIC</li>

</ul>

<p>** Minimum Server Specifications for development and basic deployment **

- CPU: 4 cores

- RAM: 8 GB

- Disk: 60 GB

- 1 GbE NIC</p>

<p>** Recommended Server Specifications for development and basic deployment **

- CPU: 6 cores

- RAM: 12 GB

- Disk: 80 GB

- 1 GbE NIC</p>

<p>** Server Specifications for best development and deployment experience **

- CPU: 8 cores

- RAM: 32 GB

- Disk: 120 GB

- 1 GbE NIC</p>

<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>

<li>Restart the VM when the installation is completed.</li>

</ul>

<h2 id="112-oracle-virtual-box">1.1.2. Oracle Virtual Box</h2>

<p>This page 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 id="create-a-nat-network-in-virtualbox">Create a NAT Network in VirtualBox</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 id="create-vm-in-virtualbox">Create VM in VirtualBox:</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"</li>

<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>

<li>Network Adapter 1 (*): enabled, attached to NAT Network "TFS-NAT-Net"</li>

<li>Minor adjustments (*):</li>

<li>Audio: disabled</li>

<li>Boot order: disable "Floppy"</li>

</ul>

<p><strong>Note</strong>: (*) settings to be editing after the VM is created.</p>

<h3 id="install-ubuntu-2204-lts-operating-system">Install Ubuntu 22.04 LTS Operating System</h3>

<p>In "Oracle VM VirtualBox Manager", start the VM in normal mode, and follow the 

installation procedure.

Below we provide some installation guidelines:

- Installation Language: English

- Autodetect your keyboard

- If asked, select "Ubuntu Server" (do not select "Ubuntu Server (minimized)").

- Configure static network specifications:</p>

<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</li>

<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>

<li>Configure your user and system names:</li>

<li>User name: TeraFlowSDN</li>

<li>Server's name: tfs-vm</li>

<li>Username: tfs</li>

<li>Password: tfs123</li>

<li>Install Open SSH Server</li>

<li>Import SSH keys, if any.</li>

<li>Featured Server Snaps</li>

<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>

<li>Let the system install and upgrade the packages.</li>

<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>

<li>Restart the VM when the installation is completed.</li>

</ul>

<h4 id="upgrade-the-ubuntu-distribution_1">Upgrade the Ubuntu distribution</h4>

<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>

<h4 id="install-virtualbox-guest-additions">Install VirtualBox Guest Additions</h4>

<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>

<h2 id="113-vmware-fusion">1.1.3. VMWare Fusion</h2>

<h2 id="114-openstack">1.1.4. OpenStack</h2>

<h2 id="115-vagrant-box">1.1.5. Vagrant Box</h2>