diff --git a/doc/deployment_guide/deployment_guide.md b/doc/deployment_guide/deployment_guide.md index 8db3bfad65d2de358f99fbdb24aa239ca0d13c12..ae9cb949aa056121ad8adc7eee73a56536fb7781 100644 --- a/doc/deployment_guide/deployment_guide.md +++ b/doc/deployment_guide/deployment_guide.md @@ -22,19 +22,22 @@ This page describes how to configure a physical server for running ETSI TeraFlow ### Server Specifications -** Minimum Server Specifications for development and basic deployment ** +**Minimum Server Specifications for development and basic deployment** + - CPU: 4 cores - RAM: 8 GB - Disk: 60 GB - 1 GbE NIC -** Recommended Server Specifications for development and basic deployment ** +**Recommended Server Specifications for development and basic deployment** + - CPU: 6 cores - RAM: 12 GB - Disk: 80 GB - 1 GbE NIC -** Server Specifications for best development and deployment experience ** +**Server Specifications for best development and deployment experience** + - CPU: 8 cores - RAM: 32 GB - Disk: 120 GB @@ -206,6 +209,61 @@ sudo reboot ## 1.1.3. VMWare Fusion +This page describes how to configure a VM for running ETSI TeraFlowSDN(TFS) controller using [VMWare Fusion](https://www.vmware.com/products/fusion.html). It has been tested with VMWare Fusion version 12 and 13. + +### Create VM in VMWare Fusion: + +In "VMWare Fusion" manager, create a new network from the "Settings/Network" menu. + +- Unlock to make changes +- Press the + icon and create a new network +- Change the name to TFS-NAT-Net +- Check "Allow virtual machines on this network to connect to external network (NAT)" +- Do not check "Enable IPv6" +- Add port forwarding for HTTP and SSH +- Uncheck "Provide address on this network via DHCP" + +Create a new VM an Ubuntu 22.04.1 ISO: + +- Display Name: TeraFlowSDN +- Username: tfs +- Password: tfs123 + +On the next screen press "Customize Settings", save the VM and in "Settings" change: +- Change to use 4 CPUs +- Change to access 8 GB of RAM +- Change disk to size 60 GB +- Change the network interface to use the previously created TFS-NAT-Net + +Run the VM to start the installation. + +### Install Ubuntu 22.04.1 LTS Operating System + +The installation will be automatic, without any configuration required. + +- Configure the guest IP, gateway and DNS: + + 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. + +- Disable and remove swap file: + + $ sudo swapoff -a + $ sudo rm /swapfile + + Then you can remove or comment the /swapfile entry in /etc/fstab + +- Install Open SSH Server + - Import SSH keys, if any. + +- Restart the VM when the installation is completed. + +### Upgrade the Ubuntu distribution +```bash +sudo apt-get update -y +sudo apt-get dist-upgrade -y +``` + ## 1.1.4. OpenStack ## 1.1.5. Vagrant Box diff --git a/mkdocs.yml b/mkdocs.yml index a3cf43b6d8344f996d967fec4832a2f5ee02ae02..2b647462712733a1a1914988a88c8b866f298b02 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,7 +25,8 @@ theme: name: material toc: include: true - + collapse: true + # Don't include MkDocs' JavaScript #include_search_page: false #search_index_only: true @@ -42,8 +43,6 @@ theme: - navigation.path - search - search.highlight - #adding features - #- navigation.tabs - toc.integrate palette: