__TOC__

(THIS IS A DRAFT)

=Introduction=
OSM can manage the dataplane underlay conectivity with openflow through an external SDN network controller.

By default, when a VIM is added to OSM, it is assumed that the VIM will be in charge of this type of networks. However, when this is not the case, you can instruct OSM to take control of the underlay dataplane connectivity on behalf of the VIM, with the SDN assist capability.

OSM-RO uses a library offered by openvim for this task. Currently there are plugins for FlodLight, ONOS and OpenDayLight [[OpenVIM installation (Release TWO)#Openflow_controller]]

The required external components are:
* An external SDN controller
* A dataplane swith openflow able, that will connect the physical interfaces of the VIM compute nodes.
* The mapping between the switch ports (identified by name) and the compute node interfaces (identified by host-id and PCI address)
* Some VIMs as openstack requires admin credentials in order to be able to get the physical place of the SRIOV/passthrough VM interfaces

=Adding a SDN controller to OSM=

This is done through the RO CLI.

Enter in the RO container (lxc exec RO bash) and type

export OPENMANO_TENANT=osm # Indicate the RO tenant to use
root@RO:~# openmano sdn-controller-create mySDN --ip=192.168.15.2 --port=8080 --dpid=56:55:12:12:12:12:12:12 --user sdnuser --passwd sdnpasswd --type
onos
98113d4a-51b7-11e7-8f07-00163e1229e4 mySDN ACTIV
root@RO:~# openmano sdn-controller-list
{
"sdn_controllers": [
{
"status": "ACTIVE",
"password": "sdnpasswd",
"uuid": "98113d4a-51b7-11e7-8f07-00163e1229e4",
"last_error": null,
"dpid": "56:55:12:12:12:12:12:12",
"version": null,
"user": "sdnuser",
"ip": "192.168.15.2",
"nets_with_same_vlan": "false",
"type": "onos",
"port": 8080,
"name": "mySDN"
}
]
}

You can manage SDN controllers with sdn-controller-create/list/edit/delete
Note that at SDN creation it is not checked the connectivity and credentials

=Asociate a SDN with the VIM=
If we check the information of the datacenter we can see no informatio about the sdn in the config section:

root@RO:~# openmano datacenter-list test -vvv
datacenter:
config: null
created_at: '2017-06-02T07:55:41'
description: test
name: test
type: openstack
uuid: dfcd6ca2-4768-11e7-8f07-00163e1229e4
vim_tenants:
- config:
dataplane_physical_net: physnet_sriov
use_floating_ip: true
passwd: '******'
user: osm
vim_tenant_id: null
vim_tenant_name: osm
vim_url: http://10.0.0.12:5000/v2.0
vim_url_admin: null

In order to add the sdn controller to the datacenter:
root@RO:~# openmano datacenter-edit test --sdn-controller mySDN
Edit datacenter test (y/N)? y
dfcd6ca2-4768-11e7-8f07-00163e1229e4 test 2017-06-02T07:55:41

And now we can see this information in the datacenter:
root@RO:~# openmano datacenter-list test -vvv
datacenter:
config:
sdn-controller: 98113d4a-51b7-11e7-8f07-00163e1229e4
config: null
created_at: '2017-06-02T07:55:41'
description: test
name: test
type: openstack
uuid: dfcd6ca2-4768-11e7-8f07-00163e1229e4
vim_tenants:
- config:
dataplane_physical_net: physnet_sriov
use_floating_ip: true
passwd: '******'
user: osm
vim_tenant_id: null
vim_tenant_name: osm
vim_url: http://10.0.0.12:5000/v2.0
vim_url_admin: null

In order to remove the sdn controller:
root@RO:~# openmano datacenter-edit test --sdn-controller null
Edit datacenter test (y/N)? y
dfcd6ca2-4768-11e7-8f07-00163e1229e4 test 2017-06-02T07:55:41

=Adding a port mapping=
A sample of sdn port mapping can be found in sdn/sdn_port_mapping.yaml
root@RO:~# tail -n 24 RO/sdn/sdn_port_mapping.yaml
---
#The mapping is composed of a list of compute nodes. Each compute nodes has two elements:
#"compute_node": name to identify the compute node within the datacenter
#"ports": list of ports mapped to a switch for that compute node.
#The information to identify the SDN controller and the dataplane switch is obtained from the datacenter information
- compute_node: "compute node 1"
ports:
#Each mapped port contains the following information:
#"pci": pci address of the port in the compute node. This is a mandatory parameter
#"switch_mac": MAC address of the corresponding port in the dataplane switch.
#"switch_port": Openflow name of the port in the dataplane switch.
#"switch_mac" or "switch_port" must be specified. Both of them could be specified
- pci: "0000:81:00.0"
switch_port: "port-2/1"
- pci: "0000:81:00.1"
switch_mac: "52:54:00:94:21:22"
- compute_node: "compute node 2"
ports:
- pci: "0000:81:00.0"
switch_port: "port-2/3"
switch_mac: "52:54:00:94:22:21"
- pci: "0000:81:00.1"

In order to populate the port-mapping:
root@RO:~# openmano datacenter-sdn-port-mapping-set testRO/sdn/sdn_port_mapping.yaml
sdn_port_mapping:
- {compute_node: compute node 1, ofc_id: 963b5616-4769-11e7-8f07-00163e1229e4, pci: '0000:81:00.0',
region: dfcd6ca2-4768-11e7-8f07-00163e1229e4, switch_dpid: '00:01:64:00:6a:e6:b3:14',
switch_mac: null, switch_port: port-2/1, uuid: 977b50f8-51b9-11e7-8f07-00163e1229e4}
- {compute_node: compute node 1, ofc_id: 963b5616-4769-11e7-8f07-00163e1229e4, pci: '0000:81:00.1',
region: dfcd6ca2-4768-11e7-8f07-00163e1229e4, switch_dpid: '00:01:64:00:6a:e6:b3:14',
switch_mac: '52:54:00:94:21:22', switch_port: null, uuid: 977b50f9-51b9-11e7-8f07-00163e1229e4}
- {compute_node: compute node 2, ofc_id: 963b5616-4769-11e7-8f07-00163e1229e4, pci: '0000:81:00.0',
region: dfcd6ca2-4768-11e7-8f07-00163e1229e4, switch_dpid: '00:01:64:00:6a:e6:b3:14',
switch_mac: '52:54:00:94:22:21', switch_port: port-2/3, uuid: 977b50fa-51b9-11e7-8f07-00163e1229e4}
- {compute_node: compute node 2, ofc_id: 963b5616-4769-11e7-8f07-00163e1229e4, pci: '0000:81:00.1',
region: dfcd6ca2-4768-11e7-8f07-00163e1229e4, switch_dpid: '00:01:64:00:6a:e6:b3:14',
switch_mac: '52:54:00:94:22:22', switch_port: port-2/4, uuid: 977b50fb-51b9-11e7-8f07-00163e1229e4}

To overwrite the port mapping the same instruction can be used.

To clear the port mapping:
root@RO:~# openmano datacenter-sdn-port-mapping-clear test
Clean SDN port mapping for datacenter dfcd6ca2-4768-11e7-8f07-00163e1229e4 (y/N)? y
{result: 4 deleted from of_port_mapping}

=Managing dataplane networks with external conectivity=
TBC

=Additional information=
TBC
[[Create a new SDN plugin]]

EPA and SDN assist

2017-06-15T10:49:14Z

Montesmoreno: /* Asociate a SDN with the VIM */

EPA and SDN assist

2017-06-15T10:46:09Z

Montesmoreno: /* Adding a SDN controller to OSM */

Openstack configuration (Release ONE)

2017-01-27T09:15:29Z

Montesmoreno: /* Add openstack at OSM */

=Configure openstack for OSM (basic)=

'''1. Guarantee that Openstack API endpoints are reachable from OSM (particularly from RO container)'''

'''2. Create a management network, with DHCP enabled, reachable from OSM (particularly from VCA container)'''

You need to create a management network, with DHCP enabled, and guarantee that this management network is reachable from OSM. The network is used by the VCA (Juju) for configuring the VNFs once they are running. It is recommended to create a provider network, isolated from Openstack. For instance, in order to create a provider network using physical interface em1 and VLAN 500 and with CIDR 10.208.0.0/24, you should run the following commands:
neutron net-create mgmt --provider:network_type=vlan --provider:physical_network=physnet_em1 --provider:segmentation_id=500 --shared
neutron subnet-create --name subnet-mgmt mgmt 10.208.0.0/24 --allocation-pool start=10.208.0.2,end=10.208.0.254

'''3. Create a valid tenant/user'''

You need to create a tenant/user with rights to create/delete flavors. The easiest way is to create a user and assign it the role "admin". Another option is to change the general flavor management policies at file ''/etc/nova/policy.json'' to allow flavor creation per user.

'''4. Upload images'''

OSM will create the needed images into openstack at deployment time, but the process takes a long time and the provided path at VNFD must be accesible by OSM. For this reason, it is recommended to upload the images of the VNFs manually at openstack, using the following command:

openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 --public --property location="/mnt/powervault/virtualization/osm/CirrOS/cirros-0.3.4-x86_64-disk.img" cirros034

'''5. Modify default security group or create a new one'''

By default openstack apply the "default" security group that blocks any incoming traffic to the VM. However ssh access is needed by VCA. You must modify the default security group to allow TCP port 22 or; create a new security group and configure RO to use this security group when datacenter is addeed (see [[Openstack_configuration_(Release_ONE)#Add openstack at OSM]] )

=Configure openstack for OSM (EPA)=

Besides the instructions above for any Openstack, you should do extra configuration to configure openstack for running VNFs which use SRIOV interfaces.

'''1. Provide a mechanism to connect the SR-IOV interfaces'''. As they are physical ports connected to an external switch, Neutron will not be able to connect them. You can use a physical switch programmed to interconnect the vlan tags among them (not recommened for security reasons). Another solution is to use a ML2 plugin that programs the external switch.

'''2. Configure the Neutron controller for using SR-IOV ports'''
Edit /etc/neutron/plugins/ml2/ml2_conf.ini with the tag and vlan ranges used by the dataplane network

[ml2_type_vlan]
network_vlan_ranges = physnet_sriov:3000:3100

'''3. Configure the compute nodes for using SR-IOV'''

On each compute node you have to associate the VFs available to each physical network. That is performed by configuring pci_passthrough_whitelist in /etc/nova/nova.conf. So, for example:

pci_passthrough_whitelist = {"vendor_id":"8086", "product_id":"10ed","physical_network":"physnet_sriov"}

=Add openstack at OSM=

There is a parameter called '''--config''' used to suply general guidelines both at datacenter creation and datacenter association to openmano tenant (this later precedes)
openmano datacenter-create openstack-site http://10.10.10.11:5000/v2.0 --type openstack --description "OpenStack site" --config='{security_groups: default, keypair: mykey}'
openmano datacenter-attach openstack-site --user=admin --password=userpwd --vim-tenant-name=admin --config='{availability_zone: one}'

The following configuration can be added:

* '''security_groups''': To be used for the deployment
* '''availability_zone''': To be used for the deployment
* '''keypair''': To be added in addition to the keypair allocated on the VNF descriptor. Provide the name of a openstack keypair
* '''dataplane_physical_net''': The configured network_vlan_ranges at neutron for SRIOV networks, e.g. 'physnet_sriov' in the above configuration
* '''region_name''': The region where the VM must be deployed.
* '''use_floating_ip''': (By default false). When true a management interface of a VM is automatically asigned a floating_ip (if possible) regardless of the descriptor content
* '''insecure''': (By default false). When true it allows authorization over a non trusted certificate over https

In case more than one configuration must be applied it can be done using commas:
--config='{use_floating_ip: True, availability_zone: controller}'

Openstack configuration (Release ONE)

2017-01-12T13:26:31Z

Montesmoreno: /* Add openstack at OSM */

=Configure openstack for OSM (basic)=

'''1. Guarantee that Openstack API endpoints are reachable from OSM (particularly from RO container)'''

'''2. Create a management network, with DHCP enabled, reachable from OSM (particularly from VCA container)'''

You need to create a management network, with DHCP enabled, and guarantee that this management network is reachable from OSM. The network is used by the VCA (Juju) for configuring the VNFs once they are running. It is recommended to create a provider network, isolated from Openstack. For instance, in order to create a provider network using physical interface em1 and VLAN 500 and with CIDR 10.208.0.0/24, you should run the following commands:
neutron net-create mgmt --provider:network_type=vlan --provider:physical_network=physnet_em1 --provider:segmentation_id=500 --shared
neutron subnet-create --name subnet-mgmt mgmt 10.208.0.0/24 --allocation-pool start=10.208.0.2,end=10.208.0.254

'''3. Create a valid tenant/user'''

You need to create a tenant/user with rights to create/delete flavors. The easiest way is to create a user and assign it the role "admin". Another option is to change the general flavor management policies at file ''/etc/nova/policy.json'' to allow flavor creation per user.

'''4. Upload images'''

OSM will create the needed images into openstack at deployment time, but the process takes a long time and the provided path at VNFD must be accesible by OSM. For this reason, it is recommended to upload the images of the VNFs manually at openstack, using the following command:

openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 --public --property location="/mnt/powervault/virtualization/osm/CirrOS/cirros-0.3.4-x86_64-disk.img" cirros034

'''5. Modify default security group or create a new one'''

By default openstack apply the "default" security group that blocks any incoming traffic to the VM. However ssh access is needed by VCA. You must modify the default security group to allow TCP port 22 or; create a new security group and configure RO to use this security group when datacenter is addeed (see [[Openstack_configuration_(Release_ONE)#Add openstack at OSM]] )

=Configure openstack for OSM (EPA)=

Besides the instructions above for any Openstack, you should do extra configuration to configure openstack for running VNFs which use SRIOV interfaces.

'''1. Provide a mechanism to connect the SR-IOV interfaces'''. As they are physical ports connected to an external switch, Neutron will not be able to connect them. You can use a physical switch programmed to interconnect the vlan tags among them (not recommened for security reasons). Another solution is to use a ML2 plugin that programs the external switch.

'''2. Configure the Neutron controller for using SR-IOV ports'''
Edit /etc/neutron/plugins/ml2/ml2_conf.ini with the tag and vlan ranges used by the dataplane network

[ml2_type_vlan]
network_vlan_ranges = physnet_sriov:3000:3100

'''3. Configure the compute nodes for using SR-IOV'''

On each compute node you have to associate the VFs available to each physical network. That is performed by configuring pci_passthrough_whitelist in /etc/nova/nova.conf. So, for example:

pci_passthrough_whitelist = {"vendor_id":"8086", "product_id":"10ed","physical_network":"physnet_sriov"}

=Add openstack at OSM=

There is a parameter called '''--config''' used to suply general guidelines both at datacenter creation and datacenter association to openmano tenant (this later precedes)
openmano datacenter-create openstack-site http://10.10.10.11:5000/v2.0 --type openstack --description "OpenStack site" --config='{security_groups: default, keypair: mykey}'
openmano datacenter-attach openstack-site --user=admin --password=userpwd --vim-tenant-name=admin --config='{availability_zone: one}'

The following configuration can be added:

* security_groups: to be used for the deployment
* availability_zone: to be used for the deployment
* keypair: to be added in addition to the keypair allocated on the VNF descriptor. Provide the name of a openstack keypair
* dataplane_physical_net: The configured network_vlan_ranges at neutron for SRIOV networks, e.g. 'physnet_sriov' in the above configurition
* region_name: The region where the VM must be deployed.

OSM Release ONE

2016-11-21T16:45:26Z

Montesmoreno:

OpenVIM installation (Release One)

2016-11-03T09:20:08Z

Montesmoreno: /* DHCP server */

__TOC__

=Infrastructure=
In order to run openvim in normal mode (see bellow the available modes) and deploy dataplane VNFs, an appropriate infrastructure is required. Below a reference architecture for an openvim-based DC deployment.

[[File:OpenvimDC.png|500px|Openvim Datacenter infrastructure]]

Openvim needs to be accesible from Resource Orchestrator (openmano).
Openvim needs:
* To make its API accesible from Resource Orchestrator (openmano). That's the purpose of the VIM mgmt network in the figure.
* To be connected to all compute servers through a network, the DC infrastructure network in the figure.
* To offer management IP addresses to VNFs for VNF configuration from CM (Juju server). That's the purpose of the Telco/VNF management network.

Compute nodes, besides being connected to the DC infrastructure network, must also be connected to two additional networks:
*Telco/VNF management network, used by Configuration Manager (Juju Server) to configure the VNFs
*Inter-DC network, optionally required to interconnect this datacenter to other datacenters (e.g. in MWC'16 demo, to interconnect the two sites).

VMs will be connected to these two networks at deployment time if requested by openmano.

=VM creation (openvim server)=
* Requirements:
** 1 vCPU (2 recommended)
** 4 GB RAM (4 GB are required to run OpenDaylight controller; if the ODL controller runs outside the VM, 2 GB RAM are enough)
** 40 GB disk
** 3 network interfaces to:
*** OSM network (to interact with RO)
*** DC intfrastructure network (to interact with the compute servers and switches)
*** Telco/VNF management network (to provide IP addresses via DHCP to the VNFs)
*Base image: ubuntu-16.04-server-amd64

=Installation=
Openvim is installed using a script
wget -O install-openvim.sh "https://osm.etsi.org/gitweb/?p=osm/openvim.git;a=blob_plain;f=scripts/install-openvim.sh"
chmod +x install-openvim.sh
sudo ./install-openvim.sh [-u <database-admin-user>] [-p <database-admin-password>]
#NOTE: you can provide optionally the admin user (normally 'root') and password of the database.

On Ubuntu 16.04 it will install openvim as a service on /opt/openvim

== Openflow controller==
For normal or OF only openvim modes you will need a openflow controller. You can install e.g. floodlight-0.90. The script '''openvim/scripts/install-floodlight.sh''' makes this steps for you. And the script '''service-floodlight''' can be used to start/stop it in a screen with logs.

== DHCP server==

For the management network a DHCP server is needed. Install the package dhcp3-server. This package will install the actual DHCP server based on isc-dhcp-server package.

Ubuntu 14.04: sudo apt-get install dhcp3-server
Ubuntu 16.04: sudo apt install isc-dhcp-server

Configure it editing file '''/etc/default/isc-dhcp-server''' to enable DHCP server in the appropriate interface, the one attached to Telco/VNF management network (e.g. eth1).

$ sudo vi /etc/default/isc-dhcp-server
INTERFACES="eth1"

Edit file '''/etc/dhcp/dhcpd.conf''' to specify the subnet, netmask and range of IP addresses to be offered by the server.

$ sudo vi /etc/dhcp/dhcpd.conf
ddns-update-style none;
default-lease-time 86400;
max-lease-time 86400;
log-facility local7;
option subnet-mask 255.255.0.0;
option broadcast-address 10.210.255.255;
subnet 10.210.0.0 netmask 255.255.0.0 {
range 10.210.1.2 10.210.1.254;
}

Restart the service:

sudo service isc-dhcp-server restart

=Configuration=

- Go to openvim folder ('''/opt/openvim''') and edit openvimd.cfg. Note: by default it runs in mode: '''test''' where no real hosts neither openflow controller are needed. You can uses other modes:

{| class="wikitable"
|-
! mode
! Computes hosts
! Openflow controller
! Observations
|-
| test
| fake
| X
| No real deployment. Just for API test
|-
| normal
| needed
| needed
| Normal behaviour
|-
| host only
| needed
| X
| No PT/SRIOV connections
|-
| develop
| needed
| X
| Force to cloud type deployment without EPA
|-
| OF only
| fake
| needed
| To test openflow controller without needed of compute hosts
|}

Service must be restarted
sudo service openvim restart

NOTE: the following steps (ONLY if openvim runs in test mode) are done automatically by script:
/opt/openvim/scripts/initopenvim.sh --insert-bashrc --force

- Let's configure the openvim CLI client. Needed if you have changed the /opt/openvim/openvimd.cfg file (WARNING not the ./openvim/openvimd.cfg)

openvim config # show openvim related variables
#To change variables run
export OPENVIM_HOST=<http_host of openvimd.cfg>
export OPENVIM_PORT=<http_port of openvimd.cfg>
export OPENVIM_ADMIN_PORT=<http_admin_port of openvimd.cfg>
#You can insert at .bashrc for authomatic loading at login:
echo "export OPENVIM_HOST=<...>" >> /{HOME}/.bashrc
...

==Adding compute nodes==
- Let's attach compute nodes

In '''test''' mode we need to provide fake compute nodes with all the necessary information:

openvim host-add /opt/openvim/test/hosts/host-example0.yaml
openvim host-add /opt/openvim/test/hosts/host-example1.yaml
openvim host-add /opt/openvim/test/hosts/host-example2.yaml
openvim host-add /opt/openvim/test/hosts/host-example3.yaml
openvim host-list #-v,-vv,-vvv for verbosity levels

In '''normal''' or '''host only''' mode, the process is a bit more complex. First, you need to configure appropriately the host following these [[guidelines|Compute node configuration]]. The current process is manual, although we are working on an automated process. For the moment, follow these instructions:

#copy /opt/openvim/scripts/host-add.sh and run at compute host for gather all the information
./host_add.sh <user> <ip_name> >> host.yaml

#NOTE: If the host contains interfaces connected to the openflow switch for dataplane,
# the switch port where the interfaces are connected must be provided manually,
# otherwise these interfaces cannot be used. Follow one of two methods:
# 1) Fill openvim/database_utils/of_ports_pci_correspondence.sql ...
# ... and load with mysql -uvim -p vim_db < openvim/database_utils/of_ports_pci_correspondence.sql
# 2) or add manually this information at generated host.yaml with a 'switch_port: <whatever>'
# ... entry at 'host-data':'numas': 'interfaces'

# copy this generated file host.yaml to the openvim server, and add the compute host with the command:
openvim host-add host.yaml

# copy openvim ssh key to the compute node. If openvim user didn't have a ssh key generate it using ssh-keygen
ssh-copy-id <compute node user>@<IP address of the compute node>

'''Note''': It must be noted that Openvim has been tested with servers based on Xeon E5 Intel processors with Ivy Bridge architecture. No tests have been carried out with Intel Core i3, i5 and i7 families, so there are no guarantees that the integration will be seamless.

==Adding external networks==

- Let's list the external networks:

openvim net-list

- Let's create some external networks in openvim. These networks are public and can be used by any VNF. It must be noticed that these networks must be pre-provisioned in the compute nodes in order to be effectively used by the VNFs. The pre-provision will be skipped since we are in test mode. Four networks will be created:
* ''default'' -> default NAT network provided by libvirt. By creating this network, VMs will be able to connect to default network in the same host where they are deployed.
* ''macvtap:em1'' -> macvtap network associated to interface "em1". By creating this network, we allow VMs to connect to a macvtap interface of physical interface "em1" in the same host where they are deployed. If the interface naming scheme is different, use the appropriate name instead of "em1".
* ''bridge_net'' -> bridged network intended for VM-to-VM communication. The pre-provision of a Linux bridge in all compute nodes is described in [[Compute node configuration#pre-provision-of-linux-bridges]]. By creating this network, VMs will be able to connect to the Linux bridge "virbrMan1" in the same host where they are deployed. In that way, two VMs connected to "virbrMan1", no matter the host, will be able to talk each other.
* ''data_net'' -> external data network intended for VM-to-VM communication. By creating this network, VMs will be able to connect to a network element connected behind a physical port in the external switch.

In order to create external networks, use 'openvim net-create', specifying a file with the network information. Now we will create the 4 networks:

openvim net-create /opt/openvim/test/networks/net-example0.yaml
openvim net-create /opt/openvim/test/networks/net-example1.yaml
openvim net-create /opt/openvim/test/networks/net-example2.yaml
openvim net-create /opt/openvim/test/networks/net-example3.yaml

- Let's list the external networks:

openvim net-list
2c386a58-e2b5-11e4-a3c9-52540032c4fa data_net
35671f9e-e2b4-11e4-a3c9-52540032c4fa default
79769aa2-e2b4-11e4-a3c9-52540032c4fa macvtap:em1
8f597eb6-e2b4-11e4-a3c9-52540032c4fa bridge_net

You can build your own networks using the template 'templates/network.yaml'. Alternatively, you can use 'openvim net-create' without a file and answer the questions:

openvim net-create

You can delete a network, e.g. "macvtap:em1", using the command:

openvim net-delete macvtap:em1

==Creating a new tenant==
- Now let's create a new tenant "admin":

$ openvim tenant-create --name admin --description admin
<uuid> admin Created

- Take the uuid of the tenant and update the environment variables used by openvim client:

export OPENVIM_TENANT=<obtained uuid>
#echo "export OPENVIM_TENANT=<obtained uuid>" >> /home/${USER}/.bashrc
openvim config #show openvim env variables

OpenVIM installation (Release One)

2016-10-28T12:29:16Z

Montesmoreno: /* Configuration */

__TOC__

=Infrastructure=
In order to run openvim in normal mode (see bellow the available modes) and deploy dataplane VNFs, an appropriate infrastructure is required. Below a reference architecture for an openvim-based DC deployment.

[[File:OpenvimDC.png|500px|Openvim Datacenter infrastructure]]

Openvim needs to be accesible from Resource Orchestrator (openmano).
Openvim needs:
* To make its API accesible from Resource Orchestrator (openmano). That's the purpose of the VIM mgmt network in the figure.
* To be connected to all compute servers through a network, the DC infrastructure network in the figure.
* To offer management IP addresses to VNFs for VNF configuration from CM (Juju server). That's the purpose of the Telco/VNF management network.

Compute nodes, besides being connected to the DC infrastructure network, must also be connected to two additional networks:
*Telco/VNF management network, used by Configuration Manager (Juju Server) to configure the VNFs
*Inter-DC network, optionally required to interconnect this datacenter to other datacenters (e.g. in MWC'16 demo, to interconnect the two sites).

VMs will be connected to these two networks at deployment time if requested by openmano.

=VM creation (openvim server)=
* Requirements:
** 1 vCPU (2 recommended)
** 4 GB RAM (4 GB are required to run OpenDaylight controller; if the ODL controller runs outside the VM, 2 GB RAM are enough)
** 40 GB disk
** 3 network interfaces to:
*** OSM network (to interact with RO)
*** DC intfrastructure network (to interact with the compute servers and switches)
*** Telco/VNF management network (to provide IP addresses via DHCP to the VNFs)
*Base image: ubuntu-16.04-server-amd64

=Installation=
Openvim is installed using a script
wget -O install-openvim.sh "https://osm.etsi.org/gitweb/?p=osm/openvim.git;a=blob_plain;f=scripts/install-openvim.sh"
chmod +x install-openvim.sh
sudo ./install-openvim.sh [-u <database-admin-user>] [-p <database-admin-password>]
#NOTE: you can provide optionally the admin user (normally 'root') and password of the database.

On Ubuntu 16.04 it will install openvim as a service on /opt/openvim

== Openflow controller==
For normal or OF only openvim modes you will need a openflow controller. You can install e.g. floodlight-0.90. The script '''openvim/scripts/install-floodlight.sh''' makes this steps for you. And the script '''service-floodlight''' can be used to start/stop it in a screen with logs.

== DHCP server==

For the management network a DHCP server is needed. Install the package dhcp3-server. This package will install the actual DHCP server based on isc-dhcp-server package.

sudo install dhcp3-server

Configure it editing file '''/etc/default/isc-dhcp-server''' to enable DHCP server in the appropriate interface, the one attached to Telco/VNF management network (e.g. eth1).

$ sudo vi /etc/default/isc-dhcp-server
INTERFACES="eth1"

Edit file '''/etc/dhcp/dhcpd.conf''' to specify the subnet, netmask and range of IP addresses to be offered by the server.

$ sudo vi /etc/dhcp/dhcpd.conf
ddns-update-style none;
default-lease-time 86400;
max-lease-time 86400;
log-facility local7;
option subnet-mask 255.255.0.0;
option broadcast-address 10.210.255.255;
subnet 10.210.0.0 netmask 255.255.0.0 {
range 10.210.1.2 10.210.1.254;
}

Restart the service:

sudo service isc-dhcp-server restart

=Configuration=

- Go to openvim folder ('''/opt/openvim''') and edit openvimd.cfg. Note: by default it runs in mode: '''test''' where no real hosts neither openflow controller are needed. You can uses other modes:

{| class="wikitable"
|-
! mode
! Computes hosts
! Openflow controller
! Observations
|-
| test
| fake
| X
| No real deployment. Just for API test
|-
| normal
| needed
| needed
| Normal behaviour
|-
| host only
| needed
| X
| No PT/SRIOV connections
|-
| develop
| needed
| X
| Force to cloud type deployment without EPA
|-
| OF only
| fake
| needed
| To test openflow controller without needed of compute hosts
|}

Service must be restarted
sudo service openvim restart

NOTE: the following steps (ONLY if openvim runs in test mode) are done automatically by script:
/opt/openvim/scripts/initopenvim.sh --insert-bashrc --force

- Let's configure the openvim CLI client. Needed if you have changed the /opt/openvim/openvimd.cfg file (WARNING not the ./openvim/openvimd.cfg)

openvim config # show openvim related variables
#To change variables run
export OPENVIM_HOST=<http_host of openvimd.cfg>
export OPENVIM_PORT=<http_port of openvimd.cfg>
export OPENVIM_ADMIN_PORT=<http_admin_port of openvimd.cfg>
#You can insert at .bashrc for authomatic loading at login:
echo "export OPENVIM_HOST=<...>" >> /{HOME}/.bashrc
...

==Adding compute nodes==
- Let's attach compute nodes

In '''test''' mode we need to provide fake compute nodes with all the necessary information:

openvim host-add /opt/openvim/test/hosts/host-example0.yaml
openvim host-add /opt/openvim/test/hosts/host-example1.yaml
openvim host-add /opt/openvim/test/hosts/host-example2.yaml
openvim host-add /opt/openvim/test/hosts/host-example3.yaml
openvim host-list #-v,-vv,-vvv for verbosity levels

In '''normal''' or '''host only''' mode, the process is a bit more complex. First, you need to configure appropriately the host following these [[guidelines|Compute node configuration]]. The current process is manual, although we are working on an automated process. For the moment, follow these instructions:

#copy /opt/openvim/scripts/host-add.sh and run at compute host for gather all the information
./host_add.sh <user> <ip_name> >> host.yaml

#NOTE: If the host contains interfaces connected to the openflow switch for dataplane,
# the switch port where the interfaces are connected must be provided manually,
# otherwise these interfaces cannot be used. Follow one of two methods:
# 1) Fill openvim/database_utils/of_ports_pci_correspondence.sql ...
# ... and load with mysql -uvim -p vim_db < openvim/database_utils/of_ports_pci_correspondence.sql
# 2) or add manually this information at generated host.yaml with a 'switch_port: <whatever>'
# ... entry at 'host-data':'numas': 'interfaces'

# copy this generated file host.yaml to the openvim server, and add the compute host with the command:
openvim host-add host.yaml

# copy openvim ssh key to the compute node. If openvim user didn't have a ssh key generate it using ssh-keygen
ssh-copy-id <compute node user>@<IP address of the compute node>

'''Note''': It must be noted that Openvim has been tested with servers based on Xeon E5 Intel processors with Ivy Bridge architecture. No tests have been carried out with Intel Core i3, i5 and i7 families, so there are no guarantees that the integration will be seamless.

==Adding external networks==

- Let's list the external networks:

openvim net-list

- Let's create some external networks in openvim. These networks are public and can be used by any VNF. It must be noticed that these networks must be pre-provisioned in the compute nodes in order to be effectively used by the VNFs. The pre-provision will be skipped since we are in test mode. Four networks will be created:
* ''default'' -> default NAT network provided by libvirt. By creating this network, VMs will be able to connect to default network in the same host where they are deployed.
* ''macvtap:em1'' -> macvtap network associated to interface "em1". By creating this network, we allow VMs to connect to a macvtap interface of physical interface "em1" in the same host where they are deployed. If the interface naming scheme is different, use the appropriate name instead of "em1".
* ''bridge_net'' -> bridged network intended for VM-to-VM communication. The pre-provision of a Linux bridge in all compute nodes is described in [[Compute node configuration#pre-provision-of-linux-bridges]]. By creating this network, VMs will be able to connect to the Linux bridge "virbrMan1" in the same host where they are deployed. In that way, two VMs connected to "virbrMan1", no matter the host, will be able to talk each other.
* ''data_net'' -> external data network intended for VM-to-VM communication. By creating this network, VMs will be able to connect to a network element connected behind a physical port in the external switch.

In order to create external networks, use 'openvim net-create', specifying a file with the network information. Now we will create the 4 networks:

openvim net-create /opt/openvim/test/networks/net-example0.yaml
openvim net-create /opt/openvim/test/networks/net-example1.yaml
openvim net-create /opt/openvim/test/networks/net-example2.yaml
openvim net-create /opt/openvim/test/networks/net-example3.yaml

- Let's list the external networks:

openvim net-list
2c386a58-e2b5-11e4-a3c9-52540032c4fa data_net
35671f9e-e2b4-11e4-a3c9-52540032c4fa default
79769aa2-e2b4-11e4-a3c9-52540032c4fa macvtap:em1
8f597eb6-e2b4-11e4-a3c9-52540032c4fa bridge_net

You can build your own networks using the template 'templates/network.yaml'. Alternatively, you can use 'openvim net-create' without a file and answer the questions:

openvim net-create

You can delete a network, e.g. "macvtap:em1", using the command:

openvim net-delete macvtap:em1

==Creating a new tenant==
- Now let's create a new tenant "admin":

$ openvim tenant-create --name admin --description admin
<uuid> admin Created

- Take the uuid of the tenant and update the environment variables used by openvim client:

export OPENVIM_TENANT=<obtained uuid>
#echo "export OPENVIM_TENANT=<obtained uuid>" >> /home/${USER}/.bashrc
openvim config #show openvim env variables

OpenVIM installation (Release One)

2016-10-28T12:01:10Z

Montesmoreno: /* Adding external networks */

__TOC__

=Infrastructure=
In order to run openvim in normal mode (see bellow the available modes) and deploy dataplane VNFs, an appropriate infrastructure is required. Below a reference architecture for an openvim-based DC deployment.

[[File:OpenvimDC.png|500px|Openvim Datacenter infrastructure]]

Openvim needs to be accesible from Resource Orchestrator (openmano).
Openvim needs:
* To make its API accesible from Resource Orchestrator (openmano). That's the purpose of the VIM mgmt network in the figure.
* To be connected to all compute servers through a network, the DC infrastructure network in the figure.
* To offer management IP addresses to VNFs for VNF configuration from CM (Juju server). That's the purpose of the Telco/VNF management network.

Compute nodes, besides being connected to the DC infrastructure network, must also be connected to two additional networks:
*Telco/VNF management network, used by Configuration Manager (Juju Server) to configure the VNFs
*Inter-DC network, optionally required to interconnect this datacenter to other datacenters (e.g. in MWC'16 demo, to interconnect the two sites).

VMs will be connected to these two networks at deployment time if requested by openmano.

=VM creation (openvim server)=
* Requirements:
** 1 vCPU (2 recommended)
** 4 GB RAM (4 GB are required to run OpenDaylight controller; if the ODL controller runs outside the VM, 2 GB RAM are enough)
** 40 GB disk
** 3 network interfaces to:
*** OSM network (to interact with RO)
*** DC intfrastructure network (to interact with the compute servers and switches)
*** Telco/VNF management network (to provide IP addresses via DHCP to the VNFs)
*Base image: ubuntu-16.04-server-amd64

=Installation=
Openvim is installed using a script
wget -O install-openvim.sh "https://osm.etsi.org/gitweb/?p=osm/openvim.git;a=blob_plain;f=scripts/install-openvim.sh"
chmod +x install-openvim.sh
sudo ./install-openvim.sh [-u <database-admin-user>] [-p <database-admin-password>]
#NOTE: you can provide optionally the admin user (normally 'root') and password of the database.

On Ubuntu 16.04 it will install openvim as a service on /opt/openvim

== Openflow controller==
For normal or OF only openvim modes you will need a openflow controller. You can install e.g. floodlight-0.90. The script '''openvim/scripts/install-floodlight.sh''' makes this steps for you. And the script '''service-floodlight''' can be used to start/stop it in a screen with logs.

== DHCP server==

For the management network a DHCP server is needed. Install the package dhcp3-server. This package will install the actual DHCP server based on isc-dhcp-server package.

sudo install dhcp3-server

Configure it editing file '''/etc/default/isc-dhcp-server''' to enable DHCP server in the appropriate interface, the one attached to Telco/VNF management network (e.g. eth1).

$ sudo vi /etc/default/isc-dhcp-server
INTERFACES="eth1"

Edit file '''/etc/dhcp/dhcpd.conf''' to specify the subnet, netmask and range of IP addresses to be offered by the server.

$ sudo vi /etc/dhcp/dhcpd.conf
ddns-update-style none;
default-lease-time 86400;
max-lease-time 86400;
log-facility local7;
option subnet-mask 255.255.0.0;
option broadcast-address 10.210.255.255;
subnet 10.210.0.0 netmask 255.255.0.0 {
range 10.210.1.2 10.210.1.254;
}

Restart the service:

sudo service isc-dhcp-server restart

=Configuration=

- Go to openvim folder ('''/opt/openvim''') and edit openvimd.cfg. Note: by default it runs in mode: '''test''' where no real hosts neither openflow controller are needed. You can uses other modes:

{| class="wikitable"
|-
! mode
! Computes hosts
! Openflow controller
! Observations
|-
| test
| fake
| X
| No real deployment. Just for API test
|-
| normal
| needed
| needed
| Normal behaviour
|-
| host only
| needed
| X
| No PT/SRIOV connections
|-
| develop
| needed
| X
| Force to cloud type deployment without EPA
|-
| OF only
| fake
| needed
| To test openflow controller without needed of compute hosts
|}

Service must be restarted
sudo service openvim restart

NOTE: the following steps (ONLY if openvim runs in test mode) are done automatically by script:
./openvim/scripts/initopenvim.sh --insert-bashrc --force

- Let's configure the openvim CLI client. Needed if you have changed the openvimd.cfg file

openvim config # show openvim related variables
#To change variables run
export OPENVIM_HOST=<http_host of openvimd.cfg>
export OPENVIM_PORT=<http_port of openvimd.cfg>
export OPENVIM_ADMIN_PORT=<http_admin_port of openvimd.cfg>
#You can insert at .bashrc for authomatic loading at login:
echo "export OPENVIM_HOST=<...>" >> /{HOME}/.bashrc
...

==Adding compute nodes==
- Let's attach compute nodes

In '''test''' mode we need to provide fake compute nodes with all the necessary information:

openvim host-add ./openvim/test/hosts/host-example0.yaml
openvim host-add ./openvim/test/hosts/host-example1.yaml
openvim host-add ./openvim/test/hosts/host-example2.yaml
openvim host-add ./openvim/test/hosts/host-example3.yaml
openvim host-list #-v,-vv,-vvv for verbosity levels

In '''normal''' or '''host only''' mode, the process is a bit more complex. First, you need to configure appropriately the host following these [[guidelines|Compute node configuration]]. The current process is manual, although we are working on an automated process. For the moment, follow these instructions:

#copy openvim/scripts/host-add.sh and run at compute host for gather all the information
./host_add.sh <user> <ip_name> >> host.yaml

#NOTE: If the host contains interfaces connected to the openflow switch for dataplane,
# the switch port where the interfaces are connected must be provided manually,
# otherwise these interfaces cannot be used. Follow one of two methods:
# 1) Fill openvim/database_utils/of_ports_pci_correspondence.sql ...
# ... and load with mysql -uvim -p vim_db < openvim/database_utils/of_ports_pci_correspondence.sql
# 2) or add manually this information at generated host.yaml with a 'switch_port: <whatever>'
# ... entry at 'host-data':'numas': 'interfaces'

# copy this generated file host.yaml to the openvim server, and add the compute host with the command:
openvim host-add host.yaml

# copy openvim ssh key to the compute node. If openvim user didn't have a ssh key generate it using ssh-keygen
ssh-copy-id <compute node user>@<IP address of the compute node>

'''Note''': It must be noted that Openvim has been tested with servers based on Xeon E5 Intel processors with Ivy Bridge architecture. No tests have been carried out with Intel Core i3, i5 and i7 families, so there are no guarantees that the integration will be seamless.

==Adding external networks==

- Let's list the external networks:

openvim net-list

- Let's create some external networks in openvim. These networks are public and can be used by any VNF. It must be noticed that these networks must be pre-provisioned in the compute nodes in order to be effectively used by the VNFs. The pre-provision will be skipped since we are in test mode. Four networks will be created:
* ''default'' -> default NAT network provided by libvirt. By creating this network, VMs will be able to connect to default network in the same host where they are deployed.
* ''macvtap:em1'' -> macvtap network associated to interface "em1". By creating this network, we allow VMs to connect to a macvtap interface of physical interface "em1" in the same host where they are deployed. If the interface naming scheme is different, use the appropriate name instead of "em1".
* ''bridge_net'' -> bridged network intended for VM-to-VM communication. The pre-provision of a Linux bridge in all compute nodes is described in [[Compute node configuration#pre-provision-of-linux-bridges]]. By creating this network, VMs will be able to connect to the Linux bridge "virbrMan1" in the same host where they are deployed. In that way, two VMs connected to "virbrMan1", no matter the host, will be able to talk each other.
* ''data_net'' -> external data network intended for VM-to-VM communication. By creating this network, VMs will be able to connect to a network element connected behind a physical port in the external switch.

In order to create external networks, use 'openvim net-create', specifying a file with the network information. Now we will create the 4 networks:

openvim net-create ./openvim/test/networks/net-example0.yaml
openvim net-create ./openvim/test/networks/net-example1.yaml
openvim net-create ./openvim/test/networks/net-example2.yaml
openvim net-create ./openvim/test/networks/net-example3.yaml

- Let's list the external networks:

openvim net-list
2c386a58-e2b5-11e4-a3c9-52540032c4fa data_net
35671f9e-e2b4-11e4-a3c9-52540032c4fa default
79769aa2-e2b4-11e4-a3c9-52540032c4fa macvtap:em1
8f597eb6-e2b4-11e4-a3c9-52540032c4fa bridge_net

You can build your own networks using the template 'templates/network.yaml'. Alternatively, you can use 'openvim net-create' without a file and answer the questions:

openvim net-create

You can delete a network, e.g. "macvtap:em1", using the command:

openvim net-delete macvtap:em1

==Creating a new tenant==
- Now let's create a new tenant "admin":

$ openvim tenant-create --name admin --description admin
<uuid> admin Created

- Take the uuid of the tenant and update the environment variables used by openvim client:

export OPENVIM_TENANT=<obtained uuid>
#echo "export OPENVIM_TENANT=<obtained uuid>" >> /home/${USER}/.bashrc
openvim config #show openvim env variables

OpenVIM installation (Release One)

2016-10-28T11:59:06Z

Montesmoreno: /* Adding compute nodes */

__TOC__

=Infrastructure=
In order to run openvim in normal mode (see bellow the available modes) and deploy dataplane VNFs, an appropriate infrastructure is required. Below a reference architecture for an openvim-based DC deployment.

[[File:OpenvimDC.png|500px|Openvim Datacenter infrastructure]]

Openvim needs to be accesible from Resource Orchestrator (openmano).
Openvim needs:
* To make its API accesible from Resource Orchestrator (openmano). That's the purpose of the VIM mgmt network in the figure.
* To be connected to all compute servers through a network, the DC infrastructure network in the figure.
* To offer management IP addresses to VNFs for VNF configuration from CM (Juju server). That's the purpose of the Telco/VNF management network.

Compute nodes, besides being connected to the DC infrastructure network, must also be connected to two additional networks:
*Telco/VNF management network, used by Configuration Manager (Juju Server) to configure the VNFs
*Inter-DC network, optionally required to interconnect this datacenter to other datacenters (e.g. in MWC'16 demo, to interconnect the two sites).

VMs will be connected to these two networks at deployment time if requested by openmano.

=VM creation (openvim server)=
* Requirements:
** 1 vCPU (2 recommended)
** 4 GB RAM (4 GB are required to run OpenDaylight controller; if the ODL controller runs outside the VM, 2 GB RAM are enough)
** 40 GB disk
** 3 network interfaces to:
*** OSM network (to interact with RO)
*** DC intfrastructure network (to interact with the compute servers and switches)
*** Telco/VNF management network (to provide IP addresses via DHCP to the VNFs)
*Base image: ubuntu-16.04-server-amd64

=Installation=
Openvim is installed using a script
wget -O install-openvim.sh "https://osm.etsi.org/gitweb/?p=osm/openvim.git;a=blob_plain;f=scripts/install-openvim.sh"
chmod +x install-openvim.sh
sudo ./install-openvim.sh [-u <database-admin-user>] [-p <database-admin-password>]
#NOTE: you can provide optionally the admin user (normally 'root') and password of the database.

On Ubuntu 16.04 it will install openvim as a service on /opt/openvim

== Openflow controller==
For normal or OF only openvim modes you will need a openflow controller. You can install e.g. floodlight-0.90. The script '''openvim/scripts/install-floodlight.sh''' makes this steps for you. And the script '''service-floodlight''' can be used to start/stop it in a screen with logs.

== DHCP server==

For the management network a DHCP server is needed. Install the package dhcp3-server. This package will install the actual DHCP server based on isc-dhcp-server package.

sudo install dhcp3-server

Configure it editing file '''/etc/default/isc-dhcp-server''' to enable DHCP server in the appropriate interface, the one attached to Telco/VNF management network (e.g. eth1).

$ sudo vi /etc/default/isc-dhcp-server
INTERFACES="eth1"

Edit file '''/etc/dhcp/dhcpd.conf''' to specify the subnet, netmask and range of IP addresses to be offered by the server.

$ sudo vi /etc/dhcp/dhcpd.conf
ddns-update-style none;
default-lease-time 86400;
max-lease-time 86400;
log-facility local7;
option subnet-mask 255.255.0.0;
option broadcast-address 10.210.255.255;
subnet 10.210.0.0 netmask 255.255.0.0 {
range 10.210.1.2 10.210.1.254;
}

Restart the service:

sudo service isc-dhcp-server restart

=Configuration=

- Go to openvim folder ('''/opt/openvim''') and edit openvimd.cfg. Note: by default it runs in mode: '''test''' where no real hosts neither openflow controller are needed. You can uses other modes:

{| class="wikitable"
|-
! mode
! Computes hosts
! Openflow controller
! Observations
|-
| test
| fake
| X
| No real deployment. Just for API test
|-
| normal
| needed
| needed
| Normal behaviour
|-
| host only
| needed
| X
| No PT/SRIOV connections
|-
| develop
| needed
| X
| Force to cloud type deployment without EPA
|-
| OF only
| fake
| needed
| To test openflow controller without needed of compute hosts
|}

Service must be restarted
sudo service openvim restart

NOTE: the following steps (ONLY if openvim runs in test mode) are done automatically by script:
./openvim/scripts/initopenvim.sh --insert-bashrc --force

- Let's configure the openvim CLI client. Needed if you have changed the openvimd.cfg file

openvim config # show openvim related variables
#To change variables run
export OPENVIM_HOST=<http_host of openvimd.cfg>
export OPENVIM_PORT=<http_port of openvimd.cfg>
export OPENVIM_ADMIN_PORT=<http_admin_port of openvimd.cfg>
#You can insert at .bashrc for authomatic loading at login:
echo "export OPENVIM_HOST=<...>" >> /{HOME}/.bashrc
...

==Adding compute nodes==
- Let's attach compute nodes

In '''test''' mode we need to provide fake compute nodes with all the necessary information:

openvim host-add ./openvim/test/hosts/host-example0.yaml
openvim host-add ./openvim/test/hosts/host-example1.yaml
openvim host-add ./openvim/test/hosts/host-example2.yaml
openvim host-add ./openvim/test/hosts/host-example3.yaml
openvim host-list #-v,-vv,-vvv for verbosity levels

In '''normal''' or '''host only''' mode, the process is a bit more complex. First, you need to configure appropriately the host following these [[guidelines|Compute node configuration]]. The current process is manual, although we are working on an automated process. For the moment, follow these instructions:

#copy openvim/scripts/host-add.sh and run at compute host for gather all the information
./host_add.sh <user> <ip_name> >> host.yaml

#NOTE: If the host contains interfaces connected to the openflow switch for dataplane,
# the switch port where the interfaces are connected must be provided manually,
# otherwise these interfaces cannot be used. Follow one of two methods:
# 1) Fill openvim/database_utils/of_ports_pci_correspondence.sql ...
# ... and load with mysql -uvim -p vim_db < openvim/database_utils/of_ports_pci_correspondence.sql
# 2) or add manually this information at generated host.yaml with a 'switch_port: <whatever>'
# ... entry at 'host-data':'numas': 'interfaces'

# copy this generated file host.yaml to the openvim server, and add the compute host with the command:
openvim host-add host.yaml

# copy openvim ssh key to the compute node. If openvim user didn't have a ssh key generate it using ssh-keygen
ssh-copy-id <compute node user>@<IP address of the compute node>

'''Note''': It must be noted that Openvim has been tested with servers based on Xeon E5 Intel processors with Ivy Bridge architecture. No tests have been carried out with Intel Core i3, i5 and i7 families, so there are no guarantees that the integration will be seamless.

==Adding external networks==

- Let's list the external networks:

openvim net-list

- Let's create some external networks in openvim. These networks are public and can be used by any VNF. It must be noticed that these networks must be pre-provisioned in the compute nodes in order to be effectively used by the VNFs. The pre-provision will be skipped since we are in test mode. Four networks will be created:
* ''default'' -> default NAT network provided by libvirt. By creating this network, VMs will be able to connect to default network in the same host where they are deployed.
* ''macvtap:em1'' -> macvtap network associated to interface "em1". By creating this network, we allow VMs to connect to a macvtap interface of physical interface "em1" in the same host where they are deployed. If the interface naming scheme is different, use the appropriate name instead of "em1".
* ''bridge_net'' -> bridged network intended for VM-to-VM communication. The pre-provision of a Linux bridge in all compute nodes is described in [[Compute node configuration#pre-provision-of-linux-bridges]]. By creating this network, VMs will be able to connect to the Linux bridge "virbrMan1" in the same host where they are deployed. In that way, two VMs connected to "virbrMan1", no matter the host, will be able to talk each other.
* ''data_net'' -> external data network intended for VM-to-VM communication. By creating this network, VMs will be able to connect to a network element connected behind a physical port in the external switch.

In order to create external networks, use 'openvim net-create', specifying a file with the network information. Now we will create the 4 networks:

openvim net-create test/networks/net-example0.yaml
openvim net-create test/networks/net-example1.yaml
openvim net-create test/networks/net-example2.yaml
openvim net-create test/networks/net-example3.yaml

- Let's list the external networks:

openvim net-list
2c386a58-e2b5-11e4-a3c9-52540032c4fa data_net
35671f9e-e2b4-11e4-a3c9-52540032c4fa default
79769aa2-e2b4-11e4-a3c9-52540032c4fa macvtap:em1
8f597eb6-e2b4-11e4-a3c9-52540032c4fa bridge_net

You can build your own networks using the template 'templates/network.yaml'. Alternatively, you can use 'openvim net-create' without a file and answer the questions:

openvim net-create

You can delete a network, e.g. "macvtap:em1", using the command:

openvim net-delete macvtap:em1

==Creating a new tenant==
- Now let's create a new tenant "admin":

$ openvim tenant-create --name admin --description admin
<uuid> admin Created

- Take the uuid of the tenant and update the environment variables used by openvim client:

export OPENVIM_TENANT=<obtained uuid>
#echo "export OPENVIM_TENANT=<obtained uuid>" >> /home/${USER}/.bashrc
openvim config #show openvim env variables

OpenVIM installation (Release One)

2016-10-28T11:58:11Z

Montesmoreno: /* Adding compute nodes */

__TOC__

=Infrastructure=
In order to run openvim in normal mode (see bellow the available modes) and deploy dataplane VNFs, an appropriate infrastructure is required. Below a reference architecture for an openvim-based DC deployment.

[[File:OpenvimDC.png|500px|Openvim Datacenter infrastructure]]

Openvim needs to be accesible from Resource Orchestrator (openmano).
Openvim needs:
* To make its API accesible from Resource Orchestrator (openmano). That's the purpose of the VIM mgmt network in the figure.
* To be connected to all compute servers through a network, the DC infrastructure network in the figure.
* To offer management IP addresses to VNFs for VNF configuration from CM (Juju server). That's the purpose of the Telco/VNF management network.

Compute nodes, besides being connected to the DC infrastructure network, must also be connected to two additional networks:
*Telco/VNF management network, used by Configuration Manager (Juju Server) to configure the VNFs
*Inter-DC network, optionally required to interconnect this datacenter to other datacenters (e.g. in MWC'16 demo, to interconnect the two sites).

VMs will be connected to these two networks at deployment time if requested by openmano.

=VM creation (openvim server)=
* Requirements:
** 1 vCPU (2 recommended)
** 4 GB RAM (4 GB are required to run OpenDaylight controller; if the ODL controller runs outside the VM, 2 GB RAM are enough)
** 40 GB disk
** 3 network interfaces to:
*** OSM network (to interact with RO)
*** DC intfrastructure network (to interact with the compute servers and switches)
*** Telco/VNF management network (to provide IP addresses via DHCP to the VNFs)
*Base image: ubuntu-16.04-server-amd64

=Installation=
Openvim is installed using a script
wget -O install-openvim.sh "https://osm.etsi.org/gitweb/?p=osm/openvim.git;a=blob_plain;f=scripts/install-openvim.sh"
chmod +x install-openvim.sh
sudo ./install-openvim.sh [-u <database-admin-user>] [-p <database-admin-password>]
#NOTE: you can provide optionally the admin user (normally 'root') and password of the database.

On Ubuntu 16.04 it will install openvim as a service on /opt/openvim

== Openflow controller==
For normal or OF only openvim modes you will need a openflow controller. You can install e.g. floodlight-0.90. The script '''openvim/scripts/install-floodlight.sh''' makes this steps for you. And the script '''service-floodlight''' can be used to start/stop it in a screen with logs.

== DHCP server==

For the management network a DHCP server is needed. Install the package dhcp3-server. This package will install the actual DHCP server based on isc-dhcp-server package.

sudo install dhcp3-server

Configure it editing file '''/etc/default/isc-dhcp-server''' to enable DHCP server in the appropriate interface, the one attached to Telco/VNF management network (e.g. eth1).

$ sudo vi /etc/default/isc-dhcp-server
INTERFACES="eth1"

Edit file '''/etc/dhcp/dhcpd.conf''' to specify the subnet, netmask and range of IP addresses to be offered by the server.

$ sudo vi /etc/dhcp/dhcpd.conf
ddns-update-style none;
default-lease-time 86400;
max-lease-time 86400;
log-facility local7;
option subnet-mask 255.255.0.0;
option broadcast-address 10.210.255.255;
subnet 10.210.0.0 netmask 255.255.0.0 {
range 10.210.1.2 10.210.1.254;
}

Restart the service:

sudo service isc-dhcp-server restart

=Configuration=

- Go to openvim folder ('''/opt/openvim''') and edit openvimd.cfg. Note: by default it runs in mode: '''test''' where no real hosts neither openflow controller are needed. You can uses other modes:

{| class="wikitable"
|-
! mode
! Computes hosts
! Openflow controller
! Observations
|-
| test
| fake
| X
| No real deployment. Just for API test
|-
| normal
| needed
| needed
| Normal behaviour
|-
| host only
| needed
| X
| No PT/SRIOV connections
|-
| develop
| needed
| X
| Force to cloud type deployment without EPA
|-
| OF only
| fake
| needed
| To test openflow controller without needed of compute hosts
|}

Service must be restarted
sudo service openvim restart

NOTE: the following steps (ONLY if openvim runs in test mode) are done automatically by script:
./openvim/scripts/initopenvim.sh --insert-bashrc --force

- Let's configure the openvim CLI client. Needed if you have changed the openvimd.cfg file

openvim config # show openvim related variables
#To change variables run
export OPENVIM_HOST=<http_host of openvimd.cfg>
export OPENVIM_PORT=<http_port of openvimd.cfg>
export OPENVIM_ADMIN_PORT=<http_admin_port of openvimd.cfg>
#You can insert at .bashrc for authomatic loading at login:
echo "export OPENVIM_HOST=<...>" >> /{HOME}/.bashrc
...

==Adding compute nodes==
- Let's attach compute nodes

In '''test''' mode we need to provide fake compute nodes with all the necessary information:

openvim host-add test/hosts/host-example0.yaml
openvim host-add test/hosts/host-example1.yaml
openvim host-add test/hosts/host-example2.yaml
openvim host-add test/hosts/host-example3.yaml
openvim host-list #-v,-vv,-vvv for verbosity levels

In '''normal''' or '''host only''' mode, the process is a bit more complex. First, you need to configure appropriately the host following these [[guidelines|Compute node configuration]]. The current process is manual, although we are working on an automated process. For the moment, follow these instructions:

#copy openvim/scripts/host-add.sh and run at compute host for gather all the information
./host_add.sh <user> <ip_name> >> host.yaml

#NOTE: If the host contains interfaces connected to the openflow switch for dataplane,
# the switch port where the interfaces are connected must be provided manually,
# otherwise these interfaces cannot be used. Follow one of two methods:
# 1) Fill openvim/database_utils/of_ports_pci_correspondence.sql ...
# ... and load with mysql -uvim -p vim_db < openvim/database_utils/of_ports_pci_correspondence.sql
# 2) or add manually this information at generated host.yaml with a 'switch_port: <whatever>'
# ... entry at 'host-data':'numas': 'interfaces'

# copy this generated file host.yaml to the openvim server, and add the compute host with the command:
openvim host-add host.yaml

# copy openvim ssh key to the compute node. If openvim user didn't have a ssh key generate it using ssh-keygen
ssh-copy-id <compute node user>@<IP address of the compute node>

'''Note''': It must be noted that Openvim has been tested with servers based on Xeon E5 Intel processors with Ivy Bridge architecture. No tests have been carried out with Intel Core i3, i5 and i7 families, so there are no guarantees that the integration will be seamless.

==Adding external networks==

- Let's list the external networks:

openvim net-list

- Let's create some external networks in openvim. These networks are public and can be used by any VNF. It must be noticed that these networks must be pre-provisioned in the compute nodes in order to be effectively used by the VNFs. The pre-provision will be skipped since we are in test mode. Four networks will be created:
* ''default'' -> default NAT network provided by libvirt. By creating this network, VMs will be able to connect to default network in the same host where they are deployed.
* ''macvtap:em1'' -> macvtap network associated to interface "em1". By creating this network, we allow VMs to connect to a macvtap interface of physical interface "em1" in the same host where they are deployed. If the interface naming scheme is different, use the appropriate name instead of "em1".
* ''bridge_net'' -> bridged network intended for VM-to-VM communication. The pre-provision of a Linux bridge in all compute nodes is described in [[Compute node configuration#pre-provision-of-linux-bridges]]. By creating this network, VMs will be able to connect to the Linux bridge "virbrMan1" in the same host where they are deployed. In that way, two VMs connected to "virbrMan1", no matter the host, will be able to talk each other.
* ''data_net'' -> external data network intended for VM-to-VM communication. By creating this network, VMs will be able to connect to a network element connected behind a physical port in the external switch.

In order to create external networks, use 'openvim net-create', specifying a file with the network information. Now we will create the 4 networks:

openvim net-create test/networks/net-example0.yaml
openvim net-create test/networks/net-example1.yaml
openvim net-create test/networks/net-example2.yaml
openvim net-create test/networks/net-example3.yaml

- Let's list the external networks:

openvim net-list
2c386a58-e2b5-11e4-a3c9-52540032c4fa data_net
35671f9e-e2b4-11e4-a3c9-52540032c4fa default
79769aa2-e2b4-11e4-a3c9-52540032c4fa macvtap:em1
8f597eb6-e2b4-11e4-a3c9-52540032c4fa bridge_net

You can build your own networks using the template 'templates/network.yaml'. Alternatively, you can use 'openvim net-create' without a file and answer the questions:

openvim net-create

You can delete a network, e.g. "macvtap:em1", using the command:

openvim net-delete macvtap:em1

==Creating a new tenant==
- Now let's create a new tenant "admin":

$ openvim tenant-create --name admin --description admin
<uuid> admin Created

- Take the uuid of the tenant and update the environment variables used by openvim client:

export OPENVIM_TENANT=<obtained uuid>
#echo "export OPENVIM_TENANT=<obtained uuid>" >> /home/${USER}/.bashrc
openvim config #show openvim env variables