Skip to content
Snippets Groups Projects
Commit 7c2f8ee6 authored by yangalicace1's avatar yangalicace1
Browse files

Deployed 20c12ea2 to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent f44c4710
No related branches found
No related tags found
No related merge requests found
...@@ -557,7 +557,7 @@ controller.</p> ...@@ -557,7 +557,7 @@ controller.</p>
</ul> </ul>
<h3 id="111-physical-server">1.1.1. Physical Server</h3> <h3 id="111-physical-server">1.1.1. Physical Server</h3>
<p>This page describes how to configure a physical server for running ETSI TeraFlowSDN(TFS) controller.</p> <p>This page describes how to configure a physical server for running ETSI TeraFlowSDN(TFS) controller.</p>
<h4><u>Server Specifications</u></h4> <h3><u>Server Specifications</u></h3>
<p><strong>Minimum Server Specifications for development and basic deployment</strong></p> <p><strong>Minimum Server Specifications for development and basic deployment</strong></p>
<ul> <ul>
...@@ -583,9 +583,9 @@ controller.</p> ...@@ -583,9 +583,9 @@ controller.</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><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>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> <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>
<h4><u>Clusterized Deployment</u></h4> <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> <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>
<h4><u>Networking</u></h4> <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>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>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>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>
...@@ -594,7 +594,7 @@ controller.</p> ...@@ -594,7 +594,7 @@ controller.</p>
- 80/HTTP : for the TeraFlowSDN WebUI and Grafana dashboard - 80/HTTP : for the TeraFlowSDN WebUI and Grafana dashboard
- 8081/HTTPS : for the CockroachDB WebUI</p> - 8081/HTTPS : for the CockroachDB WebUI</p>
<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> <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>
<h4><u>Operating System</u></h4> <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>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>Below we provide some installation guidelines:
...@@ -645,7 +645,7 @@ controller.</p> ...@@ -645,7 +645,7 @@ controller.</p>
<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>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> <li>Restart the VM when the installation is completed.</li>
</ul> </ul>
<h4><u>Upgrade the Ubuntu distribution</u></h4> <h3><u>Upgrade the Ubuntu distribution</u></h3>
<pre><code class="language-bash">sudo apt-get update -y <pre><code class="language-bash">sudo apt-get update -y
sudo apt-get dist-upgrade -y sudo apt-get dist-upgrade -y
...@@ -656,7 +656,7 @@ sudo apt-get dist-upgrade -y ...@@ -656,7 +656,7 @@ sudo apt-get dist-upgrade -y
</ul> </ul>
<h3 id="112-oracle-virtual-box">1.1.2. Oracle Virtual Box</h3> <h3 id="112-oracle-virtual-box">1.1.2. Oracle Virtual Box</h3>
<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> <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>
<h4><u>Create a NAT Network in VirtualBox</u></h4> <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 <p>In "Oracle VM VirtualBox Manager", Menu "File &gt; Preferences... &gt; Network", create a NAT
network with the following specifications:</p> network with the following specifications:</p>
<table> <table>
...@@ -710,7 +710,7 @@ forwarding rules:</p> ...@@ -710,7 +710,7 @@ forwarding rules:</p>
</tbody> </tbody>
</table> </table>
<p><strong>Note</strong>: IP address 10.0.2.10 is the one that will be assigned to the VM.</p> <p><strong>Note</strong>: IP address 10.0.2.10 is the one that will be assigned to the VM.</p>
<h4><u>Create VM in VirtualBox:</u></h4> <h3><u>Create VM in VirtualBox:</u></h3>
<ul> <ul>
<li>Name: TFS-VM</li> <li>Name: TFS-VM</li>
...@@ -727,7 +727,7 @@ forwarding rules:</p> ...@@ -727,7 +727,7 @@ forwarding rules:</p>
<li>Boot order: disable "Floppy"</li> <li>Boot order: disable "Floppy"</li>
</ul> </ul>
<p><strong>Note</strong>: (*) settings to be editing after the VM is created.</p> <p><strong>Note</strong>: (*) settings to be editing after the VM is created.</p>
<h4><u>Install Ubuntu 22.04 LTS Operating System</u></h4> <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 <p>In "Oracle VM VirtualBox Manager", start the VM in normal mode, and follow the
installation procedure. installation procedure.
Below we provide some installation guidelines: Below we provide some installation guidelines:
...@@ -803,7 +803,7 @@ sudo reboot ...@@ -803,7 +803,7 @@ sudo reboot
</code></pre> </code></pre>
<h3 id="113-vmware-fusion">1.1.3. VMWare Fusion</h3> <h3 id="113-vmware-fusion">1.1.3. VMWare Fusion</h3>
<p>This page 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> <p>This page 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>
<h4><u>Create VM in VMWare Fusion:</u></h4> <h3><u>Create VM in VMWare Fusion:</u></h3>
<p>In "VMWare Fusion" manager, create a new network from the "Settings/Network" menu.</p> <p>In "VMWare Fusion" manager, create a new network from the "Settings/Network" menu.</p>
<ul> <ul>
...@@ -827,7 +827,7 @@ sudo reboot ...@@ -827,7 +827,7 @@ sudo reboot
- Change disk to size 60 GB - Change disk to size 60 GB
- Change the network interface to use the previously created TFS-NAT-Net</p> - Change the network interface to use the previously created TFS-NAT-Net</p>
<p>Run the VM to start the installation.</p> <p>Run the VM to start the installation.</p>
<h4><u>Install Ubuntu 22.04.1 LTS Operating System</u></h4> <h3><u>Install Ubuntu 22.04.1 LTS Operating System</u></h3>
<p>The installation will be automatic, without any configuration required.</p> <p>The installation will be automatic, without any configuration required.</p>
<ul> <ul>
...@@ -850,7 +850,7 @@ sudo reboot ...@@ -850,7 +850,7 @@ sudo reboot
<p>Restart the VM when the installation is completed.</p> <p>Restart the VM when the installation is completed.</p>
</li> </li>
</ul> </ul>
<h4><u>Upgrade the Ubuntu distribution</u></h4> <h3><u>Upgrade the Ubuntu distribution</u></h3>
<pre><code class="language-bash">sudo apt-get update -y <pre><code class="language-bash">sudo apt-get update -y
sudo apt-get dist-upgrade -y sudo apt-get dist-upgrade -y
......
Source diff could not be displayed: it is too large. Options to address this: view the blob.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment