=== Open Source MANO (OSM)

A full deployment consists of 3 components:
* OSM as the NFV Orchestrator
* OpenVIM or Openstack as the virtual infrastructure manager (VIM)
* some number of compute nodes, where the VIM will run VMs under OSM's instruction

We will use the following components:
* OSM on ubuntu 18.04
* Devstack on ubuntu 18.04, in a single node configuration (this can easily be extended following devstack guides)


This tutorial implements the getting started from: [https://osm.etsi.org/docs/user-guide/01-quickstart.html#installing-osm here], and adds support for ORBIT hardware, with the image based on Ubuntu 18.04.

To save time, run the OSM and VIM steps in separate ssh terminals, as they can be done at the same time.

==== OSM Node


===== Pre-set-up:
1. Create a reservation
1. Log into the console
1. Load image: {{{ omf load -t srv1-lg1.sb1.cosmos-lab.org -i tutorial-osm.ndz -r 60}}}
  1. You should see: {{{ INFO exp:  1 node successfully imaged ... }}}
1. Turn the node on: {{{ omf tell -a on -t srv1-lg1.sb1.cosmos-lab.org }}}
1. Wait for the node to come up, (up to ~3 minutes)
 1. You can ping the node, it will respond once booted


[[CollapsibleStart(From Scratch)]]
Dependencies:
* 40Gb disk space
* user:
 * non-root user,
 * with non-empty password
 * member of sudo, docker, lxd groups
* Packages:
 * net-tools
* ipv6 disabled

1. Prepare the node
 1. Load the image: {{{ omf load -t srv2-lg1.sb1.cosmos-lab.org -i baseline_1804.ndz -r 60 }}}
 1. Turn the node on: {{{ omf tell -a on -t srv3-lg1.sb1.cosmos-lab.org }}}
 1. Log in as root: {{{ ssh native@srv3-lg1.sb1.cosmos-lab.org }}}
 1. set up non-root user {{{  echo native:native | chpasswd }}}
 1. Add user to groups: {{{ sudo groupadd lxd && sudo groupadd docker && sudo usermod -a -G lxd,docker native }}}
 1. logout: {{{ exit }}}
 1. Log in as the user "native": {{{ ssh native@srv3-lg1.sb1.cosmos-lab.org }}}
1. Set up OSM
 1. Install "net-tools" {{{ sudo apt install net-tools }}}
 1. Download script: {{{ wget https://osm-download.etsi.org/ftp/osm-6.0-six/install_osm.sh }}}
 1. Make it executable: {{{ chmod +x install_osm.sh }}}
 1. Run it: {{{ ./install_osm.sh 2>&1 | tee osm_install_log.txt }}}
 1. enter "y"
  1. if it crashes, run {{{ lxd init }}}
 1. choose all defaults, except {{{none}}} for ipv6
 1. if failed, rerun install_osm.sh
1. Connect browser
 1. Via ssh tunnel
 1. via VPN (TODO)
 1. navigate browser to node control ip, enter admin/admin as credentials


Run these commands to clean up the old configuration:

docker stack rm osm && sleep 60 # The sleep is for making sure the stack removal finishes before redeploying
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm

Save image
 
[[CollapsibleEnd]]
==== VIM Node
OSM must have a Virtual Infrastructure Manager (VIM) to control. We will use openstack on single node devstack for this tutorial, following [https://docs.openstack.org/devstack/train/guides/single-machine.html this guide].



===== Pre-Set up:
1. {{{ omf load -t srv2-lg1.sb1.cosmos-lab.org -i tutorial-devstack.ndz -r 60}}}
 1. You should see: {{{ INFO exp:  1 node successfully imaged ... }}}
1. {{{ omf tell -a on -t srv2-lg1.sb1.cosmos-lab.org }}}
1. Wait for the node to come up  (up to ~3 minutes)
 1. You can ping the node, it will respond once booted
1. {{{ ssh native@srv2-lg1.sb1.cosmos-lab.org }}}
1. {{{ cd ~/devstack }}}
1. {{{ ./stack.sh }}}

Commands will run for a while (about 10 minutes). If successful, it will output the credentials and address to login via the webui, and will look like the following:
{{{#!shell-session
=========================
DevStack Component Timing
 (times are in seconds)  
=========================
run_process           16 
test_with_retry        2 
apt-get-update         5 
osc                  115 
wait_for_service      10 
git_timed            107 
dbsync                65 
pip_install          201 
apt-get              166 
-------------------------
Unaccounted time     345 
=========================
Total runtime        1032


This is your host IP address: 10.19.1.2
This is your host IPv6 address: ::1
Horizon is now available at http://10.19.1.2/dashboard
Keystone is serving at http://10.19.1.2/identity/
The default users are: admin and demo
The password: native
}}}

You will need the ip address, keystone url, user and password in the following steps.


[[CollapsibleStart(From Scratch)]]
Follow https://docs.openstack.org/devstack/latest/guides/single-machine.html

https://docs.openstack.org/devstack/latest/networking.html


If you don’t specify any configuration you will get the following:

neutron (including l3 with openvswitch)

private project networks for each openstack project

a floating ip range of 172.24.4.0/24 with the gateway of 172.24.4.1

the demo project configured with fixed ips on a subnet allocated from the 10.0.0.0/22 range

a br-ex interface controlled by neutron for all its networking (this is not connected to any physical interfaces).

DNS resolution for guests based on the resolv.conf for your host

an ip masq rule that allows created guests to route out

PUBLIC_INTERFACE=eth1 (this connects to the br-ex bridge)

https://docs.openstack.org/devstack/latest/_sources/guides/neutron.rst.txt


* Change IP without running stack.sh:
* Run unstack.sh
* In keystone database "update endpoint set url = REPLACE(url, '[old IP address]', '[new IP address]')";
* Update all Ips in /etc folder "grep -rl '[old IP address]' /etc | xargs sed -i 's/[old IP address]/[new IP address]/g'"
* Update all Ips in /opt/stack folder "grep -rl '[old IP address]' /opt/stack | xargs sed -i 's/[old IP address]/[new IP address]/g'"
* Restart apache2 server
* Run rejoin-stack.sh
* Restart Keystone "keystone-all"


[[CollapsibleEnd]]

==== Accessing the OSM WebUI
Both nodes are listening on port 80.

Redirect two ports over ssh, following [wiki:UserGuide/RemoteAccess/SshTunnel This Guide]

For example, forward 9901 -> srv1-lg1:80 , 9902 -> srv2-lg1:80

Or Linux example, commands run on your local machine:
{{{ #!shell
ssh testbeduser@sb1.cosmos-lab.org -N \
-L 9980:srv1-lg1:80 \
-L 9981:srv2-lg1:80
}}}

The web credentials are: admin / admin, running at the ip address of the first node.

If the webui doesn't come up:
1. SSH to the node with the ssh credentials: native / native
1. Check to see that all containers are running {{{ docker stack ps osm }}}
1. Try re-installing OSM by running {{{./install_osm.sh}}}


==== Connecting OSM to the VIM
1. Log into the OSM with admin/admin
1. Click "VIM accounts" on the left bar
1. Delete existing accounts with the trash can icon
1. Add the new account for your openstack with the following information:
 * URL {{{ http://$DEVSTACK_IP/identity/v3/ }}}
 * User {{{ admin }}}
 * password {{{ native }}}
 * tenant {{{ admin }}}
 * name {{{ openstack-site }}}
 * Type: {{{ openstack }}}
1. Click create

==== Adding a disk image to openstack
1. download the attachment cirros034 from this page, by clicking attachments, then clicking the filename.
1. in a new window, go to the openstack webui
1. click images
1. click create image
 * name: {{{cirros034}}}
 * image source: browse for the file you downloaded
 * format: qcow2
1. click create image

==== Creating a VNF
1.  VNF package onboarding
 1. go to packages -> vnf packages
 1. download the attachment cirros_vnf.tar.gz
 1. drag the downloaded file to the window
1. NS package onboarding
 1. go to packages -> ns packages
 1. download the attachment cirros_2vnf_ns.tar.gz
 1. drag it to the window
1. Instantiate the NF
 1. click the launch icon and enter information
  * name
  * description
  * nsd_id: {{{cirros_2vnf_ns}}}
  * vim account id: {{{openstack-site}}}

* use openstack ui to load console and ping