diff --git a/doc/deployment_guide/deployment_guide.md b/doc/deployment_guide/deployment_guide.md index 671249d944fbd53fb16fa253df6e6afa3dca7cac..fd8047fb1bb063dd1161006573158e2bd276b9e3 100644 --- a/doc/deployment_guide/deployment_guide.md +++ b/doc/deployment_guide/deployment_guide.md @@ -18,7 +18,7 @@ Virtualization platforms tested are: - [Vagrant Box](#115-vagrant-box) ### **1.1.1. Physical Server** -This page describes how to configure a physical server for running ETSI TeraFlowSDN(TFS) controller. +This section describes how to configure a physical server for running ETSI TeraFlowSDN(TFS) controller. <h3><u>Server Specifications</u></h3> @@ -111,7 +111,7 @@ sudo apt-get dist-upgrade -y ### **1.1.2. Oracle Virtual Box** -This page describes how to configure a VM for running ETSI TeraFlowSDN(TFS) controller using [Oracle VirtualBox](https://www.virtualbox.org/). It has been tested with VirtualBox up to version 6.1.40 r154048. +This section describes how to configure a VM for running ETSI TeraFlowSDN(TFS) controller using [Oracle VirtualBox](https://www.virtualbox.org/). It has been tested with VirtualBox up to version 6.1.40 r154048. <h3><u>Create a NAT Network in VirtualBox</u></h3> In "Oracle VM VirtualBox Manager", Menu "File > Preferences... > Network", create a NAT @@ -209,7 +209,7 @@ 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. +This section 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. <h3><u>Create VM in VMWare Fusion:</u></h3> @@ -266,6 +266,68 @@ sudo apt-get dist-upgrade -y ### **1.1.4. OpenStack** + +This section describes how to configure a VM for running ETSI TeraFlowSDN(TFS) controller using [OpenStack](https://www.openstack.org/). It has been tested with OpenStack Kolla up to Yoga version. + +<h3><u>Create a Security Group in OpenStack</h3></u> +In OpenStack, go to Project - Network - Security Groups - Create Security Group with name TFS + +Add the following rules: + +|Direction |Ether Type |IP Protocol |Port Range | Remote IP Prefix| +|-----------|-----------|------------|-----------|-----------------| +|Ingress |IPv4 |TCP |22 (SSH) |0.0.0.0/0| +|Ingress |IPv4 |TCP |2200 |0.0.0.0/0| +|Ingress |IPv4 |TCP |8080 |0.0.0.0/0| +|Ingress |IPv4 |TCP |80 |0.0.0.0/0| +|Egress |IPv4 |Any |Any |0.0.0.0/0| +|Egress |IPv6 |Any |Any |::/0| + +__Note__: 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 + +<h3><u>Create a flavour</h3></u> + +**From dashboard (Horizon)** + +Go to Admin - Compute - Flavors and press Create Flavor + +- Name: TFS +- VCPUs: 4 +- RAM (MB): 8192 +- Root Disk (GB): 60 + +**From CLI** +``` + openstack flavor create TFS --id auto --ram 8192 --disk 60 --vcpus 8 +``` +<h3><u>Create an instance in OpenStack: + +- Instance name: TFS-VM +- Origin: [Ubuntu-22.04 cloud image] (https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64.img) +- Create new volume: No +- Flavor: TFS +- Networks: extnet +- Security Groups: TFS +- Configuration: Include the following cloud-config + +``` +#cloud-config +# Modifies the password for the VM instance +username: ubuntu +password: <your-password> +chpasswd: { expire: False } +ssh_pwauth: True +``` + + +<h3><u>Upgrade the Ubuntu distribution</h3></u> +```bash +sudo apt-get update -y +sudo apt-get dist-upgrade -y +``` +- If asked to restart services, restart the default ones proposed. +- Restart the VM when the installation is completed. + ### **1.1.5. Vagrant Box** 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, [contact](https://labs.etsi.org/rep/tfs/controller/-/wikis/home#contact) the TFS team through Slack.