diff --git a/public/develop/deployment_guide/deployment_guide/index.html b/public/develop/deployment_guide/deployment_guide/index.html
index bf1ea6504612b061a84ca2cb91a941773f45ebb4..2a57a57564a04b6c6ee54619d888c932f4ab5966 100644
--- a/public/develop/deployment_guide/deployment_guide/index.html
+++ b/public/develop/deployment_guide/deployment_guide/index.html
@@ -239,8 +239,6 @@
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
-
-
<label class="md-nav__link md-nav__link--active" for="__toc">
@@ -269,8 +267,6 @@
-
-
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
@@ -279,6 +275,16 @@
<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
@@ -337,8 +343,8 @@
</nav>
</li>
-
- <li class="md-nav__item">
+
+ <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
@@ -403,8 +409,8 @@
</nav>
</li>
-
- <li class="md-nav__item">
+
+ <li class="md-nav__item">
<a href="#113-vmware-fusion" class="md-nav__link">
<span class="md-ellipsis">
1.1.3. VMWare Fusion
@@ -445,8 +451,8 @@
</nav>
</li>
-
- <li class="md-nav__item">
+
+ <li class="md-nav__item">
<a href="#114-openstack" class="md-nav__link">
<span class="md-ellipsis">
1.1.4. OpenStack
@@ -454,14 +460,55 @@
</a>
</li>
-
- <li class="md-nav__item">
+
+ <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>
@@ -632,11 +679,13 @@
+ <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>
-<h1 id="11-configure-your-machine">1.1. Configure your Machine</h1>
+<h2 id="11-configure-your-machine">1.1. Configure your Machine</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>
@@ -647,9 +696,9 @@ controller.</p>
<li><a href="#114-openstack1-1-4-openstack">OpenStack'</a></li>
<li><a href="#115-vagrant-box">Vagrant Box</a></li>
</ul>
-<h2 id="111-physical-server">1.1.1. Physical Server</h2>
+<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>
-<h3 id="server-specifications">Server Specifications</h3>
+<h4 id="server-specifications">Server Specifications</h4>
<p><strong>Minimum Server Specifications for development and basic deployment</strong></p>
<ul>
<li>CPU: 4 cores</li>
@@ -674,9 +723,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>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 id="clusterized-deployment">Clusterized Deployment</h3>
+<h4 id="clusterized-deployment">Clusterized Deployment</h4>
<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 id="networking">Networking</h3>
+<h4 id="networking">Networking</h4>
<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>
@@ -685,7 +734,7 @@ controller.</p>
- 80/HTTP : for the TeraFlowSDN WebUI and Grafana dashboard
- 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>
-<h3 id="operating-system">Operating System</h3>
+<h4 id="operating-system">Operating System</h4>
<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:
- Installation Language: English
@@ -735,7 +784,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>Restart the VM when the installation is completed.</li>
</ul>
-<h3 id="upgrade-the-ubuntu-distribution">Upgrade the Ubuntu distribution</h3>
+<h4 id="upgrade-the-ubuntu-distribution">Upgrade the Ubuntu distribution</h4>
<pre><code class="language-bash">sudo apt-get update -y
sudo apt-get dist-upgrade -y
</code></pre>
@@ -743,9 +792,9 @@ sudo apt-get dist-upgrade -y
<li>If asked to restart services, restart the default ones proposed.</li>
<li>Restart the VM when the installation is completed.</li>
</ul>
-<h2 id="112-oracle-virtual-box">1.1.2. Oracle Virtual Box</h2>
+<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>
-<h3 id="create-a-nat-network-in-virtualbox">Create a NAT Network in VirtualBox</h3>
+<h4 id="create-a-nat-network-in-virtualbox">Create a NAT Network in VirtualBox</h4>
<p>In "Oracle VM VirtualBox Manager", Menu "File > Preferences... > Network", create a NAT
network with the following specifications:</p>
<table>
@@ -799,7 +848,7 @@ forwarding rules:</p>
</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>
+<h4 id="create-vm-in-virtualbox">Create VM in VirtualBox:</h4>
<ul>
<li>Name: TFS-VM</li>
<li>Type/Version: Linux / Ubuntu (64-bit)</li>
@@ -815,7 +864,7 @@ forwarding rules:</p>
<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>
+<h4 id="install-ubuntu-2204-lts-operating-system">Install Ubuntu 22.04 LTS Operating System</h4>
<p>In "Oracle VM VirtualBox Manager", start the VM in normal mode, and follow the
installation procedure.
Below we provide some installation guidelines:
@@ -866,7 +915,7 @@ Below we provide some installation guidelines:
<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>
+<h5 id="upgrade-the-ubuntu-distribution_1">Upgrade the Ubuntu distribution</h5>
<pre><code class="language-bash">sudo apt-get update -y
sudo apt-get dist-upgrade -y
</code></pre>
@@ -874,7 +923,7 @@ sudo apt-get dist-upgrade -y
<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>
+<h5 id="install-virtualbox-guest-additions">Install VirtualBox Guest Additions</h5>
<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
@@ -889,9 +938,9 @@ 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>
+<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>
-<h3 id="create-vm-in-vmware-fusion">Create VM in VMWare Fusion:</h3>
+<h4 id="create-vm-in-vmware-fusion">Create VM in VMWare Fusion:</h4>
<p>In "VMWare Fusion" manager, create a new network from the "Settings/Network" menu.</p>
<ul>
<li>Unlock to make changes</li>
@@ -914,7 +963,7 @@ sudo reboot
- Change disk to size 60 GB
- Change the network interface to use the previously created TFS-NAT-Net</p>
<p>Run the VM to start the installation.</p>
-<h3 id="install-ubuntu-22041-lts-operating-system">Install Ubuntu 22.04.1 LTS Operating System</h3>
+<h4 id="install-ubuntu-22041-lts-operating-system">Install Ubuntu 22.04.1 LTS Operating System</h4>
<p>The installation will be automatic, without any configuration required.</p>
<ul>
<li>Configure the guest IP, gateway and DNS:</li>
@@ -936,17 +985,17 @@ sudo reboot
<p>Restart the VM when the installation is completed.</p>
</li>
</ul>
-<h3 id="upgrade-the-ubuntu-distribution_2">Upgrade the Ubuntu distribution</h3>
+<h4 id="upgrade-the-ubuntu-distribution_2">Upgrade the Ubuntu distribution</h4>
<pre><code class="language-bash">sudo apt-get update -y
sudo apt-get dist-upgrade -y
</code></pre>
-<h2 id="114-openstack">1.1.4. OpenStack</h2>
-<h2 id="115-vagrant-box">1.1.5. Vagrant Box</h2>
+<h3 id="114-openstack">1.1.4. OpenStack</h3>
+<h3 id="115-vagrant-box">1.1.5. Vagrant Box</h3>
<p>Other virtualization environments might be used; in that case, you will need to adapt these instructions to your particular case. If you want to contribute with details on how you used other hypervisors or platforms, <a href="https://labs.etsi.org/rep/tfs/controller/-/wikis/home#contact">contact</a> the TFS team through Slack.</p>
-<h1 id="12-install-microk8s">1.2. Install MicroK8s</h1>
-<h1 id="13-deploy-teraflowsdn">1.3. Deploy TeraFlowSDN</h1>
-<h1 id="14-webui-and-grafana-dashboards">1.4. WebUI and Grafana Dashboards</h1>
-<h1 id="15-show-deployment-and-logs">1.5. Show Deployment and Logs</h1>
+<h2 id="12-install-microk8s">1.2. Install MicroK8s</h2>
+<h2 id="13-deploy-teraflowsdn">1.3. Deploy TeraFlowSDN</h2>
+<h2 id="14-webui-and-grafana-dashboards">1.4. WebUI and Grafana Dashboards</h2>
+<h2 id="15-show-deployment-and-logs">1.5. Show Deployment and Logs</h2>