https://osm.etsi.org/wikipub/api.php?action=feedcontributions&feedformat=atom&user=RamonsalguerOSM Public Wiki - User contributions [en]2026-05-06T16:34:11ZUser contributionsMediaWiki 1.39.1https://osm.etsi.org/wikipub/index.php?title=How_to_install_OSM_on_VirtualBox&diff=6381How to install OSM on VirtualBox2021-09-29T13:49:56Z<p>Ramonsalguer: </p>
<hr />
<div>'''Deprecated:''' Please refer to https://osm.etsi.org/docs/user-guide/<br />
<br />
---<br />
<br />
VirtualBox has different networking setup modes (see [https://www.virtualbox.org/manual/ch06.html Table 6.1])<br />
<br />
In case we want to install OSM on VirtualBox, it needs an IP address that remains the same across reboots.<br />
<br />
If the host is attached to DHCP and you cannot access the router to assign the same IP to your VMs, "bridged" mode could be difficult to manage. So, a possible alternative is to have two network adapters: one NAT that allows the VMs to access Internet + one Host-Only that allows static address on the VM and traffic from Host to VM.<br />
<br />
OSM can be configured like that using the procedure below, tested on OSM Rel THREE.<br />
<br />
1) Create a VM on VirtualBox (e.g. 8GB RAM, 40GB DISK)<br />
<br />
2) Configure network with 2 adapters: NAT + Host-Only<br />
<br />
3) Install OpenSSH server (sudo apt-get install openssh-server) and update Ubuntu (sudo apt-get update)<br />
<br />
4) Add a static address to the "Host-only" adapter (e.g. enp0s8 with static IP 10.20.0.90), e.g. appending the following to "/etc/network/interfaces":<br />
<br />
auto enp0s8<br />
iface enp0s8 inet static<br />
address 10.20.0.90<br />
netmask 255.255.255.0<br />
network 10.20.0.0<br />
broadcast 10.20.0.255<br />
<br />
5) Restart the network services, then the VM should be reachable in ssh from the host using the static IP address<br />
sudo service networking restart<br />
6) Configure LXD following the instructions: [https://osm.etsi.org/wikipub/index.php/LXD_configuration_for_OSM_Release_THREE OSM Release THREE LXD config]<br />
<br />
7) Install OSM following the instructions: [https://osm.etsi.org/wikipub/index.php/OSM_Release_THREE OSM Three install]<br />
wget https://osm-download.etsi.org/ftp/osm-3.0-three/install_osm.sh<br />
chmod +x install_osm.sh<br />
8) Before launching the installation, modify install_osm.sh, find export_ips (2 times!), and add a line afterwards with:<br />
export DEFAULT_IP=10.20.0.90 <br />
where DEFAULT_IP is the static IP address configured for host-only network)<br />
<br />
9) Install OSM<br />
./install_osm.sh <br />
10) When the installation is over, a final step to configure NAT<br />
git clone https://osm.etsi.org/gerrit/osm/devops.git temp<br />
vi temp/installers/export_ips<br />
#Change the DEFAULT_IF to DEFAULT_IF=enp0s8 (the interface used for Host-only network configuration)<br />
sudo ./temp/installers/nat_osm # in order to apply NAT rules<br />
11) Check NAT rules in "/etc/iptables/rules.v4".<br />
<br />
12) Access OSM GUI using https://10.20.0.90:8443 (admin/admin). You can also ssh to the Virtualbox VM running OSM (ssh ubuntu@10.20.0.90)</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_E2E_tests&diff=6111OSM E2E tests2021-02-17T17:24:16Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM Tester Guide has been moved to a new location: '''https://osm.etsi.org/gitlab/osm-doc/osm-tester-guide'''<br />
<br />
---<br />
<br />
__TOC__<br />
<br />
= OSM packages and images for E2E tests =<br />
<br />
All VNF and NS packages as well as VM images required for the tests can be found here: '''[http://osm-download.etsi.org/ftp/e2e-tests/ http://osm-download.etsi.org/ftp/e2e-tests/]'''<br />
<br />
= Test 1. Sanity check with simple NS =<br />
Objectives:<br />
<br />
* Sanity check of correct E2E behaviour.<br />
* Validate VM image management.<br />
* Test access to the console from OSM UI<br />
<br />
Steps:<br />
<br />
* Onboard and deploy the Cirros NS, as described in [https://osm.etsi.org/wikipub/index.php/OSM_Release_TWO#Deploying_your_first_Network_Service https://osm.etsi.org/wikipub/index.php/OSM_Release_TWO#Deploying_your_first_Network_Service]<br />
* Access the console via OSM UI (user: “<tt>cirros</tt>”, pwd: “<tt>cubswin:)</tt>”)<br />
* Check that the VMs are up and running and connected via the common link.<br />
<br />
Images:<br />
<br />
* cirros034.qcow2<br />
<br />
Descriptors:<br />
<br />
* cirros_vnf<br />
* cirros_2vnf_ns<br />
<br />
= Test 2a. Failed deployment of scenario when the checksum is invalid =<br />
Objective:<br />
<br />
* Testing that a wrong checksum prevents a successful deployment<br />
<br />
Steps:<br />
<br />
* Modify the checksum in the VNF descriptor (using the UI VNF catalog) to add a wrong but format-valid checksum (e.g.: “aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa”). Same images are used.<br />
* Deploy the same NS as in test1<br />
* Check that the system refuses to deploy the NS due to a checksum error (“VIM Exception vimconnException Image not found at VIM with filter…”)<br />
<br />
Images:<br />
<br />
* cirros034.qcow2<br />
<br />
Descriptors:<br />
<br />
* cirros_vnf<br />
* cirros_2vnf_ns<br />
<br />
= Test 2b. Successful deployment of scenario when the descriptor has a checksum =<br />
Objective:<br />
<br />
* Testing that a valid checksum in the VNF descriptor leads to a successful deployment<br />
<br />
Steps:<br />
<br />
* Modify the checksum in the VNF descriptor (using the UI VNF catalog) to add the valid checksum for the image (“ee1eca47dc88f4879d8a229cc70a07c6” for the cirros034 image).<br />
* Deploy the same NS as in test1<br />
* Check that the NS is successfully instantiated.<br />
* Access the console via OSM UI (user: “<tt>cirros</tt>”, pwd: “<tt>cubswin:)</tt>”)<br />
* Check that the VMs are up and running and connected via the common link.<br />
<br />
Images:<br />
<br />
* cirros034.qcow2<br />
<br />
Descriptors:<br />
<br />
* cirros_vnf<br />
* cirros_2vnf_ns<br />
<br />
= Test 3a. Instantiation time of large NS based on Cirros images =<br />
Objective:<br />
<br />
* Check that instantiation time is bounded to avoid spurious timeouts.<br />
* Measure delay in the deployment, and evaluate potential issues in the connector.<br />
<br />
Steps:<br />
<br />
* Onboard a “large NS” consisting of:<br />
** 2 types of VNFs based on Cirros VM. VNF#1 should have 5 interfaces (+management), while VNF#2 would only require 1 interface (+management)<br />
** Star topology, with 1 VNF in the middle and 5 instances of the other VNF connected to that one (+ the corresponding management interfaces)<br />
* Launch NS instantiation, specifying the right mgmt network to be used<br />
* Check that the UI reports a successful deployment<br />
* Connect to each VNF via SSH (user: “<tt>cirros</tt>”, pwd: “<tt>cubswin:)</tt>”)<br />
<br />
Images:<br />
<br />
* cirros034.qcow2<br />
<br />
Descriptors:<br />
<br />
* cirros_2ifaces_vnf<br />
* cirros_6ifaces_vnf<br />
* test3a_ns<br />
<br />
= Test 3b. Instantiation time of large NS based on Cirros images using IP profiles =<br />
Objective:<br />
<br />
* Check that instantiation time is bounded to avoid spurious timeouts.<br />
* Measure delay in the deployment, and evaluate potential issues in the connector.<br />
<br />
* Check that IP profiles work properly in a large NS<br />
<br />
Steps:<br />
<br />
* Onboard a “large NS” consisting of:<br />
** 2 types of VNFs based on Cirros VM. VNF#1 should have 5 interfaces (+management), while VNF#2 would only require 1 interface (+management)<br />
** Star topology, with 1 VNF in the middle and 5 instances of the other VNF connected to that one (+ the corresponding management interfaces)<br />
** Networks will have an IP profile so that DHCP is enabled<br />
* Launch NS instantiation, specifying the right mgmt network to be used<br />
* Check that the UI reports a successful deployment<br />
* Connect to each VNF via SSH (user: “<tt>cirros</tt>”, pwd: “<tt>cubswin:)</tt>”) and configure the interfaces to use DHCP, e.g. by changing /etc/network/interfaces and running “ifup ethX”<br />
* Check that connectivity is appropriate via ping from the different VMs<br />
<br />
Images:<br />
<br />
* cirros034.qcow2<br />
<br />
Descriptors:<br />
<br />
* cirros_2ifaces_vnf<br />
* cirros_6ifaces_vnf<br />
* test3b_ns<br />
<br />
= Test 3c. Instantiation time of large NS based on Ubuntu images using IP profiles =<br />
Objective:<br />
<br />
* Check that instantiation time is bounded to avoid spurious timeouts, even with large images (Ubuntu vs CirrOS).<br />
* Measure delay in the deployment, and evaluate potential issues in the connector.<br />
* Check that IP profiles work properly in a large NS<br />
<br />
Steps:<br />
<br />
* Onboard a “large NS” consisting of:<br />
** 2 types of VNFs based on Ubuntu VM. VNF#1 should have 5 interfaces (+management), while VNF#2 would only require 1 interface (+management)<br />
** Star topology, with 1 VNF in the middle and 5 instances of the other VNF connected to that one (+ the corresponding management interfaces)<br />
** Networks will have an IP profile so that DHCP is enabled<br />
* Launch NS instantiation, specifying the right mgmt network to be used<br />
* Check that the UI reports a successful deployment<br />
* Connect to each VNF via SSH (user: “<tt>osm</tt>”, pwd: “<tt>osm4u</tt>”).<br />
* Check that connectivity is appropriate via ping from the different VMs<br />
<br />
Images:<br />
<br />
* US1604<br />
<br />
Descriptors:<br />
<br />
* ubuntu_2ifaces_vnf<br />
* ubuntu_6ifaces_vnf<br />
* test3c_ns<br />
<br />
= Test 4a. Day 0 configuration: SSH key injection to the default user =<br />
Objective:<br />
<br />
* Testing SSH key injection to the default user<br />
<br />
Steps:<br />
<br />
* Onboard a variant of the NS of Test #1, but with Ubuntu VNFs.<br />
* Add an SSH key through the UI (Launchpad > SSH Keys), where the key to be added is the public key.<br />
* Instantiate the NS via UI, requesting the injection of a given SSH key for the default user. Specify also the right mgmt network to be used.<br />
* Check that the UI reports a successful deployment<br />
* Check that the VMs are accessible via SSH, using the private SSH key, from the management network.<br />
<br />
Images:<br />
<br />
* ubuntu1604<br />
<br />
Descriptors:<br />
<br />
* ubuntu_1iface_vnf<br />
* test4a_ns<br />
<br />
= Test 4b. Day 0 configuration: user addition =<br />
Objective:<br />
<br />
* Testing creation of new user and SSH key injection to that user<br />
<br />
Steps:<br />
<br />
* Onboard a the variant of the NS of Test #4a (test4b_ns), where the NS includes a user “osm” and SSH public key to be injected to every VNF.<br />
* Launch NS instantiation via UI, specifying the right mgmt network to be used.<br />
* Check that the UI reports a successful deployment.<br />
* Check that the VMs are accessible from the management network via the new user “osm” using its private SSH key (the private key is stored in the folder "test4b_ns/keys" inside the NS package).<br />
<br />
Images:<br />
<br />
* ubuntu1604<br />
<br />
Descriptors:<br />
<br />
* ubuntu_1iface_vnf<br />
* test4b_ns<br />
<br />
= Test 4c. Day 0 configuration: custom user script with cloud-init =<br />
Objective:<br />
<br />
* Testing injection of cloud-init custom user script<br />
<br />
Steps:<br />
<br />
* Onboard a variant of the NS of Test #4a (test4c_ns), where the VNF includes a cloud-config custom script that creates a file in the VM and injects a SSH public key to the default user.<br />
* Launch NS instantiation via UI, specifying the right mgmt network to be used<br />
* Check that the UI reports a successful deployment.<br />
* Access the VM via SSH and check that the file has been successfully created. The private key is "test4.pem", stored in the folder "ubuntu_1iface_cloudinit_newfile_vnf/keys" inside the VNF package.<br />
<br />
Images:<br />
<br />
* ubuntu1604<br />
<br />
Descriptors:<br />
<br />
* ubuntu_1iface_cloudinit_newfile_vnf<br />
* test4c_ns<br />
<br />
= Test 5. Port security disabled =<br />
Objective:<br />
<br />
* Testing the ability to disable port security on demand<br />
<br />
Steps:<br />
<br />
* Onboard a variant of the NS of Test #4 (test5_ns), but with a VNF whose single interface has port security disabled.<br />
* Launch NS instantiation via UI, specifying the right mgmt network to be used<br />
* Check that the UI reports a successful deployment.<br />
* Connect to each VNF via SSH (user: “<tt>osm</tt>”, pwd: “<tt>osm4u</tt>”).<br />
* Configure both VNFs with an additional IP address of the same subnet, e.g.: 192.168.50.X/24<br />
** Do not remove the mgmt IP address.<br />
** Add an additional IP address to the single interfaces using the command "ip addr add 192.168.50.X/24 dev eth0" and ping from one VNF to the other one.<br />
* If port security and security groups have been properly disabled, the ping between both VNFs using the added IP addresses should work.<br />
<br />
Images:<br />
<br />
* US1604<br />
<br />
Descriptors:<br />
<br />
* ubuntu_1iface_noportsecurity_vnf<br />
* test5_ns<br />
<br />
= Test 6a. Assignment of public IP addresses to management interfaces of single-interface VNFs =<br />
Objective:<br />
<br />
* Testing the assignment of IP addresses from a pool to VNF management interfaces<br />
<br />
Prerequisites:<br />
<br />
* Configure the VIM to allow the dynamic assignment of public addresses from a pool<br />
* Configure a VIM network (e.g. “public”) to use the appropriate pool, to allow external access via “public” IP addresses.<br />
* Configure the datacenter in the RO to assign public IP addresses to VNF management interfaces (use_floating_ip: true)<br />
<br />
Steps:<br />
<br />
* Onboard and deploy a NS consisting of 2 Ubuntu VNFs interconnected by a single network (mgmt).<br />
* Instantiate the NS via UI, specifying that the NS network “mgmt” must be mapped to the VIM network name “public”, so that a “public” IP address will be assigned from the pool.<br />
* Check that the UI reports a successful deployment.<br />
* Connect to each VNF via SSH (user: “<tt>osm</tt>”, pwd: “<tt>osm4u</tt>”) using the public IP address.<br />
<br />
Images:<br />
<br />
* US1604<br />
<br />
Descriptors:<br />
<br />
* ubuntu_1iface_userosm_vnf<br />
* test6a_ns<br />
<br />
= Test 6b. Assignment of public IP addresses to management interfaces of multi-interface VNFs =<br />
Objective:<br />
<br />
* Testing the assignment of IP addresses from a pool to VNF management interfaces in the case of multi-interface VNFs. The intention is to check that a single default route is injected.<br />
<br />
Prerequisites:<br />
<br />
* Configure the VIM to allow the dynamic assignment of public addresses from a pool<br />
* Configure a VIM network (e.g. “public”) to use the appropriate pool, to allow external access via “public” IP addresses.<br />
* Configure the datacenter in the RO to assign public IP addresses to VNF management interfaces (use_floating_ip: true)<br />
<br />
Steps:<br />
<br />
* Onboard and deploy a NS consisting of 2 Ubuntu VNFs interconnected by two networks (management and data).<br />
* Instantiate the NS via UI, specifying that the NS network “mgmt” must be mapped to the VIM network name “public”, so that a “public” IP address will be assigned from the pool.<br />
* Check that the UI reports a successful deployment.<br />
* Connect to each VNF via SSH (user: “<tt>osm</tt>”, pwd: “<tt>osm4u</tt>”) using the public IP address.<br />
<br />
Images:<br />
<br />
* US1604<br />
<br />
Descriptors:<br />
<br />
* ubuntu_2ifaces_vnf<br />
* test6b_ns<br />
<br />
= Test 6c. Assignment of public IP addresses to management interfaces of multi-interface VNFs even when IP profiles are used =<br />
Objective:<br />
<br />
* Testing the assignment of IP addresses from a pool to VNF management interfaces in the case of multi-interface VNFs even when IP profiles are used. The intention is to check again that a single default route is injected and that IP profiles do not affect that single route.<br />
<br />
Prerequisites:<br />
<br />
* Configure the VIM to allow the dynamic assignment of public addresses from a pool<br />
* Configure a VIM network (e.g. “public”) to use the appropriate pool, to allow external access via “public” IP addresses.<br />
* Configure the datacenter in the RO to assign public IP addresses to VNF management interfaces (use_floating_ip: true)<br />
<br />
Steps:<br />
<br />
* Onboard and deploy the NS used in Test 3c, consisting of a star topology, with 1 VNF in the middle and 5 instances of the other VNF connected to that one (+ the corresponding management interfaces), where all the inter-VNF networks have an IP profile so that DHCP is enabled, but with no default gateway.<br />
* Instantiate the NS via UI, specifying that the NS network “mgmt” must be mapped to the VIM network name “public”, so that a “public” IP address will be assigned from the pool. This is the only change with respect to Test 3c.<br />
* Check that the UI reports a successful deployment.<br />
* Connect to each VNF via SSH (user: “<tt>osm</tt>”, pwd: “<tt>osm4u</tt>”) using the public IP address.<br />
<br />
Images:<br />
<br />
* US1604<br />
<br />
Descriptors:<br />
<br />
* ubuntu_2ifaces_vnf<br />
* ubuntu_6ifaces_vnf<br />
* test3c_ns<br />
<br />
= Test 7a. EPA tests - phase 1 =<br />
Objectives:<br />
<br />
* Testing that the VIM can map properly vCPUs to pairs of physical HW threads<br />
* Testing that the VIM can assign hugepages memory<br />
* Testing that the VIM can assign SRIOV interfaces<br />
* Testing that the order of interfaces is correct<br />
<br />
Steps:<br />
<br />
* Onboard pktgen_4psriov VNF, which requires:<br />
** CPU pinning of paired threads<br />
** Hugepages<br />
** SRIOV interfaces<br />
* Onboard a NS with 5 instances of pktgen_4psriov, in a star topology, with one of the VNFs in the middle (Emitter) and 4 VNFs attached (Receiver1-4).<br />
* Check that all VNFs are accessible by SSH via mgmt interface (user: "pktgen", pwd: "pktgen")<br />
* Check (at the VIM or the host) that the CPU pinning is correct.<br />
* Check (at the VIM or the host) that hugepages have been assigned to the guest.<br />
* Check with pktgen that the interfaces are correctly attached to SRIOV interfaces and in the right order:<br />
** Emitter port 0 -> Receiver1 port 0<br />
** Emitter port 1 -> Receiver2 port 1<br />
** Emitter port 2 -> Receiver3 port 2<br />
** Emitter port 3 -> Receiver4 port 3<br />
<br />
Images:<br />
<br />
* pktgen<br />
<br />
Descriptors:<br />
<br />
* pktgen_4psriov_vnfd<br />
* test7a_ns<br />
<br />
= Test 7b. EPA tests - phase 2 =<br />
Objectives:<br />
<br />
* Testing that the VIM can map properly vCPUs to physical cores<br />
* Testing that the VIM can assign passthrough interfaces<br />
* Testing that the order of interfaces is correct<br />
<br />
Steps:<br />
<br />
* Equivalent to the previous test, but using a variant to the NS which requires:<br />
** Full cores (instead of HW threads)<br />
** Passthrough interfaces (instead of SR-IOV)<br />
<br />
Images:<br />
<br />
* pktgen<br />
<br />
Descriptors:<br />
<br />
* pktgen_4ppassthrough_vnfd<br />
* test7b_ns</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Developer_HowTo_for_RO_Module&diff=6110Developer HowTo for RO Module2021-02-17T17:22:30Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM Developer Guide has been moved to a new location: '''https://osm.etsi.org/docs/developer-guide/'''<br />
<br />
---<br />
<br />
==Getting Started==<br />
The RO Module of OSM is implemented by openmano. The recommended Linux distribution for development is Ubuntu 16.04 LTS Server. PyCharm is a nice and easy to use tool for development and debugging.<br />
<br />
The step [[Release_1_Installation]] installs all OSM modules in containers. However, for development, a virtual machine may be more suitable. To install the openmano module you can run a script that installs the required packages, clone the project from ''git clones https://osm.etsi.org/gerrit/osm/RO'' and configures openmano client and other utility scripts at path<br />
wget -O install-openmano.sh "https://osm.etsi.org/gitweb/?p=osm/RO.git;a=blob_plain;f=scripts/install-openmano.sh"<br />
chmod +x install-openmano.sh<br />
sudo ./install-openmano.sh -q --develop #-h for help<br />
<br />
See also and follow [[Workflow_with_OSM_tools#Clone_your_project]]<br />
<br />
New code features must be incorporated to master:<br />
git checkout master<br />
Generate a ".gitignore", you can use the ''.gitignore-common'' example that skips PyCharm and Eclipse files<br />
cp RO/.gitignore-common RO/.gitignore<br />
#edit to include your local files to ignore<br />
Prepare your git environment to push with a proper user/email, push to gerrit. See and configure:<br />
<p>[[Workflow_with_OSM_tools#Configure_your_Git_environment]]</p><br />
<p>[[Workflow_with_OSM_tools#Commit_changes_to_your_local_project]]</p><br />
<p>[[ Workflow_with_OSM_tools#Push_your_contribution_to_Gerrit]]</p><br />
<br />
==Programming Language==<br />
The RO module uses Python2. However Python3 conventions for a future migration must be used as far as possible. For example:<br />
<br />
{| class="wikitable"<br />
|-<br />
! BAD Python2<br />
! OK Python2 compatible with python3<br />
|-<br />
| "format test string %s number %d" % (st, num)<br />
| "format test string {} number {}".format(st, num)<br />
|-<br />
| print a, b, c<br />
| print(a,b,c)<br />
|-<br />
| except Exception, e<br />
| except Exception as e<br />
|-<br />
| if type(x) == X:<br />
| if isinstance(x,X):<br />
|}<br />
<br />
In addition, '''DO NOT USE libraries not compatible with python3'''<br />
<br />
Descriptors can be YAML (prefered because more readable and allow comments) or JSON<br />
<br />
==Code Style==<br />
Please follow PEP8 style guide for all the Python code. Lines up to 120 length<br />
<br />
===Logging===<br />
Use the appropriate logging levels when logging the messages. An example is shown below:<br />
self.logger.debug("Changing state to %s", next_state)<br />
<br />
Logging levels (general and per module) are specified at '''openmanod.cfg'''<br />
<br />
Try to use few useful logs, not verbose, that brings useful information. For example, in case of fail getting a server, the complete URL should be provided.<br />
<br />
Avoid several logs together<br />
<br />
WRONG:<br />
self.looger.debug("Entering in method A")<br />
self.logger.debug("Contacting server"<br />
<br />
RIGHT:<br />
self.logger.debug("method A, contacting server %s", url)<br />
<br />
<br />
When the traceback is needed(call stack that generate the exception) , use the "exc_info=True" parameter<br />
self.logger.error("Exception %s when ...", exception, exc_info=True)<br />
<br />
===Exceptions===<br />
Code must be wrote in a way that functions and methods raise an exception when something goes wrong, instead of returning a negative or false value.<br />
<br />
Example<br />
WRONG<br />
def get_ip_address():<br />
...<br />
if fail:<br />
return False, "Fail because xxx"<br />
return True, ip<br />
<br />
...<br />
result, ip = get_ip_address()<br />
if not result:<br />
return False, "Cannot get ip address..."<br />
<br />
<br />
<br />
RIGHT<br />
def get_ip_address():<br />
...<br />
if fail:<br />
raise customException("Fail because ...")<br />
return ip<br />
<br />
...<br />
try:<br />
ip = get_ip_address()<br />
...<br />
except customException as e:<br />
raise customException2(str(e))<br />
<br />
==Directory Organization==<br />
The code organized into the following high level directories: <br><br />
* '''/''' contains the entry server file ''openmanod'' and client ''openmano'' code <br><br />
* '''/osm_ro''' contains the RO server code files <br><br />
* '''/test''' contains scripts and code for testing <br><br />
* '''/database_utils''' contains scripts for database creation, dumping and migration <br><br />
* '''/scripts''' general scripts, as installation, execution, reporting <br><br />
* '''/scenarios''' examples and templates of network scnario descriptors <br><br />
* '''/vnfs''' examples and templates of VNF descriptors <br><br />
<br />
==RO Architecture==<br />
[[File:OpenmanoArchitecture.png|400px]]<br />
<br />
===RO Server modules===<br />
The RO module contains the following modules<br />
* '''openmanod''' is the main program. It reads the configuration file (openmanod.cfg) and execute the httpserver and wait for the end<br />
* '''httpserver.py''' is a thread that implements the northbound API interface, uses python bottle module. Calls main engine methods to perform the tasks<br />
* '''nfvo.py''' is the main engine, implementing all the methods for the creation, deletion and management of vnfs, scenarios and instances. Operations against a VIM are asynchornous. ACTIONs to be done are stored at database before returning ok to the client<br />
* '''nfvo_db.py''' is the module in charge of database operations. Uses base '''db_base.py'''. Database is managed with MySQLdb python library<br />
* '''openmano_schemas.py''' is a dictionary schemas used to validate API request and response content using jsonschema library<br />
* '''vim_thread.py''' There is a thread per VIM and credentials. It performs basic tasks of creating/deleting VM, networks, flavors, etc. In addition it refreshes the VM and network status. It calls vimconn.py methods <br />
* '''vimconn.py''' is the base class for the VIM plugin. It contains the definition of the methods to be implemented. The inherited '''vimconn_openstack.py''', '''vimconn_openvim.py''', '''vimconn_vmware''' and '''vimconn_aws''' implements the operations against the concrete VIM type. OpenStack plugin uses the python-*client libraries, meanwhile Openvim plugin uses direct http requests.<br />
* '''console_proxy_thread.py''' is a thread that implements a TCP/IP proxy for the console access to a VIM<br />
<br />
===RO Client modules===<br />
Other modules not part of the server are:<br />
* '''openmano''' is a CLI client<br />
* '''openmanoclient.py''' is a client python library for managing openmano server<br />
<br />
===ACTIONS and TASKS===<br />
ACTIONS are a a group of tasks performed against a a concrete instance-scenarios (NS record). The creation and deletion of the instance-scenario itself is an action. As it is asynchonous, NBI returns an "Action_id" that can be used to check the status. For each action, nfvo.py generates individual tasks for the related VIMs. Tasks are both stored at database and sent to the related vim_thread.py. A task has a concrete relation with a VIM, e.g. create/delete a VM, a network, ... look for a flavor, network, ...<br />
<br />
===Database content===<br />
TODO<br />
<br />
==Database changes==<br />
Database schema can be changed if needed. It is recomended to use a graphical tool (e.g. Heidy) to change database and change it back and copy the SQL commands. Make these steps:<br />
<br />
1. openmanod: increment __version__, version_date and database_version<br />
<br />
2. database_utils/migrate_mano_db.sh. See the three "TODO"<br />
<br />
2a. Increment LAST_DB_VERSION<br />
<br />
2b. Annotate a comment to have a track of versions: [ $OPENMANO_VER_NUM -ge 50XX ] && DB_VERSION=XX #0.5.XX => XX<br />
<br />
2c. Generate new methods; function upgrade_to_XX() and function downgrade_from_XX. Insert here the sql commands. Last sql command over schema_version is quite important to detect the database version.<br />
<br />
Test several upgrades/downgrades to version 20 with "migrate_mano_db.sh" and "migrate_mano_db.sh 20"<br />
<br />
==Package dependency osm-im==<br />
It is under IM repository. It contains the OSM models. Used models at RO are under <IM>/models/yang/vnfd.yang and <IM>/models/yang/nsd.yang. More modules will be incorporated in the future.<br />
<br />
When IM is maked, pyangbind generates python source files imported at RO. They are used to validate and load a yaml/json VNFD and NSD catalog descriptor.<br />
<br />
Method pybindJSONDecoder.load_ietf_json from pyangbind is used to parse and load the descriptor. A structure of nested YANG classes are generated and used at <RO>/osm_ro/nfvo.py methods new_vnfd_v3 and new_nsd_v3. RO supports backward compatibility with old format descriptors. NBI (osm_ro/httpserver.py) uses .../v3/... at URL to diferenciate between old and new descriptors. CLI (openmano) detects automatically if the descriptor is in old format or in OSM format to send the request to the server using the old URL or the new "v3" URL<br />
<br />
===Installation===<br />
The OSM binary installation install this package. In case of needed you can install/update it manually by:<br />
<br />
apt-get update<br />
apt-get install make git python python-pip tox debhelper python-bitarray python-lxml<br />
pip install --upgrade pip<br />
# If not inside a container. Use "sudo -HE" to get root privileges for pip installation<br />
pip install pyangbind stdeb<br />
git clone https://osm.etsi.org/gerrit/osm/IM<br />
make -C IM clean all<br />
dpkg -i IM/deb_dist/python-pyang_*.deb<br />
dpkg -i IM/deb_dist/python-pyangbind_*.deb<br />
dpkg -i IM/deb_dist/python-osm-im_*.deb<br />
# Use this line to check if it is installed and where <br />
python -c 'import osm_im; print osm_im.__path__[0]'<br />
<br />
==Package dependency lib-osm-openvim==<br />
<br />
It is under openvim repository. RO uses a library for the SDN assist that is in charge of performing the underlay dataplane connectivity using an openflow controller. osm-openvim and lib-osm-openvim are diffent, though they share same pieces of code. lib-osm-openvim uses a different database name (mano_vim_db) so that openvim can be installed in the same virtual machine or container (openvim uses vim_db database name) <br />
<br />
TODO complete where RO uses it<br />
<br />
===Installation===<br />
The OSM binary installation install this package. In case of needed you can install/update it manually by:<br />
<br />
apt-get update<br />
apt-get install make git python tox libmysqlclient-dev<br />
git clone https://osm.etsi.org/gerrit/osm/openvim<br />
git -C openvim checkout 005a9dc # this is temporal, because last version contains error at Makefile<br />
make -C openvim lite<br />
# Use this line to check if it is installed and where <br />
python -c 'import lib_osm_openvim; print lib_osm_openvim.__path__[0]'<br />
# Install database of ovim library<br />
OSMLIBOVIM_PATH=`python -c 'import lib_osm_openvim; print lib_osm_openvim.__path__[0]'`<br />
# -U and -P are the admin database user/password. Normally "-U root" without password "executed as root"<br />
${OSMLIBOVIM_PATH}/database_utils/install-db-server.sh -U root [-P passwd] -u mano -p manopw -d mano_vim_db --updatedb<br />
<br />
==CLI client==<br />
<br />
The RO code contains a python CLI (openmano) that allows friently command execution. This CLI client can run on a separate machine where openmano server is running. "openmano config" indicates where the server is (by default localhost)<br />
<br />
==Northbound Interface==<br />
<br />
The RO uses a REST API with YAML/JSON content. The primitives are explained [[RO Northbound Interface|here]]<br />
<br />
==Running Unit Tests==<br />
<br />
===Launching RO===<br />
Openmano can run as systemd service. (Can be installed with '''./scripts/install-openmano-service.sh -f RO''')<br />
<br />
Or can be run inside a screen (the prefered method for developpers). The script to easily launch/remove is '''./scripts/service-openmano.sh'''. Execute with -h to see options<br />
<br />
Note that the general OSM install script, installs openmano inside a container and code run at folder /opt/openmano (instead of $HOME/openmano)<br />
<br />
===Tests===<br />
Many of openmano operations rely on an external VIM. Without external infraestructure it is recomended to use openvim in "test" (fake) mode. Install it in the same machine where openmano is located with [[OpenVIM_installation_(Release_One)#Installation]]<br />
<br />
Run ''./test/basictest'' for a initial test. Type -h to see options. For testing using openvim just run <pre> . ./test/basictest.sh --force --screen --init-openvim </pre><br />
<br />
==Creating a new VIM plugin==<br />
<br />
Choose a name, eg. XXX<br />
<br />
Create a new python module vimconn_XXX.py derived from vimconn.py class. Implement the relevant functions. You have several connectors already created to be used as example as openstack and openvim. Openstack connector uses the python openstack client libraries, meanwhile openvim connector uses direct http requests.<br />
<br />
DO NOT change the method names, parameters or parameter content. RO uses the same methods for all the VIMs and they cannot be changed to accomodate VIM specifics. VIM specifics must be solved inside the connector.<br />
<br />
The new module can need specific configuration for the VIM that it is passed as a dictionary in the ''config'' variable at constructor. For example, in the case of openstack, ''config'' variable is used for: enabling/disabling port_security_enable, specifying the name of the physical network used for dataplane, regions, etc. The ''config'' variable is the right place to specify those needed parameters not provided by RO at the methods that form part of the VIM configuration. See [[Openstack configuration#Add openstack to OSM]] and [[Configuring AWS for OSM Release TWO#Add AWS to OSM]] for examples <br />
<br />
For integration with the main project, it is needed to add the new vim type to dictionary "vim_module" at file "osm_ro/vim_thread.py".<br />
<br />
openmano tenant-create osm # if not already done<br />
export OPENMANO_TENANT=osm<br />
openmano datacenter-create <vim-name> <access-URL> --type=XXX --config <specific config><br />
# if fails the cause can be a library you need not installed or an error upon importing. Try tho import it in a python client<br />
# example of <specific config> text: "{dataplane_physical_net: physnet_sriov, port_security_enabled: False}"<br />
openmano datacenter-attach <vim-name> --vim-tenant-name=<tenant-to-use-by-openmano> --user=<tenant-user> --password=<tenant-password><br />
<br />
You can test it using the '''test/test_RO.py''' file:<br />
# Create manually an image <image> and a management network <net-mgmt> at your VIM<br />
./test/test_RO.py deploy --help<br />
# e.g. ./test/test_RO.py deploy -n <net-mgmt> -t osm -i <image> -d <vim-name> --timeout=30 --test simple_linux,simple_multi_vnfc,simple_2_vnf<br />
./test/test_RO.py vimconn --help<br />
<br />
To be able to run the '''test/test_RO.py''' script, you need to do some changes. First in the class "''vim_connector''" you need to import the plugin of the new vim:<br />
<br />
def test_vimconnector(args):<br />
global test_config<br />
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + "/osm_ro")<br />
test_config['vimtype'] = args.vimtype<br />
if args.vimtype == "aws":<br />
import vimconn_aws as vim<br />
<br />
And also,some tests are depending on the vim, you you would need to look for the following chain: ''''test_config['vimtype'] =='''' and place the code for the call to your vim there. For instance:<br />
<br />
def test_000_connect(self):<br />
self.__class__.test_text = "{}.{}. TEST {}".format(test_config["test_number"],<br />
self.__class__.test_index,<br />
inspect.currentframe().f_code.co_name)<br />
<br />
self.__class__.test_index += 1<br />
if '''test_config['vimtype'] == 'vmware':'''<br />
vca_object = test_config["vim_conn"].connect()<br />
logger.debug("{}".format(vca_object))<br />
self.assertIsNotNone(vca_object)<br />
elif '''test_config['vimtype'] == 'openstack':'''<br />
test_config["vim_conn"]._reload_connection()<br />
network_list = test_config["vim_conn"].get_network_list()<br />
logger.debug("{}".format(network_list))<br />
self.assertIsNotNone(network_list)<br />
<br />
The script could be used to launch tests against the vim connector directly with the following syntax:<br />
<br />
python ./test/test_RO.py vimconn --vimtype XXX -t <VIM_TENANT_NAME> -u <VIM_AUTH_URL> -c '{user: <VIM_USER_NAME>, passwd: <VIM_USER_PASSWORD>}' --test <TEST_NAME><br />
<br />
Next you can find the tests that could be executed:<br />
<br />
test_vimconn_connect<br />
test_vimconn_delete_network<br />
test_vimconn_get_image_list<br />
test_vimconn_get_network<br />
test_vimconn_new_flavor<br />
test_vimconn_new_network<br />
test_vimconn_new_vminstance<br />
<br />
Also, the script could be used to launch tests against the RO with the following syntax:<br />
<br />
python ./test/test_RO.py deploy -d <VIM_ACCOUNT_NAME> -n <MGMT_NET_IN_VIM> -i <IMAGE_FOR_VMs> --tests <TEST_NAME><br />
<br />
Next you can find the tests that could be executed:<br />
<br />
v3_2vdu_set_ip_mac<br />
simple_multi_vnfc<br />
simple_linux</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Developer_HowTo&diff=6109Developer HowTo2021-02-17T17:20:23Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM Developer Guide has been moved to a new location: '''https://osm.etsi.org/docs/developer-guide/'''<br />
<br />
---<br />
<br />
The aim of this entry is to provide a guide for developers to set up their environment, in order to ease the development with the different OSM modules.<br />
==Introduction==<br />
<br />
Modules run in separate docker containers (except juju controller that uses a lxd container). Current installation uses Docker Swarm by default (there are Kubernetes distributions and an incoming option for installing on Kubernetes). The modules are:<br />
<br />
* '''kafka''': Provides a Kafka bus used for OSM communication. This module relies on ''zookeeper''.<br />
* '''zookeeper''': Used by ''kafka''.<br />
* '''nbi''': North Bound Interface of OSM. Restful server that follows ETSI SOL005 interface. Relies on ''mongo'' database and ''kafka'' bus. For authentication it can optionally uses ''keystone''.<br />
* '''keystone''': Used optionally for NBI authentication and RBAC. It stores the users, projects and role permissions. It relies on ''mysql''.<br />
* '''lcm''': Provides the Live Cycle Management. It uses ''ro'' for resource orchestration and juju for configuration. It relies also on ''mongo''.<br />
* '''ro''': Makes the Resource Orchestration, or VIM deployment. Relies on ''mysql''.<br />
* '''light-ui''': Web user interface. It communicates with ''nbi''.<br />
* '''mon''': Performs OSM monitoring. Relies on ''mongo'' and ''mysql''.<br />
* '''mongo''': Common non relational database for OSM modules.<br />
* '''mysql''': Relational database server used for ''ro'', ''keystone'', ''mon'' and ''pol''.<br />
* '''pol''': Policy Manager for OSM.<br />
* '''prometheus''': for monitoring .<br />
<br />
<br />
In addition LCM and NBI, shares a common file system where packages are stored. In current installation it uses a shared docker volume called ''osm_package''.<br />
<br />
This picture shows the modules with the port that they export, their relationships with the name of env variables that control them. For clarity not all the dependencies are depicted, as kafka, mysql, ... <br />
<br />
<pre><br />
__________ ________<br />
| | | |<br />
| light-ui |OSM_SERVER _______ |keystone|<br />
| :80 |----------------------> | |-------------------------> |:5000 |<br />
|__________| | nbi | |________|<br />
OSMNBI_STORAGE_PATH| :9999 |OSMNBI_DATABASE_HOST _______ <br />
.............. <--------------------|_______|-------------------------> | |<br />
. volume: . | |<br />
. osm_osm_ . | mongo |<br />
. packages . OSMLCM_STORAGE_PATH _______ OSMLCM_DATABASE_HOST | :27017|<br />
.............. <--------------------| |-------------------------> |_______|<br />
| lcm |<br />
************** OSMLCM_VCA_HOST| |OSMLCM_RO_HOST<br />
* lxd: juju * <--------------------|_______|--------------|<br />
* controller * |<br />
************** _______ | _______<br />
| | <------------- | |<br />
| ro | | mysql | <br />
| :9090 |RO_DB_HOST | :3306 |<br />
|_______|-------------------------> |_______|<br />
<br />
_______ _______ _______ _________<br />
| | | | | | | |<br />
| mon | | pm | | kafka |KAFKA_ZOOKEEPER_CONNECT |zookeeper| <br />
| :8662 | | | | :9092 |-------------------------> | :2181 | <br />
|_______| |_______| |_______| |_________|<br />
<br />
</pre><br />
<br />
For debugging it is convenient running the target module directly at host maintaining the rest of dependent modules in containers. In the following sections it is described how to achieve that.<br />
<br />
==General steps==<br />
=== 1 Shutdown the container you want to debug===<br />
<br />
First thing, you need to stop the module you want to debug. As OSM uses a docker service do not manually stop the container because it will be automatically relaunched again. Scale it to 0 for stopping and to 1 for running again. <br />
<br />
docker service scale osm_lcm=0<br />
<br />
=== 2 Clone the module===<br />
<br />
git clone https://osm.etsi.org/gerrit/osm/LCM<br />
<br />
=== 3 Install the module===<br />
<br />
Inside the folder where the module is cloned type the following command:<br />
<br />
pip3 install -e . # try with --user if get permission errors<br />
<br />
<br />
'''Note''': pip3 can be installed with 'sudo apt-get install python3-pip' <br />
<br />
'''Note''': it is recomended pip3 version 9.0.3. Check version with 'pip3 --version' and fix it if needed with 'pip3 install pip==9.0.3'<br />
<br />
=== 4 Setup the IDE===<br />
<br />
For this tutorial we will use PyCharm as IDE. First thing, we will set "Python3" as default python interpreter:<br />
<br />
[[File:PythonInterpreter.jpg|500px|top]]<br />
<br />
Next we will configure a new debug environment. For that we will go to the "Run" tab "Edit configurations". In the new window that appears we will need to configure the script and the environment parameters.<br />
<br />
[[File:PyCharmConfiguration.jpg|600px]]<br />
<br />
=== 5 Configure it to interact with other modules===<br />
<br />
You need to feed the IP addresses of the modules it is going to communicate to. For that, you can use your "/etc/hosts" file.<br />
<br />
In case the module under development is running in the same server where the rest of the modules are located, use "127.0.0.1" (localhost) as the IP address of those modules. For instance, in the following example we have added mongo, ro and kafka to the line containing "127.0.0.1":<br />
<br />
127.0.0.1 localhost mongo ro kafka nbi ro-db<br />
<br />
In case the module under development is running in a different server from the rest of modules, you will need to provide the IP address of that server. For instance, in the following example we have added a new line with the name resolution for mongo ro and kafka to IP address "a.b.c.d":<br />
<br />
a.b.c.d mongo ro kafka nbi ro-db<br />
<br />
=== 6 Install needed packages===<br />
<br />
Is it possible that you will need to install some additional packages in your server. If needed use the commands "pip3 install" or "apt-get install" for that.<br />
<br />
Some modules imports another modules from OSM. The modules needed are:<br />
n2vc: git clone https://osm.etsi.org/gerrit/osm/N2VC<br />
common: git clone https://osm.etsi.org/gerrit/osm/common<br />
IM: git clone https://osm.etsi.org/gerrit/osm/IM<br />
<br />
Install them with <br />
pip3 install -e common --user # needed for LCM, NBI<br />
pip3 install -e N2VC --user # needed for LCM<br />
pip3 install -e IM --user # needed for NBI<br />
<br />
=== 7 Expose needed ports of docker services===<br />
<br />
To expose '''mongo''' database (service osm_mongo), needed for NBI, LCM, MON:<br />
docker service update osm_mongo --publish-add 27017:27017<br />
#NOTE: Not sure if this is persistent upon reboot<br />
# check exposed ports by:<br />
docker service list<br />
<br />
Alternativelly you can modify the docker osm stack by editing file '/etc/osm/docker/docker-compose.yaml', adding/uncommenting the exposed ports; and restart the stack:<br />
sudo vi /etc/osm/docker/docker-compose.yaml<br />
# add/uncomment at section mongo:<br />
# ports:<br />
# - "27017:27017"<br />
docker stack rm osm && sleep 60<br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
# make again the service scale to 0 of step 1 in this section<br />
<br />
Similarly, '''ro-db''' (service osm_ro-db) needed for RO, uses ports "3306:3306"<br />
<br />
... And , '''kafka''' (service osm_kafka) needed for LCM, NBI uses ports "9092:9092". Note: for kafka sometimes this is not enough and other modules has errrors connecting to kafka controller. If this is the case modify docker-compose adding kafka bus and relaunch service<br />
<br />
==NBI==<br />
<br />
Install needed OSM packages IM, common:<br />
# osm_im:<br />
# Install Information Model vnfd.py and nsd.py files for pyangbind validation at e.g. parent folder where NBI is cloned<br />
pip3 install pyang<br />
git clone https://github.com/robshakir/pyangbind<br />
pip3 install -e pyangbind<br />
git clone https://osm.etsi.org/gerrit/osm/IM<br />
mkdir IM/osm_im<br />
cd IM/models/yang<br />
wget -q https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-yang-types%402013-07-15.yang -O ./ietf-yang-types.yang<br />
wget -q https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-inet-types%402013-07-15.yang -O ./ietf-inet-types.yang<br />
pyang --plugindir ../../../pyangbind/pyangbind/plugin -f pybind -o ../../osm_im/vnfd.py vnfd.yang<br />
pyang --plugindir ../../../pyangbind/pyangbind/plugin -f pybind -o ../../osm_im/nsd.py nsd.yang<br />
pyang --plugindir ../../../pyangbind/pyangbind/plugin -f pybind -o ../../osm_im/nst.py nst.yang<br />
cd ../../..<br />
pip3 install -e IM<br />
# osm_common:<br />
git clone https://osm.etsi.org/gerrit/osm/common<br />
pip3 install -e common # try with --user if get permission errors<br />
# pip3 install aiokafka==0.4.* pymongo==3.7.* pycrypto pyyaml==3.*<br />
<br />
Change docker service '''mongo''' and '''kafka''' to expose ports. See [[Developer_HowTo#7 Expose needed ports of docker services]]<br />
<br />
Additionally you may want that docker 'light-ui' uses your local copy of NBI by one of:<br />
* Edit again file '/etc/osm/docker/docker-compose.yaml', and set at 'light-ui' section the required IP address from docker to the VM:<br />
OSM_SERVER: <172.17.0.1> # nbi<br />
# Get the needed address at your setup by 'ip a | grep docker0'<br />
* ... Or update light-ui docker service (not persistent on reboot):<br />
docker service update osm_light-ui --force --env-add "OSM_SERVER=172.17.0.1"<br />
# Get the needed address at your setup by 'ip a | grep docker0'<br />
<br />
Clone and install needed NBI packages <br />
docker service scale osm_nbi=0<br />
git clone https://osm.etsi.org/gerrit/osm/NBI<br />
# configure gerrit commit-msg hook<br />
curl -Lo NBI/.git/hooks/commit-msg http://osm.etsi.org/gerrit/tools/hooks/commit-msg<br />
chmod u+x NBI/.git/hooks/commit-msg<br />
cp NBI/.gitignore-common NBI/.gitignore<br />
pip3 install -e NBI # try with --user if get permission errors<br />
# sudo apt-get install python3-keystoneclient<br />
# pip3 install cherrypy==18.0.0 pyyaml==3.* keystoneauth1<br />
<br />
Python interpreter: Python3<br />
Script: $INSTALLATION_FOLDER/NBI/osm_nbi/nbi.py<br />
<br />
Environment variables:<br />
* OSMNBI_DATABASE_COMMONKEY: must be the same value used by NBI. Get it with 'cat /etc/osm/docker/nbi.env'<br />
* OSMNBI_STORAGE_PATH: Path of the docker volume for filestorage. Both LCM and NBI must share the same path. You can either:<br />
** Create a folder and debug both NBI and LCM at the same time (needed if you develop in a different server than OSM); or<br />
** Use the docker volume. Discover local path (Mountpoint) with 'docker volume inspect osm_osm_packages' and grant write permissions to pycharm on it with (path can be different at your envioron) 'sudo chmod o+rx /var/lib/docker /var/lib/docker/volumes; sudo chmod -R o+w /var/lib/docker/volumes/osm_osm_packages/_data' <br />
* OSMNBI_DATABASE_HOST: Mongo IP in case host 'mongo' is not at "/etc/hosts" file<br />
* OSMNBI_STATIC_DIR: <Absolute path of NBI>/osm_nbi/html_public<br />
<br />
==LCM==<br />
<br />
Install needed OSM packages if not done:<br />
# N2VC:<br />
git clone https://osm.etsi.org/gerrit/osm/N2VC<br />
pip3 install -e N2VC # try with --user if get permission errors<br />
<br />
# osm_common:<br />
git clone https://osm.etsi.org/gerrit/osm/common<br />
pip3 install -e common # try with --user if get permission errors<br />
<br />
Change docker service '''mongo''' and '''kafka''' to expose ports. See [[Developer_HowTo#7 Expose needed ports of docker services]]<br />
<br />
Cone and install LCM depencencies<br />
docker service scale osm_lcm=0<br />
git clone https://osm.etsi.org/gerrit/osm/LCM<br />
# configure gerrit commit-msg hook<br />
curl -Lo LCM/.git/hooks/commit-msg http://osm.etsi.org/gerrit/tools/hooks/commit-msg<br />
chmod u+x LCM/.git/hooks/commit-msg<br />
cp LCM/.gitignore-common LCM/.gitignore<br />
pip3 install -e LCM # try with --user if get permission errors<br />
<br />
Python interpreter: Python3<br />
Script: $INSTALLATION_FOLDER/LCM/osm_lcm/lcm.py<br />
<br />
Environment variables:<br />
<br />
Values are stored at '/etc/osm/docker/lcm.env' but here it is explained how to obtain these values.<br />
* OSMLCM_DATABASE_COMMONKEY: must be the same value used by NBI. Get it with 'cat /etc/osm/docker/lcm.env'<br />
* OSMLCM_STORAGE_PATH: Path of the docker volume for filestorage. Both LCM and NBI must share the same path. You can either:<br />
** Create a folder and debug both NBI and LCM at the same time (needed if you develop in a different server than OSM); or<br />
** Use the docker volume. Discover local path (Mountpoint) with 'docker volume inspect osm_osm_packages' and grant read permissions to pycharm on it with (path can be different at your envioron) 'sudo chmod o+rx /var/lib/docker /var/lib/docker/volumes' <br />
* OSMLCM_DATABASE_HOST: Mongo IP in case 'mongo' host it is not at "/etc/hosts" file. See [[Developer_HowTo#5 Configure it to interact with other modules]]<br />
* OSMLCM_RO_HOST: RO IP in case 'ro' host it is not at "/etc/hosts" file<br />
* OSMLCM_VCA_CACERT: To get this value run the following command in the OSM host:<br />
** juju controllers --format json | jq -r '.controllers["osm"]["ca-cert"]'<br />
* OSMLCM_VCA_PUBKEY: To get this value run the following command in the OSM host:<br />
** cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub<br />
* OSMLCM_VCA_SECRET: To get this value run the following command in the OSM host:<br />
** grep password /home/ubuntu/.local/share/juju/accounts.yaml |awk '{print $2}'<br />
* OSMLCM_VCA_HOST: Will be different depending on where your develop environment is running:<br />
** In case you run it in the same server as OSM use the following command to get the IP (<VCA_IP>):<br />
*** juju show-controller|grep api-endpoints|awk -F\' '{print $2}'|awk -F\: '{print $1}'<br />
** In case you use a different server than OSM use the IP address of OSM host (<OSM_IP>). But in addition you need to redirect inside the OSM host, the port 17070 to the VCA container by one of:<br />
*** Configure the following ip-table rule in OSM host (not persistent on reboot):<br />
**** sudo iptables -t nat -A PREROUTING -p tcp -d <OSM_IP> --dport 17070 -j DNAT --to <VCA_IP>:17070<br />
*** or creates a ssh tunnel inside OSM host (just temporal until session is closed):<br />
**** ssh -L 0.0.0.0:17070:<VCA_IP>:17070 root@<VCA_IP><br />
* OSMLCM_GLOBAL_LOGLEVEL: DEBUG<br />
<br />
==RO==<br />
<br />
It is needed to edit the docker service in order to expose the database port for the 'mysql' container. Edit file '/etc/osm/docker/docker-compose.yaml' (recomended to make a backup copy), and uncomment at 'mysql' section the following two lines:<br />
ports:<br />
- "3306:3306"<br />
Additionally you may want that docker 'lcm' uses your local copy of RO. Edit again file '/etc/osm/docker/docker-compose.yaml', and set at 'lcm' section the required IP address from docker to the VM:<br />
OSMLCM_RO_HOST: <172.17.0.1> # ro<br />
# Get the needed address at your setup by 'ip a | grep docker0'<br />
<br />
<br />
Then, relaunch service:<br />
docker stack rm osm <br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
Remove docker service, clone code:<br />
<br />
docker service scale osm_ro=0<br />
# clone and configure gerrit commit-msg hook<br />
git clone https://osm.etsi.org/gerrit/osm/RO<br />
curl -Lo RO/.git/hooks/commit-msg http://osm.etsi.org/gerrit/tools/hooks/commit-msg<br />
chmod u+x RO/.git/hooks/commit-msg<br />
cp RO/.gitignore-common RO/.gitignore<br />
<br />
Install needed packages using its own installation script. Though it is not recomended, you can skip the '--no-db' option for installing a local database alternativelly to use the database at 'ro-db' container:<br />
sudo ./RO/scripts/install-openmano.sh --no-db --noclone --develop<br />
<br />
Python interpreter: Python2<br />
Script: $INSTALLATION_FOLDER/RO/openmanod<br />
<br />
Environment variables:<br />
* RO_DB_HOST, RO_DB_OVIM_HOST: localhost or <OSM_IP> depending if running on the same server or not. Not needed if alternativelly you use a local database copy.<br />
* RO_LOG_LEVEL: DEBUG</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Developer_HowTo&diff=6108Developer HowTo2021-02-17T17:19:45Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
The aim of this entry is to provide a guide for developers to set up their environment, in order to ease the development with the different OSM modules.<br />
==Introduction==<br />
<br />
Modules run in separate docker containers (except juju controller that uses a lxd container). Current installation uses Docker Swarm by default (there are Kubernetes distributions and an incoming option for installing on Kubernetes). The modules are:<br />
<br />
* '''kafka''': Provides a Kafka bus used for OSM communication. This module relies on ''zookeeper''.<br />
* '''zookeeper''': Used by ''kafka''.<br />
* '''nbi''': North Bound Interface of OSM. Restful server that follows ETSI SOL005 interface. Relies on ''mongo'' database and ''kafka'' bus. For authentication it can optionally uses ''keystone''.<br />
* '''keystone''': Used optionally for NBI authentication and RBAC. It stores the users, projects and role permissions. It relies on ''mysql''.<br />
* '''lcm''': Provides the Live Cycle Management. It uses ''ro'' for resource orchestration and juju for configuration. It relies also on ''mongo''.<br />
* '''ro''': Makes the Resource Orchestration, or VIM deployment. Relies on ''mysql''.<br />
* '''light-ui''': Web user interface. It communicates with ''nbi''.<br />
* '''mon''': Performs OSM monitoring. Relies on ''mongo'' and ''mysql''.<br />
* '''mongo''': Common non relational database for OSM modules.<br />
* '''mysql''': Relational database server used for ''ro'', ''keystone'', ''mon'' and ''pol''.<br />
* '''pol''': Policy Manager for OSM.<br />
* '''prometheus''': for monitoring .<br />
<br />
<br />
In addition LCM and NBI, shares a common file system where packages are stored. In current installation it uses a shared docker volume called ''osm_package''.<br />
<br />
This picture shows the modules with the port that they export, their relationships with the name of env variables that control them. For clarity not all the dependencies are depicted, as kafka, mysql, ... <br />
<br />
<pre><br />
__________ ________<br />
| | | |<br />
| light-ui |OSM_SERVER _______ |keystone|<br />
| :80 |----------------------> | |-------------------------> |:5000 |<br />
|__________| | nbi | |________|<br />
OSMNBI_STORAGE_PATH| :9999 |OSMNBI_DATABASE_HOST _______ <br />
.............. <--------------------|_______|-------------------------> | |<br />
. volume: . | |<br />
. osm_osm_ . | mongo |<br />
. packages . OSMLCM_STORAGE_PATH _______ OSMLCM_DATABASE_HOST | :27017|<br />
.............. <--------------------| |-------------------------> |_______|<br />
| lcm |<br />
************** OSMLCM_VCA_HOST| |OSMLCM_RO_HOST<br />
* lxd: juju * <--------------------|_______|--------------|<br />
* controller * |<br />
************** _______ | _______<br />
| | <------------- | |<br />
| ro | | mysql | <br />
| :9090 |RO_DB_HOST | :3306 |<br />
|_______|-------------------------> |_______|<br />
<br />
_______ _______ _______ _________<br />
| | | | | | | |<br />
| mon | | pm | | kafka |KAFKA_ZOOKEEPER_CONNECT |zookeeper| <br />
| :8662 | | | | :9092 |-------------------------> | :2181 | <br />
|_______| |_______| |_______| |_________|<br />
<br />
</pre><br />
<br />
For debugging it is convenient running the target module directly at host maintaining the rest of dependent modules in containers. In the following sections it is described how to achieve that.<br />
<br />
==General steps==<br />
=== 1 Shutdown the container you want to debug===<br />
<br />
First thing, you need to stop the module you want to debug. As OSM uses a docker service do not manually stop the container because it will be automatically relaunched again. Scale it to 0 for stopping and to 1 for running again. <br />
<br />
docker service scale osm_lcm=0<br />
<br />
=== 2 Clone the module===<br />
<br />
git clone https://osm.etsi.org/gerrit/osm/LCM<br />
<br />
=== 3 Install the module===<br />
<br />
Inside the folder where the module is cloned type the following command:<br />
<br />
pip3 install -e . # try with --user if get permission errors<br />
<br />
<br />
'''Note''': pip3 can be installed with 'sudo apt-get install python3-pip' <br />
<br />
'''Note''': it is recomended pip3 version 9.0.3. Check version with 'pip3 --version' and fix it if needed with 'pip3 install pip==9.0.3'<br />
<br />
=== 4 Setup the IDE===<br />
<br />
For this tutorial we will use PyCharm as IDE. First thing, we will set "Python3" as default python interpreter:<br />
<br />
[[File:PythonInterpreter.jpg|500px|top]]<br />
<br />
Next we will configure a new debug environment. For that we will go to the "Run" tab "Edit configurations". In the new window that appears we will need to configure the script and the environment parameters.<br />
<br />
[[File:PyCharmConfiguration.jpg|600px]]<br />
<br />
=== 5 Configure it to interact with other modules===<br />
<br />
You need to feed the IP addresses of the modules it is going to communicate to. For that, you can use your "/etc/hosts" file.<br />
<br />
In case the module under development is running in the same server where the rest of the modules are located, use "127.0.0.1" (localhost) as the IP address of those modules. For instance, in the following example we have added mongo, ro and kafka to the line containing "127.0.0.1":<br />
<br />
127.0.0.1 localhost mongo ro kafka nbi ro-db<br />
<br />
In case the module under development is running in a different server from the rest of modules, you will need to provide the IP address of that server. For instance, in the following example we have added a new line with the name resolution for mongo ro and kafka to IP address "a.b.c.d":<br />
<br />
a.b.c.d mongo ro kafka nbi ro-db<br />
<br />
=== 6 Install needed packages===<br />
<br />
Is it possible that you will need to install some additional packages in your server. If needed use the commands "pip3 install" or "apt-get install" for that.<br />
<br />
Some modules imports another modules from OSM. The modules needed are:<br />
n2vc: git clone https://osm.etsi.org/gerrit/osm/N2VC<br />
common: git clone https://osm.etsi.org/gerrit/osm/common<br />
IM: git clone https://osm.etsi.org/gerrit/osm/IM<br />
<br />
Install them with <br />
pip3 install -e common --user # needed for LCM, NBI<br />
pip3 install -e N2VC --user # needed for LCM<br />
pip3 install -e IM --user # needed for NBI<br />
<br />
=== 7 Expose needed ports of docker services===<br />
<br />
To expose '''mongo''' database (service osm_mongo), needed for NBI, LCM, MON:<br />
docker service update osm_mongo --publish-add 27017:27017<br />
#NOTE: Not sure if this is persistent upon reboot<br />
# check exposed ports by:<br />
docker service list<br />
<br />
Alternativelly you can modify the docker osm stack by editing file '/etc/osm/docker/docker-compose.yaml', adding/uncommenting the exposed ports; and restart the stack:<br />
sudo vi /etc/osm/docker/docker-compose.yaml<br />
# add/uncomment at section mongo:<br />
# ports:<br />
# - "27017:27017"<br />
docker stack rm osm && sleep 60<br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
# make again the service scale to 0 of step 1 in this section<br />
<br />
Similarly, '''ro-db''' (service osm_ro-db) needed for RO, uses ports "3306:3306"<br />
<br />
... And , '''kafka''' (service osm_kafka) needed for LCM, NBI uses ports "9092:9092". Note: for kafka sometimes this is not enough and other modules has errrors connecting to kafka controller. If this is the case modify docker-compose adding kafka bus and relaunch service<br />
<br />
==NBI==<br />
<br />
Install needed OSM packages IM, common:<br />
# osm_im:<br />
# Install Information Model vnfd.py and nsd.py files for pyangbind validation at e.g. parent folder where NBI is cloned<br />
pip3 install pyang<br />
git clone https://github.com/robshakir/pyangbind<br />
pip3 install -e pyangbind<br />
git clone https://osm.etsi.org/gerrit/osm/IM<br />
mkdir IM/osm_im<br />
cd IM/models/yang<br />
wget -q https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-yang-types%402013-07-15.yang -O ./ietf-yang-types.yang<br />
wget -q https://raw.githubusercontent.com/YangModels/yang/master/standard/ietf/RFC/ietf-inet-types%402013-07-15.yang -O ./ietf-inet-types.yang<br />
pyang --plugindir ../../../pyangbind/pyangbind/plugin -f pybind -o ../../osm_im/vnfd.py vnfd.yang<br />
pyang --plugindir ../../../pyangbind/pyangbind/plugin -f pybind -o ../../osm_im/nsd.py nsd.yang<br />
pyang --plugindir ../../../pyangbind/pyangbind/plugin -f pybind -o ../../osm_im/nst.py nst.yang<br />
cd ../../..<br />
pip3 install -e IM<br />
# osm_common:<br />
git clone https://osm.etsi.org/gerrit/osm/common<br />
pip3 install -e common # try with --user if get permission errors<br />
# pip3 install aiokafka==0.4.* pymongo==3.7.* pycrypto pyyaml==3.*<br />
<br />
Change docker service '''mongo''' and '''kafka''' to expose ports. See [[Developer_HowTo#7 Expose needed ports of docker services]]<br />
<br />
Additionally you may want that docker 'light-ui' uses your local copy of NBI by one of:<br />
* Edit again file '/etc/osm/docker/docker-compose.yaml', and set at 'light-ui' section the required IP address from docker to the VM:<br />
OSM_SERVER: <172.17.0.1> # nbi<br />
# Get the needed address at your setup by 'ip a | grep docker0'<br />
* ... Or update light-ui docker service (not persistent on reboot):<br />
docker service update osm_light-ui --force --env-add "OSM_SERVER=172.17.0.1"<br />
# Get the needed address at your setup by 'ip a | grep docker0'<br />
<br />
Clone and install needed NBI packages <br />
docker service scale osm_nbi=0<br />
git clone https://osm.etsi.org/gerrit/osm/NBI<br />
# configure gerrit commit-msg hook<br />
curl -Lo NBI/.git/hooks/commit-msg http://osm.etsi.org/gerrit/tools/hooks/commit-msg<br />
chmod u+x NBI/.git/hooks/commit-msg<br />
cp NBI/.gitignore-common NBI/.gitignore<br />
pip3 install -e NBI # try with --user if get permission errors<br />
# sudo apt-get install python3-keystoneclient<br />
# pip3 install cherrypy==18.0.0 pyyaml==3.* keystoneauth1<br />
<br />
Python interpreter: Python3<br />
Script: $INSTALLATION_FOLDER/NBI/osm_nbi/nbi.py<br />
<br />
Environment variables:<br />
* OSMNBI_DATABASE_COMMONKEY: must be the same value used by NBI. Get it with 'cat /etc/osm/docker/nbi.env'<br />
* OSMNBI_STORAGE_PATH: Path of the docker volume for filestorage. Both LCM and NBI must share the same path. You can either:<br />
** Create a folder and debug both NBI and LCM at the same time (needed if you develop in a different server than OSM); or<br />
** Use the docker volume. Discover local path (Mountpoint) with 'docker volume inspect osm_osm_packages' and grant write permissions to pycharm on it with (path can be different at your envioron) 'sudo chmod o+rx /var/lib/docker /var/lib/docker/volumes; sudo chmod -R o+w /var/lib/docker/volumes/osm_osm_packages/_data' <br />
* OSMNBI_DATABASE_HOST: Mongo IP in case host 'mongo' is not at "/etc/hosts" file<br />
* OSMNBI_STATIC_DIR: <Absolute path of NBI>/osm_nbi/html_public<br />
<br />
==LCM==<br />
<br />
Install needed OSM packages if not done:<br />
# N2VC:<br />
git clone https://osm.etsi.org/gerrit/osm/N2VC<br />
pip3 install -e N2VC # try with --user if get permission errors<br />
<br />
# osm_common:<br />
git clone https://osm.etsi.org/gerrit/osm/common<br />
pip3 install -e common # try with --user if get permission errors<br />
<br />
Change docker service '''mongo''' and '''kafka''' to expose ports. See [[Developer_HowTo#7 Expose needed ports of docker services]]<br />
<br />
Cone and install LCM depencencies<br />
docker service scale osm_lcm=0<br />
git clone https://osm.etsi.org/gerrit/osm/LCM<br />
# configure gerrit commit-msg hook<br />
curl -Lo LCM/.git/hooks/commit-msg http://osm.etsi.org/gerrit/tools/hooks/commit-msg<br />
chmod u+x LCM/.git/hooks/commit-msg<br />
cp LCM/.gitignore-common LCM/.gitignore<br />
pip3 install -e LCM # try with --user if get permission errors<br />
<br />
Python interpreter: Python3<br />
Script: $INSTALLATION_FOLDER/LCM/osm_lcm/lcm.py<br />
<br />
Environment variables:<br />
<br />
Values are stored at '/etc/osm/docker/lcm.env' but here it is explained how to obtain these values.<br />
* OSMLCM_DATABASE_COMMONKEY: must be the same value used by NBI. Get it with 'cat /etc/osm/docker/lcm.env'<br />
* OSMLCM_STORAGE_PATH: Path of the docker volume for filestorage. Both LCM and NBI must share the same path. You can either:<br />
** Create a folder and debug both NBI and LCM at the same time (needed if you develop in a different server than OSM); or<br />
** Use the docker volume. Discover local path (Mountpoint) with 'docker volume inspect osm_osm_packages' and grant read permissions to pycharm on it with (path can be different at your envioron) 'sudo chmod o+rx /var/lib/docker /var/lib/docker/volumes' <br />
* OSMLCM_DATABASE_HOST: Mongo IP in case 'mongo' host it is not at "/etc/hosts" file. See [[Developer_HowTo#5 Configure it to interact with other modules]]<br />
* OSMLCM_RO_HOST: RO IP in case 'ro' host it is not at "/etc/hosts" file<br />
* OSMLCM_VCA_CACERT: To get this value run the following command in the OSM host:<br />
** juju controllers --format json | jq -r '.controllers["osm"]["ca-cert"]'<br />
* OSMLCM_VCA_PUBKEY: To get this value run the following command in the OSM host:<br />
** cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub<br />
* OSMLCM_VCA_SECRET: To get this value run the following command in the OSM host:<br />
** grep password /home/ubuntu/.local/share/juju/accounts.yaml |awk '{print $2}'<br />
* OSMLCM_VCA_HOST: Will be different depending on where your develop environment is running:<br />
** In case you run it in the same server as OSM use the following command to get the IP (<VCA_IP>):<br />
*** juju show-controller|grep api-endpoints|awk -F\' '{print $2}'|awk -F\: '{print $1}'<br />
** In case you use a different server than OSM use the IP address of OSM host (<OSM_IP>). But in addition you need to redirect inside the OSM host, the port 17070 to the VCA container by one of:<br />
*** Configure the following ip-table rule in OSM host (not persistent on reboot):<br />
**** sudo iptables -t nat -A PREROUTING -p tcp -d <OSM_IP> --dport 17070 -j DNAT --to <VCA_IP>:17070<br />
*** or creates a ssh tunnel inside OSM host (just temporal until session is closed):<br />
**** ssh -L 0.0.0.0:17070:<VCA_IP>:17070 root@<VCA_IP><br />
* OSMLCM_GLOBAL_LOGLEVEL: DEBUG<br />
<br />
==RO==<br />
<br />
It is needed to edit the docker service in order to expose the database port for the 'mysql' container. Edit file '/etc/osm/docker/docker-compose.yaml' (recomended to make a backup copy), and uncomment at 'mysql' section the following two lines:<br />
ports:<br />
- "3306:3306"<br />
Additionally you may want that docker 'lcm' uses your local copy of RO. Edit again file '/etc/osm/docker/docker-compose.yaml', and set at 'lcm' section the required IP address from docker to the VM:<br />
OSMLCM_RO_HOST: <172.17.0.1> # ro<br />
# Get the needed address at your setup by 'ip a | grep docker0'<br />
<br />
<br />
Then, relaunch service:<br />
docker stack rm osm <br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
Remove docker service, clone code:<br />
<br />
docker service scale osm_ro=0<br />
# clone and configure gerrit commit-msg hook<br />
git clone https://osm.etsi.org/gerrit/osm/RO<br />
curl -Lo RO/.git/hooks/commit-msg http://osm.etsi.org/gerrit/tools/hooks/commit-msg<br />
chmod u+x RO/.git/hooks/commit-msg<br />
cp RO/.gitignore-common RO/.gitignore<br />
<br />
Install needed packages using its own installation script. Though it is not recomended, you can skip the '--no-db' option for installing a local database alternativelly to use the database at 'ro-db' container:<br />
sudo ./RO/scripts/install-openmano.sh --no-db --noclone --develop<br />
<br />
Python interpreter: Python2<br />
Script: $INSTALLATION_FOLDER/RO/openmanod<br />
<br />
Environment variables:<br />
* RO_DB_HOST, RO_DB_OVIM_HOST: localhost or <OSM_IP> depending if running on the same server or not. Not needed if alternativelly you use a local database copy.<br />
* RO_LOG_LEVEL: DEBUG</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Workflow_with_OSM_tools&diff=6107Workflow with OSM tools2021-02-17T17:19:35Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
__TOC__<br />
<br />
<br />
= Login to OSM portal =<br />
# Go to OSM portal: https://osm.etsi.org/<br />
# Login using your username and password<br />
<br />
'''Note:'''<br />
* If you are '''[[Participate|contributing on behalf of your company]]''', you should login with your '''ETSI Online Account (EOL)'''. <br />
** If your company is not yet an '''[https://portal.etsi.org/TBSiteMap/OSM/ListofOSMMembers.aspx OSM Member or Participant]''', you can check here '''[https://osm.etsi.org/welcome/#join how to join OSM as an organization]'''<br />
** If your company has '''already joined OSM but you do not have an EOL account''' yet, you can '''[http://webapp.etsi.org/createaccount/ request an EOL account]''' <br />
<br />
* If you are an '''individual contributor''', you can '''[https://osm.etsi.org/index2.php?page=page_register.php create your OSM account online]'''.<br />
<br />
If you need any help, contact us at [mailto:OSMsupport@etsi.org OSMsupport@etsi.org]<br />
<br />
= Report a bug on Bugzilla =<br />
# Go to the OSM Portal and click on '''Bugzilla''' menu on the portal menu bar. Or simply go to [https://osm.etsi.org/bugzilla OSM Bugzilla]<br />
# Click on "new" on Bugzilla menu bar.<br />
# Choose the product, e.g. "OSM".<br />
# Complete the bug form. If you know, choose the component, e.g. UI, SO, RO, Documentation/Wiki, etc.<br />
# Enter the bug summary, description, attachement, etc.<br />
# Click on the "Submit Bug" button to confirm.<br />
# A bug id is generated (e.g. Bug 6 -Small Error)<br />
<br />
= Clone your project =<br />
# Clone a '''git''' repository, for example: <pre> git clone https://osm.etsi.org/gerrit/osm/RO.git </pre><br />
# Enter your username<br />
# Enter you password<br />
# It is mandatory to install the Gerrit commit-msg hook for the cloned repository in order to automatically insert a Change-Id tag in commit messages. You can install it by entering the following command for RO repository <pre> curl -Lo RO/.git/hooks/commit-msg http://osm.etsi.org/gerrit/tools/hooks/commit-msg </pre> You then need to make the hook executable <pre> chmod u+x RO/.git/hooks/commit-msg </pre> More information about the Gerrit commit-msg hook can be found here https://git.eclipse.org/r/Documentation/cmd-hook-commit-msg.html<br />
<br />
'''Note''': <br />
* You can find all the project repository URLs on '''[https://osm.etsi.org/gitweb/ Gitweb]''' or on '''[https://osm.etsi.org/gerrit/ Gerrit]'''<br />
** On Gitweb<br />
**# Click on '''Gitweb''' menu on the portal menu bar.<br />
**# Select a product to see the available cloning URLs<br />
** On Gerrit<br />
**# Click on '''Gerrit''' menu on the portal menu bar.<br />
**# Click on "Projects" menu on the Gerrit menu bar.<br />
**# Click on "List" menu.<br />
**# Select a product to see the available cloning URLs.<br />
<br />
= Configure your Git environment =<br />
# Configure your git username globally: <pre> git config --global user.name <username> </pre><br />
# Configure your git email address: <pre> git config --global user.email <email> </pre><br />
# Check your git configuration: <pre> git config --list </pre><br />
'''Note: Your email address will be visible on commits to Git. <br />
If you'd like to keep your email address private, you can mask your email as follows:<br />
if your email is <name@company.com> you can set user.email to <hidden@company.com><br />
This allows other users to identify you as a contributor (with your user name) and<br />
Git Stats to keep track of your company's contributions (with the email domain)<br />
<br />
In case you are using git in the same computer for other open source projects, you can restrict your git variables to the local folder: <pre>git config --local user.name <username><br />
git config --local user.email <email> </pre><br />
<br />
= Python 3 =<br />
<br />
New Python contributions to Open Source Mano must support Python 3+. Python 2.7 reaches an End of Life status on 1 January 2020 and will no longer be supported with bug fixes or security patches.<br />
<br />
<br />
= License Headers = <br />
Newly contributed Source Code should be licensed under the [https://www.apache.org/licenses/LICENSE-2.0 Apache 2.0 license]. A [https://osm.etsi.org/gitweb/?p=osm/LCM.git;a=blob_plain;f=LICENSE;hb=HEAD LICENSE] file shall exist at he root of the repository and all source files should have the following LICENSE header:<br />
<br />
# Copyright {yyyy} {name of copyright owner}<br />
#<br />
# Licensed under the Apache License, Version 2.0 (the "License");<br />
# you may not use this file except in compliance with the License.<br />
# You may obtain a copy of the License at<br />
#<br />
# http://www.apache.org/licenses/LICENSE-2.0<br />
#<br />
# Unless required by applicable law or agreed to in writing, software<br />
# distributed under the License is distributed on an "AS IS" BASIS,<br />
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or<br />
# implied.<br />
# See the License for the specific language governing permissions and<br />
# limitations under the License.<br />
<br />
Please update the template’s first line <br />
# Copyright {yyyy} {name of copyright owner}<br />
<br />
* If you are adding a license header to an existing file, you can add <br />
# Copyright 2019 ETSI<br />
<br />
* If you are adding a license header to a new file, you can add<br />
# Copyright 2019 MyOrgName Inc<br />
<br />
= Commit changes to your local project =<br />
# Go to the "RO" folder <pre>cd osm/RO</pre><br />
# Make some changes on the source (e.g. add a line to the "example-file")<br />
# Stage the change. <pre> git add example-file </pre> <br />
# Commit the change to your local repository. You can add a bug id in your commit message to link the bug to your contribution <pre> git commit -s -m "Bug 2 fixed!!" </pre> <br />
# You can see your commit message and update it, if needed, using the following command: <pre>git commit --amend </pre><br />
<br />
==Developer's Certificate of Origin== <br />
* The "-s" parameter enables to Sign the contribution. It adds the following line at the end of your commit message: <br />
<pre> Signed-off-by: Random J Developer <random@developer.example.org></pre><br />
<br />
* The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as a open-source patch. The rules are pretty simple: signing a contribution means that you can certify the below: <br />
<br />
<pre><br />
Developer's Certificate of Origin 1.1<br />
<br />
By making a contribution to this project, I certify that:<br />
<br />
(a) The contribution was created in whole or in part by me and I<br />
have the right to submit it under the open source license<br />
indicated in the file; or<br />
<br />
(b) The contribution is based upon previous work that, to the best<br />
of my knowledge, is covered under an appropriate open source<br />
license and I have the right under that license to submit that<br />
work with modifications, whether created in whole or in part<br />
by me, under the same open source license (unless I am<br />
permitted to submit under a different license), as indicated<br />
in the file; or<br />
<br />
(c) The contribution was provided directly to me by some other<br />
person who certified (a), (b) or (c) and I have not modified<br />
it.<br />
<br />
(d) I understand and agree that this project and the contribution<br />
are public and that a record of the contribution (including all<br />
personal information I submit with it, including my sign-off) is<br />
maintained indefinitely and may be redistributed consistent with<br />
this project or the open source license(s) involved.<br />
</pre><br />
<br />
= Push your contribution to Gerrit =<br />
== Push your contribution to Gerrit using git push ==<br />
1. To avoid merge conflicts, it is recommended to do a pull with rebase before pushing your contribution in order to merge latest changes made by other users.<br />
git pull --rebase<br />
'''Note''': you can force git to use always the --rebase option with:<br />
git config --local pull.rebase true<br />
<br />
2. Push your commits to '''Gerrit''' for Code Review using the following command:<br />
git push origin HEAD:refs/for/master<br />
#use 'v1.0' instead of 'master' for contributing to v1.0 branch<br />
'''Note''': you can also configure git to push always to the desired branch.<br />
git config --local remote.origin.push HEAD:refs/for/master<br />
git config --local remote.origin.push HEAD:refs/for/v1.0<br />
<br />
3. Enter your username.<br />
<br />
4. Enter your password.<br />
<br />
5. You can review your contribution on '''Gerrit''' web interface<br />
<br />
'''Notes:'''<br />
* The following actions are execution automatically after pushing any contribution to Gerrit: <br />
** '''Gerrit''' reports the new contribution state to the corresponding bug in '''Bugzilla'''<br />
** '''Gerrit''' notifies '''Jenkins''' to build the new contribution.<br />
<br />
== Push your contribution to Gerrit using git review ==<br />
Instead of using "git push", you could use "git review". Follow this guide ([[Using git-review to push and review changes]]) to install and configure git-review. You will also have to set the SSH URL for your remote and copy the commit-msg hook.<br />
* To avoid merge conflicts, it is recommended to do a pull with rebase before pushing your contribution.<br />
git pull --rebase<br />
* Then, send your contribution to gerrit:<br />
git review -c<br />
<br />
= Gerrit Notifications =<br />
Gerrit sends email notifications to:<br />
*Owner of the change<br />
*Reviewers of the change<br />
*Project watchers <br />
<br />
Each user can configure his own watched projects and branches in the "settings/watched project" menu. Email notifications can be sent for New Changes, New Patch Sets, All Comments, Submitted Changes and Abandoned Changes.<br />
<br />
Link: [https://osm.etsi.org/gerrit/#/settings/projects https://osm.etsi.org/gerrit/#/settings/projects] (you can navigate there from the Gerrit console by clicking on the arrow by your login on the top right corner)<br />
<br />
= Continuous Integration =<br />
# '''Jenkins''' builds, tests the new contribution, and reports the result on its web interface.<br />
# '''Jenkins''' votes on the contribution using '''“Code-Verif”''' (-1, +1) on '''Gerrit'''.<br />
<br />
= Code Review =<br />
# Other '''contributors''' and '''MDG Committers''' can comment the new contribution and vote using '''“Code-Review”''' (-1, 0, +1) on '''Gerrit'''.<br />
# The '''MDG Leader''' can comment the new contribution and votes using '''“Code-Review”''' (-2, -1, 0, +1, +2) on '''Gerrit'''.<br />
<br />
= Amending a contribution in Gerrit =<br />
Before amending, make sure that you have the commit-msg hook installed in your local repo. For instance, if your user is "user" and the repo is the "devops" repo, the command to install the commit-msg hook would be:<br />
$ scp -p -P 29418 user@osm.etsi.org:hooks/commit-msg devops/.git/hooks/<br />
<br />
In that way, all patches will use the same Change Id, thus guaranteeing that they will be associated to the same change.<br />
<br />
NOTE: If you don't setup your environment as above, and would like to update a gerrit review with your new/updated code, you MUST have the Change-Id (of the existing gerrit review) inside the commit message. If the commit update does not contain the Change-Id, the commit will will end up creating a new gerrit review, and your subsequent gerrit review will need to be abandoned (not ideal).<br />
<br />
== Amending your last change/commit pushed to Gerrit ==<br />
1. Get the latest changes from the repo and rebase your changes on top<br />
git pull --rebase<br />
<br />
2. Fix the code and any conflicts that might have appeared after pulling the code.<br />
<br />
3. Add all updated files to the index.<br />
git add <file> <br />
<br />
4. Amend your commit. '''NOTE''': Don't use the -m flag to specify a commit message, since it will override the previous message and regenerate the Change-Id. Instead, use the text editor to change the commit message if needed, and keep the Change-Id line intact.<br />
git commit --amend<br />
<br />
5. Submit your change back to the repository. '''NOTE''': use the appropriate branch instead of master, if you are working on a different branch.<br />
git push origin HEAD:refs/for/master<br />
<br />
== Amending one of your changes which has dependencies on subsequent changes==<br />
This procedure will only work if you are the only person working on a set of commits and you don't expect others to push commits and rebase them to be dependent on yours.<br />
<br />
1. Run 'git status' on the branch to know how many commits you are ahead of origin. '''NOTE''': use the appropriate branch instead of master, if you are working on a different branch.<br />
git status<br />
On branch master<br />
Your branch is ahead of 'origin/master' by 3 commits.<br />
<br />
2. Do an interactive rebase over the last X commits and specify which commit you want to amend by changing the command of the commit from "pick" to "edit". Use "drop" to abandon. Re-order the lines to put commits on a different order. <br />
git rebase -i HEAD~3<br />
edit 0ab17ad Change in file1<br />
pick 4995f46 Second change<br />
pick baa85bf Third change<br />
<br />
3. Fix the code in the commit, add the files, amend the commit, and continue rebasing:<br />
vi file1.txt #Fix the code<br />
git add file1.txt<br />
git commit --amend<br />
git rebase --continue<br />
<br />
4. In case of conflicts with subsequent commits, you will have to solve them, and continue rebasing<br />
vi file1.txt #Fix the conflict<br />
git add file1.txt #Add the files to the staging area; no commit is required.<br />
git rebase --continue<br />
<br />
5. Repeat step 4 as many times as required, until rebase finishes. You can cancel the whole operation at any moment with "git rebase --abort"<br />
<br />
6. Rebase your contribution before pushing<br />
git pull --rebase<br />
<br />
7. Push your changes to gerrit. '''NOTE''': use the appropriate branch instead of master, if you are working on a different branch.<br />
git push origin HEAD:refs/for/master<br />
<br />
== Amending a change of another author using git ==<br />
When amending code from a different author, reviewer and original author should be coordinated in order to make sure that changes made by the reviewer are not reverted by the original author later. For that reason, it is recommended to avoid using the local copy of the branch. Instead, it is recommended to create a new local branch to work on every specific change, following the procedure below:<br />
<br />
1. Get the last code from the repository.<br />
git fetch origin<br />
<br />
2. Create a new branch to work on the code from the remote branch. You can use the review number and patchset as name. '''NOTE''': use the appropriate branch instead of master, if you are working on a different branch.<br />
git checkout -b <review-number>-<patchset> origin/master<br />
<br />
3. Pull the patch on the created branch. (To find the command to execute you can open the corresponding change page on Gerrit UI, click on download menu, then copy the "pull" command.)<br />
git pull <url> <ref><br />
<br />
4. Fix the code.<br />
<br />
5. Add all updated files to the index.<br />
git add <file> <br />
<br />
6. Amend the commit. '''NOTE''': Don't use the -m flag to specify a commit message, since it will override the previous message and regenerate the Change-Id. Instead, use the text editor to change the commit message if needed, and keep the Change-Id line intact.<br />
git commit --amend<br />
<br />
7. Rebase your contribution before pushing<br />
git pull --rebase<br />
<br />
8. Submit your change back to the repository. '''NOTE''': use the appropriate branch instead of master, if you are working on a different branch.<br />
git push origin HEAD:refs/for/master<br />
<br />
== Amending a change of another author using git-review ==<br />
1. Follow the instructions in '''[[Using git-review to push and review changes|this link]]''' to install and configure git-review.<br />
<br />
2. Download the change with git-review<br />
$ git review -d 1280<br />
Downloading refs/changes/80/1280/1 from gerrit<br />
Switched to branch "review/garciadeblas/1280"<br />
<br />
This will download the change, put it in a branch called review/AUTHOR/change (if the change has no tag, the sequence number will be used instead), and switch to that branch.<br />
<br />
3. After that, you can amend the downloaded change to improve it. Finally, push it again:<br />
$ git add # add the changes<br />
$ git commit --amend # do not touch the Change-Id. The Change-Id is the way for gerrit to keep track what belongs to what development stream as a new patch set.<br />
$ git commit --amend --author # if you want to mark the changes as yours.<br />
$ git review -c -R # The -R is important, since it tells git-review to not rebase your change against master.<br />
<br />
'''NOTE''': Don't use the -m flag to specify a commit message, since it will override the previous message and regenerate the Change-Id. Instead, use the text editor to change the commit message if needed, and keep the Change-Id line intact.<br />
<br />
4. Delete the branch once you have finished:<br />
$ git branch -D review/garciadeblas/1280<br />
<br />
= Merging the contribution =<br />
# The '''MDG Leader''' can "Submit" the change only if +1 '''"Code-Verif"''' (from '''Jenkins''') and at least one +2 '''"Code-Review"'''.<br />
# '''Gerrit''' reports the result of the code review to the corresponding bug in '''Bugzilla'''<br />
<br />
= Fixing the author name / email =<br />
* Did you commit your changes with a wrong user name? Don't panic, see how [https://www.everythingcli.org/git-like-a-pro-rewrite-author-history/ this can be fixed]<br />
<br />
= OSM CI/CD =<br />
[[File:OSM_CI-CD_workflow.png|700px|OSM CI/CD Workflow]]<br />
<br />
= Join the Community =<br />
* Join the [https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWJkMzRjNDM0MjFjODYzMGQ3ODIzMzJlNTg2ZGI5OTdiZjFiNDMyMzYxMjRjNDU4N2FmNjRjNzY5NTE1MjgzOTQ OSM Community Slack Workspace]<br />
* Subscribe the [https://list.etsi.org/scripts/wa.exe?SUBED1=OSM_TECH&A=1 OSM TECH] mailing list<br />
* Get your organisation / project listed in the [https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem OSM Ecosystem]<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=How_to_report_issues&diff=6106How to report issues2021-02-17T17:19:15Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
'''If you have bugs or issues to be reported, please use [https://osm.etsi.org/bugzilla Bugzilla]<br />
<br />
'''If you have questions or feedback, feel free to contact us through:''' <br />
* '''the mailing list [mailto:OSM_TECH@list.etsi.org OSM_TECH@list.etsi.org]'''<br />
* '''the [https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk Slack work space]''' <br />
<br />
'''Please be patient. Answers may take a few days.'''<br />
<br />
<br />
----<br />
<br />
<br />
Please provide some context to your questions. As an example, find below some guidelines:<br />
* '''In case of an installation issue''':<br />
** The full command used to run the installer and the full output of the installer (or at least enough context) might help on finding the solution.<br />
** It is highly recommended to run the installer command capturing standard output and standard error, so that you can send them for analysis if needed. E.g.:<br />
./install_osm.sh 2>&1 | tee osm_install.log<br />
* '''In case of operational issues''', the following information might help:<br />
** Version of OSM that you are using<br />
** Logs of the system. Check https://osm.etsi.org/wikipub/index.php/Common_issues_and_troubleshooting to know how to get them.<br />
** Details on the actions you made to get that error so that we could reproduce it.<br />
** IP network details in order to help troubleshooting potential network issues. For instance:<br />
*** Client IP address (browser, command line client, etc.) from where you are trying to access OSM<br />
*** IP address of the machine where OSM is running<br />
*** IP addresses of the containers<br />
*** NAT rules in the machine where OSM is running<br />
<br />
Common sense applies here, so you don't need to send everything, but just enough information to diagnose the issue and find a proper solution.</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Common_issues_and_troubleshooting&diff=6105Common issues and troubleshooting2021-02-17T17:19:06Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
__TOC__<br />
<br />
== Installation==<br />
<br />
'''RECOMMENDATION:''' save a log of your installation:<br />
$ ./install_osm.sh 2>&1 | tee osm_install_log.txt<br />
<br />
=== Add User in Group ===<br />
Add the non-root user used for installation in ''sudo , lxd, docker'' groups<br />
<br />
This will skip below error :-<br />
<br />
''Finished installation of juju<br />
Password:<br />
'''sg: failed to crypt password with previous salt: Invalid argument <br />
ERROR No controllers registered.'''''<br />
<br />
<br />
===Docker===<br />
====Were all docker images successfully built?====<br />
<br />
Although controlled by the installer, you can check that the following images exist:<br />
<br />
$ docker image ls<br />
<br />
REPOSITORY TAG IMAGE ID CREATED SIZE<br />
osm/light-ui latest 1988aa262a97 18 hours ago 710MB<br />
osm/lcm latest c9ad59bf96aa 46 hours ago 667MB<br />
osm/ro latest 812c987fcb16 46 hours ago 791MB<br />
osm/nbi latest 584b4e0084a7 46 hours ago 497MB<br />
osm/pm latest 1ad1e4099f52 46 hours ago 462MB<br />
osm/mon latest b17efa3412e3 46 hours ago 725MB<br />
wurstmeister/kafka latest 7cfc4e57966c 10 days ago 293MB<br />
mysql 5 0d16d0a97dd1 2 weeks ago 372MB<br />
mongo latest 14c497d5c758 3 weeks ago 366MB<br />
wurstmeister/zookeeper latest 351aa00d2fe9 18 months ago 478MB<br />
<br />
<br />
====Are all processes/services running?====<br />
$ docker stack ps osm |grep -i running<br />
<br />
10 docker containers should be running.<br />
<br />
All the 10 services should have at least 1 replica: 1/1<br />
<br />
$ docker service ls<br />
<br />
ID NAME MODE REPLICAS IMAGE PORTS<br />
yuyiqh8ty8pv osm_kafka replicated 1/1 wurstmeister/kafka:latest *:9092->9092/tcp<br />
y585906h5vy5 osm_lcm replicated 1/1 osm/lcm:latest<br />
pcdi5vb86nt9 osm_light-ui replicated 1/1 osm/light-ui:latest *:80->80/tcp<br />
i56jhl5k6re4 osm_mon replicated 1/1 osm/mon:latest *:8662->8662/tcp<br />
p5wyjtne93hp osm_mongo replicated 1/1 mongo:latest<br />
iz5uncfdzu23 osm_nbi replicated 1/1 osm/nbi:latest *:9999->9999/tcp<br />
4ttw2v4z2g57 osm_pm replicated 1/1 osm/pm:latest<br />
xbg6bclp2anw osm_ro replicated 1/1 osm/ro:latest *:9090->9090/tcp<br />
sf7rayfolncu osm_ro-db replicated 1/1 mysql:5<br />
5bl73dhj1xl0 osm_zookeeper replicated 1/1 wurstmeister/zookeeper:latest<br />
<br />
====Docker image failed to build====<br />
=====Err:1 http://archive.ubuntu.com/ubuntu xenial InRelease=====<br />
<br />
In some cases, DNS resolution works on the host but fails when building the Docker container. This is caused when Docker doesn't automatically determine the DNS server to use.<br />
<br />
Check if the following works:<br />
docker run busybox nslookup archive.ubuntu.com<br />
<br />
If it does not work, you have to configure Docker to use the available DNS.<br />
# Get the IP address you’re using for DNS:<br />
nmcli dev show | grep 'IP4.DNS'<br />
# Create a new file, /etc/docker/daemon.json, that contains the following (but replace the DNS IP address with the output from the previous step:<br />
{<br />
"dns": ["192.168.24.10"]<br />
}<br />
# Restart docker<br />
sudo service docker restart<br />
# Re-run<br />
docker run busybox nslookup archive.ubuntu.com<br />
# Now you should be able to re-run the installer and move past the DNS issue.<br />
<br />
=====TypeError: unsupported operand type(s) for -=: 'Retry' and 'int'=====<br />
<br />
In some cases, a MTU mismatch between the host and docker interfaces will cause this error while running pip. You can check this by running `ifconfig` and comparing the MTU of your host interface and the docker_gwbridge interface.<br />
<br />
# Create a new file, /etc/docker/daemon.json, that contains the following (but replace the MTU value with that of your host interface from the previous step:<br />
{<br />
"mtu": 1458<br />
}<br />
<br />
# Restart docker<br />
sudo service docker restart<br />
<br />
<br />
====Problem deploying stack osm====<br />
=====network netosm could not be found=====<br />
<br />
The error is ''network "netosm" is declared as external, but could not be found. You need to create a swarm-scoped network before the stack is deployed''<br />
<br />
It usually happens because a "docker system prune" is done with the stack stopped. The following script will create it:<br />
<br />
#!/bin/bash<br />
# Create OSM Docker Network ...<br />
[ -z "$OSM_STACK_NAME" ] && OSM_STACK_NAME=osm<br />
OSM_NETWORK_NAME=net${OSM_STACK_NAME}<br />
echo Creating OSM Docker Network<br />
DEFAULT_INTERFACE=$(route -n | awk '$1~/^0.0.0.0/ {print $8}')<br />
DEFAULT_MTU=$(ip addr show $DEFAULT_INTERFACE | perl -ne 'if (/mtu\s(\d+)/) {print $1;}')<br />
echo \# OSM_STACK_NAME = $OSM_STACK_NAME<br />
echo \# OSM_NETWORK_NAME = $OSM_NETWORK_NAME<br />
echo \# DEFAULT_INTERFACE = $DEFAULT_INTERFACE<br />
echo \# DEFAULT_MTU = $DEFAULT_MTU<br />
sg docker -c "docker network create --driver=overlay --attachable \<br />
--opt com.docker.network.driver.mtu=${DEFAULT_MTU} \<br />
${OSM_NETWORK_NAME}"<br />
<br />
===Juju===<br />
====Bootstrap hangs====<br />
<br />
If the Juju bootstrap takes a long time, stuck at this status...<br />
<br />
Installing Juju agent on bootstrap instance<br />
Fetching Juju GUI 2.14.0<br />
Waiting for address<br />
Attempting to connect to 10.71.22.78:22<br />
Connected to 10.71.22.78<br />
Running machine configuration script...<br />
<br />
...it usually indicates that the LXD container with the Juju controller is having trouble connecting to the internet.<br />
<br />
Get the name of the LXD container. It will begin with 'juju-' and end with '-0'.<br />
<br />
lxc list<br />
+-----------------+---------+---------------------+------+------------+-----------+<br />
| NAME | STATE | IPV4 | IPV6 | TYPE | SNAPSHOTS |<br />
+-----------------+---------+---------------------+------+------------+-----------+<br />
| juju-0383f2-0 | RUNNING | 10.195.8.57 (eth0) | | PERSISTENT | |<br />
+-----------------+---------+---------------------+------+------------+-----------+<br />
<br />
Next, tail the output of cloud-init to see where the bootstrap is stuck.<br />
<br />
lxc exec juju-0383f2-0 -- tail -f /var/log/cloud-init-output.log<br />
<br />
<br />
====Is Juju running?====<br />
<br />
If running, you should see something like this:<br />
<br />
$ juju status<br />
<br />
Model Controller Cloud/Region Version SLA<br />
default osm localhost/localhost 2.3.7 unsupported<br />
<br />
<br />
====ERROR controller osm already exists====<br />
<br />
Did OSM installation fail during juju installation with an error like "ERROR controller osm already exists" ?<br />
<br />
<br />
$ ./install_osm.sh<br />
...<br />
ERROR controller "osm" already exists<br />
ERROR try was stopped<br />
<br />
### Jum Agu 24 15:19:33 WIB 2018 install_juju: FATAL error: Juju installation failed<br />
BACKTRACE:<br />
### FATAL /usr/share/osm-devops/jenkins/common/logging 39<br />
### install_juju /usr/share/osm-devops/installers/full_install_osm.sh 564<br />
### install_lightweight /usr/share/osm-devops/installers/full_install_osm.sh 741<br />
### main /usr/share/osm-devops/installers/full_install_osm.sh 1033<br />
<br />
Try to destroy the Juju controller and run the installation again:<br />
$ juju destroy-controller osm --destroy-all-models -y<br />
$ ./install_osm.sh<br />
<br />
If it does not work, you can destroy Juju container and run the installation again<br />
#Destroy the Juju container<br />
lxc stop juju-*<br />
lxc delete juju-*<br />
#Unregister the controller since we’ve manually freed the resources associated with it<br />
juju unregister -y osm<br />
#Verify that there are no controllers<br />
juju list-controllers<br />
#Run the installation again<br />
./install_osm.sh<br />
<br />
===LXD===<br />
====ERROR profile default: /etc/default/lxd-bridge has IPv6 enabled====<br />
<br />
Make sure that you follow the instructions in the Quickstart.<br />
<br />
When asked if you want to proceed with the installation and configuration of LXD, juju, docker CE and the initialization of a local docker swarm, as pre-requirements, Please answer "y".<br />
<br />
When dialog messages related to LXD configuration are shown, please answer in the following way:<br />
<br />
* Do you want to configure the LXD bridge? Yes<br />
* Do you want to setup an IPv4 subnet? Yes<br />
* << Default values apply for next questions >><br />
* '''Do you want to setup an IPv6 subnet? No'''<br />
<br />
==Configuration==<br />
<br />
===VIMs===<br />
<br />
====Is the VIM URL reachable and operational?====<br />
<br />
When there are problems to access the VIM URL, an error message similar to the following is shown after attempts to instantiate network services:<br />
<br />
Error: "VIM Exception vimmconnConnectionException ConnectFailure: Unable to establish connection to <URL>"<br />
<br />
* In order to debug potential issues with the connection, in the case of an OpenStack VIM, you can install the OpenStack client in the OSM VM and run some basic tests. I.e.:<br />
$ # Install the OpenStack client<br />
$ sudo apt-get install python-openstackclient<br />
$ # Load your OpenStack credentials. For instance, if your credentials are saved in a file named 'myVIM-openrc.sh', you can load them with:<br />
$ source myVIM-openrc.sh<br />
$ # Test if the VIM API is operational with a simple command. For instance:<br />
$ openstack image list<br />
<br />
If the openstack client works, then make sure that you can reach the VIM from the RO docker:<br />
$ docker exec -it osm_ro.1.xxxxx bash<br />
$ curl <URL_CONTROLLER><br />
<br />
''In some cases, the errors come from the fact that the VIM was added to OSM using names in the URL that are not Fully Qualified Domain Names (FQDN).''<br />
<br />
When adding a VIM to OSM, you must use always FQDN or the IP addresses. It must be noted that “controller” or similar names are not proper FQDN (the suffix should be added). Non-FQDN names might be understood by docker’s dnsmasq as a docker container name to be resolved, which is not the case. In addition, all the VIM endpoints should also be FQDN or IP addresses, thus guaranteeing that all subsequent API calls can reach the appropriate endpoint.<br />
<br />
Think of an NFV infrastructure with tens of VIMs, first you will have to use different names for each controller (controller1, controller2, etc.), then you will have to add to every machine trying to interact with the different VIMs, not only OSM, all those entries in the /etc/hosts file. This is bad practice.<br />
<br />
However, it is useful to have a mean to work with lab environments using non-FQDN names. Three options here. Probably you are looking for the third one, but we recommend the first one:<br />
* Option 1. Change the admin URL and/or public URL of the endpoints to use an IP address or an FQDN. You might find this interesting if you want to bring your Openstack setup to production.<br />
* Option 2. Modify /etc/hosts in the docker RO container. This is not persistent after reboots or restarts of the osm docker stack.<br />
* Option 3. Modify /etc/osm/docker/docker-compose.yaml in the host, adding extra_hosts in the ro section with the entries that you want to add to /etc/hosts in the RO docker:<br />
ro:<br />
extra_hosts:<br />
controller: 1.2.3.4<br />
Then restart the stack:<br />
docker stack rm osm<br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
This is persistent after reboots and restarts of the osm docker stack.<br />
<br />
====Authentication====<br />
'''What should I check if the VIM authentication is failing?'''<br />
<br />
Typically, you will get the following error messsage:<br />
<br />
Error: "VIM Exception vimconnUnexpectedResponse Unauthorized: The request you have made requieres authentication. (HTTP 401)"<br />
<br />
If your OpenStack URL is based on HTTPS, OSM will check by default the authenticity of your VIM using the appropriate public certificate. The recommended way to solve this is by modifying /etc/osm/docker/docker-compose.yaml in the host, sharing the host file (e.g. /home/ubuntu/cafile.crt) by adding a volume to the ro section as follows:<br />
ro:<br />
...<br />
volumes:<br />
- /home/ubuntu/cafile.crt:/etc/osm/cafile.crt<br />
Then, when creating the VIM, you should use the config option "ca_cert" as follows:<br />
$ # Create the VIM with all the usual options, and add the config option to specify the certificate<br />
$ osm vim-create VIM-NAME ... --config '{ca_cert: /etc/osm/cafile.crt}'<br />
<br />
For casual testing, when adding the VIM account to OSM, you can use 'insecure: True' (without quotes) as part of the VIM config parameters:<br />
$ osm vim-create VIM-NAME ... --config '{insecure: True}' <br />
<br />
'''Is the VIM management network reachable from OSM (e.g. via ssh, port 22)?'''<br />
<br />
The simplest check would consist on deploying a VM attached to the management network and trying to access it via e.g. ssh from the OSM host.<br />
<br />
For instance, in the case of an OpenStack VIM you could try something like this:<br />
$ openstack server create --image ubuntu --flavor m1.small --nic mgmtnet test<br />
<br />
If this does not work, typically it is due to one of these issues:<br />
* Security group policy in your VIM is blocking your traffic (contact your admin to fix it)<br />
* IP address space in the management network is not routable from outside (or in the reverse direction, for the ACKs).<br />
<br />
==Operational issues==<br />
<br />
===Running out of disk space===<br />
If you are upgrading frequently your OSM installation, you might face that your disk is running out of space. The reason is that the previous dockers and docker images might be consuming some disk space. Running the following two commands should be enough to clear your docker setup:<br />
docker system prune<br />
docker image prune<br />
<br />
If you are still experiencing issues with disk space, logs in one of the dockers could be the cause of your issue. Check the containers that are consuming more space (typically kafka-exporter) <br />
du -sk /var/lib/docker/containers/* |sort -n<br />
docker ps |grep <CONTAINER_ID><br />
<br />
Then, remove the stack and redeploy it again after doing a prune:<br />
docker stack rm osm_metrics<br />
docker system prune<br />
docker image prune<br />
docker stack deploy -c /etc/osm/docker/osm_metrics/docker-compose.yml osm_metrics<br />
<br />
===VCA (juju)===<br />
====Status is not coherent with running NS====<br />
<br />
In extraordinary situations, the output of "juju status" could show pending units that should have been removed when deleting a NS. In those situations, you can clean up VCA by following the procedure below:<br />
juju status -m <NS_ID><br />
juju remove-application -m <NS_ID> <application><br />
juju resolved -m <NS_ID> <unit> --no-retry # You'll likely have to run it several times, as it will probably have an error in the next queued hook.Once the last hook is marked resolved, the charm will continue its removal<br />
<br />
The following page also shows [https://docs.jujucharms.com/2.1/en/charms-destroy how to remove different Juju objects]<br />
<br />
====Dump Juju Logs ====<br />
<br />
To dump the Juju debug-logs, run this command:<br />
juju debug-log --replay --no-tail > juju-debug.log<br />
juju debug-log --replay --no-tail -m <NS_ID><br />
juju debug-log --replay --no-tail -m <NS_ID> --include <UNIT><br />
<br />
====Manual recovery of Juju====<br />
<br />
If juju gets in a corrupt state and you cannot run `juju status` or contact the juju controller, you might need to remove manually the controller and register again, making OSM aware of the new controller.<br />
<br />
<nowiki><br />
# Stop and delete all juju containers, then unregister the controller<br />
lxc list<br />
lxc stop juju-* #replace "*" by the right values<br />
lxc delete juju-* #replace "*" by the right values<br />
juju unregister -y osm<br />
<br />
# Create the controller again <br />
sg lxd -c "juju bootstrap --bootstrap-series=xenial localhost osm"<br />
<br />
# Get controller IP and update it in relevant OSM env files<br />
controller_ip=$(juju show-controller osm|grep api-endpoints|awk -F\' '{print $2}'|awk -F\: '{print $1}')<br />
sudo sed -i 's/^OSMMON_VCA_HOST.*$/OSMMON_VCA_HOST='$controller_ip'/' /etc/osm/docker/mon.env<br />
sudo sed -i 's/^OSMLCM_VCA_HOST.*$/OSMLCM_VCA_HOST='$controller_ip'/' /etc/osm/docker/lcm.env<br />
<br />
#Get juju password and feed it to OSM env files<br />
function parse_juju_password {<br />
password_file="${HOME}/.local/share/juju/accounts.yaml"<br />
local controller_name=$1<br />
local s='[[:space:]]*' w='[a-zA-Z0-9_-]*' fs=$(echo @|tr @ '\034')<br />
sed -ne "s|^\($s\):|\1|" \<br />
-e "s|^\($s\)\($w\)$s:$s[\"']\(.*\)[\"']$s\$|\1$fs\2$fs\3|p" \<br />
-e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p" $password_file |<br />
awk -F$fs -v controller=$controller_name '{<br />
indent = length($1)/2;<br />
vname[indent] = $2;<br />
for (i in vname) {if (i > indent) {delete vname[i]}}<br />
if (length($3) > 0) {<br />
vn=""; for (i=0; i<indent; i++) {vn=(vn)(vname[i])("_")}<br />
if (match(vn,controller) && match($2,"password")) {<br />
printf("%s",$3);<br />
}<br />
}<br />
}'<br />
}<br />
juju_password=$(parse_juju_password osm)<br />
sudo sed -i 's/^OSMMON_VCA_SECRET.*$/OSMMON_VCA_SECRET='$juju_password'/' /etc/osm/docker/mon.env<br />
sudo sed -i 's/^OSMLCM_VCA_SECRET.*$/OSMLCM_VCA_SECRET='$juju_password'/' /etc/osm/docker/lcm.env<br />
<br />
juju_pubkey=$(cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub)<br />
sudo sed -i 's/^OSMLCM_VCA_PUBKEY.*$/OSMLCM_VCA_PUBKEY='$juju_pubkey'/' /etc/osm/docker/mon.env<br />
sudo sed -i 's/^OSMLCM_VCA_PUBKEY.*$/OSMLCM_VCA_PUBKEY='$juju_pubkey'/' /etc/osm/docker/lcm.env<br />
<br />
#Restart OSM stack<br />
docker stack rm osm<br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
#Reset iptable rules<br />
#Delete all rules listed with this command:<br />
sudo iptables -t nat -L | grep 17070<br />
sudo iptables -t nat -A PREROUTING -p tcp -m tcp -d <source> --dport 17070 -j DNAT --to-destination <destination><br />
#Create new iptable rule<br />
OSM_VCA_HOST=`sg lxd -c "juju show-controller osm"|grep api-endpoints|awk -F\' '{print $2}'|awk -F\: '{print $1}'`<br />
DEFAULT_IF=`route -n |awk '$1~/^0.0.0.0/ {print $8}'`<br />
DEFAULT_IP=`ip -o -4 a |grep ${DEFAULT_IF}|awk '{split($4,a,"/"); print a[1]}'`<br />
sudo iptables -t nat -A PREROUTING -p tcp -m tcp -d $DEFAULT_IP --dport 17070 -j DNAT --to-destination $OSM_VCA_HOST<br />
<br />
</nowiki><br />
<br />
====Slow deployment of charms====<br />
<br />
You can make deplyment of charms quicker by:<br />
* Upgrading your LXD installation to use ZFS: [[LXD configuration for OSM Release FIVE]]<br />
** After LXD re-installation, you might need to reinstall the juju controller: [[Common_issues_and_troubleshooting#Manual_recovery_of_Juju|Reinstall Juju controller]]<br />
* Preventing Juju from running apt-get update && apt-get upgrade when starting a machine: [[Advanced_Charm_Development#Disable_OS_upgrades|Disable OS upgrades in charms]]<br />
* Building periodically a custom image that will be used as base image for all the charms: [[Advanced_Charm_Development#Build_a_custom_cloud_image|Custom base image for charms]]<br />
<br />
===Instantiation Errors===<br />
====File juju_id_rsa.pub not found====<br />
* '''ERROR''': ERROR creating VCA model name 'xxxx': Traceback (most recent call last): File "/usr/lib/python3/dist-packages/osm_lcm/ns.py", line 822, in instantiate await ... [Errno 2] No such file or directory: '/root/.local/share/juju/ssh/juju_id_rsa.pub'<br />
* '''CAUSE''': Normally a migration from release FIVE do not set properly the env for LCM<br />
* '''SOLUTION''': Ensure variable '''OSMLCM_VCA_PUBKEY''' is properly set at file ''/etc/osm/docker/lcm.env''. The value must mutch with the output of this command ''cat $HOME/.local/share/juju/ssh/juju_id_rsa.pub''. If not, add or change it. Restart OSM, or just LCM service with ''docker service update osm_lcm --force --env-add OSMLCM_VCA_PUBKEY="<value>" ''<br />
<br />
===NBI Errors===<br />
====Cannot login after migration to 6.0.2====<br />
* '''ERROR''': NBI always return "UNAUTHORIZED" Cannot login neither with UI nor with CLI. CLI shows error "can't find a default project for this user" or "project admin not allowed for this user".<br />
* '''CAUSE''': Normally after a migration to release 6.0.2 There is a slight incompatibility with users creared from older versions<br />
* '''SOLUTION''': Delete user admin and reboot NBI so that a new compatible user is created by running these commands:<br />
curl --insecure https://localhost:9999/osm/test/db-clear/users<br />
docker service update osm_nbi --force<br />
<br />
==Checking the logs==<br />
<br />
You can check the logs of any container with the following commands:<br />
<br />
docker logs $(docker ps -aqf "name=osm_mon" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_pol" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_lcm" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_nbi" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_light-ui" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_ro.1" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_ro-db" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_mongo" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_kafka" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_zookeeper" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_keystone.1" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_keystone-db" -n 1)<br />
docker logs $(docker ps -aqf "name=osm_prometheus" -n 1)<br />
<br />
For each container, logs can be found under:<br />
/var/lib/docker/containers/DOCKER_ID/DOCKER_ID-json.log<br />
<br />
And the DOCKER_ID can be obtained this way, e.g. for MON<br />
docker ps -aqf "name=osm_mon" -n 1 --no-trunc</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=How_to_know_the_version_of_your_current_OSM_installation&diff=6104How to know the version of your current OSM installation2021-02-17T17:18:57Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
Since Release FOUR, in order to know the version that you have installed you only need to search the osm-devops package installed in your system, since osm-devops is the package used to drive installations:<br />
dpkg -l osm-devops<br />
<br />
||/ Name Version Architecture Description<br />
+++-======================-=================-=====================-=====================================<br />
ii osm-devops 4.0.1-1 all<br />
<br />
In case you only installed separate stacks (e.g. elk_stack, pm_stack, etc.), you could end with a newer version of the osm-devops package. Then you can search the python-osmclient package as a way to know your current version of OSM:<br />
||/ Name Version Architecture Description<br />
+++-======================-=================-=====================-=====================================<br />
ii python-osmclient 4.0.1-1 all</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_URN_Namespace&diff=6103OSM URN Namespace2021-02-17T17:18:46Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
=== Introduction ===<br />
OSM is maintaining a namespace registry as a sub tree of the ETSI root <code><nowiki>urn:etsi</nowiki></code> namespace. A description of the top level ETSI URN namespace can be found on the [https://portal.etsi.org/PNNS/GenericAllocation/ETSIURNNamespace.aspx ETSI PNNS page]<br />
<br />
The OSM URN namespace has the following structure:<br />
<nowiki>urn:etsi:osm</nowiki>:<OSM sub-tree><br />
The following sections describe the basic structure of the sub-tree and how a entry in the registry can be requested.<br />
<br />
=== OSM sub-tree ===<br />
{| class="wikitable"<br />
|+<br />
!OSM sub-tree<br />
!Full Namespace<br />
!Type<br />
!Description<br />
|-<br />
|yang<br />
|<br />
<nowiki>urn:etsi:osm:yang</nowiki><br />
|string<br />
|Namespace for YANG modules specified in OSM.<br />
[https://osm.etsi.org/gitweb/?p=osm/IM.git;a=tree;f=models/yang OSM/IM.git]<br />
|}<br />
<br />
==== Type definitions ====<br />
string = (ALPHA)0*(ALPHANUMERIC/-/_)<br />
# a string starts with an upper- or lower-case letter followed by zero or more upper- or lower-case letters, integer numbers, hyphens or underscores<br />
<br />
ALPHA = {a-zA-Z}<br />
ALPHANUMERIC = {a-zA-Z0-9}<br />
<br />
=== Requesting a entry ===<br />
The procedure to request an entry is described as follows.<br />
<br />
* ''Step #1:'' Send an e-mail to the [mailto:OSM_TSC@list.etsi.org OSM_TSC@list.etsi.org] mailing list indicating the name of the sub-tree, the contact person and the purpose of that subtree.<br />
* ''Step #2:'' The TSC will review the proposal.<br />
** If the application is accepted, a new entry in the "OSM URN Namespace" will be enabled.<br />
** If the application cannot be accepted, it will be communicated to the contact person together with any additional information to be considered for resolving the "non-acceptance".</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Technical_Videos&diff=6102OSM Technical Videos2021-02-17T17:18:33Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
Below a list of interesting technical videos and demos related to OSM.<br />
<br />
'''Additional presentations and videos can be found in the [[OSM workshops and events|OSM workshops and events wiki page]] ''' <br />
<br />
== OSM installation ==<br />
{{#evu:https://www.youtube.com/watch?v=yBWSKwms47E<br />
|alignment=inline<br />
}}<br />
<br />
== OSM Release THREE ==<br />
<br />
=== OSM VIM emulator ===<br />
{{#evu:https://www.youtube.com/watch?v=Iji6FFIKL0w<br />
|alignment=inline<br />
}}<br />
<br />
== OSM Release TWO technical videos and demos ==<br />
<br />
=== SDN assist for underlay connectivity with EPA ===<br />
{{#evu:https://www.youtube.com/watch?v=rORcicylr6Q<br />
|alignment=inline<br />
}}<br />
<br />
== MWC 16 (February 2016) ==<br />
<br />
=== MWC16 demo ===<br />
<br />
{{#evu:https://www.youtube.com/watch?v=JJlxwJStkTk<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
<br />
=== MWC16 demo infrastructure and interaction of OSM components ===<br />
<br />
{{#evu:https://www.youtube.com/watch?v=yyo26w8HSn8<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=VIM_emulator&diff=6101VIM emulator2021-02-17T17:17:37Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
= Vim-emu: A NFV multi-PoP emulation platform =<br />
<br />
This emulation platform was created to support network service developers to locally prototype and test their network services in realistic end-to-end multi-PoP scenarios. It allows the execution of real network functions, packaged as Docker containers, in emulated network topologies running locally on the developer's machine. The emulation platform also offers OpenStack-like APIs for each emulated PoP so that it can integrate with MANO solutions, like OSM. The core of the emulation platform is based on [https://containernet.github.io Containernet].<br />
<br />
This software was originally developed by the [http://www.sonata-nfv.eu SONATA project] and the [https://5gtango.eu/ 5GTANGO project], funded by the European Commission under grant number 671517 and 761493 through the Horizon 2020 and 5G-PPP programs.<br />
<br />
== Cite this work ==<br />
<br />
If you plan to use this emulation platform for academic publications, please cite the following paper:<br />
<br />
* M. Peuster, H. Karl, and S. v. Rossem: [http://ieeexplore.ieee.org/document/7919490/ '''MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments''']. IEEE Conference on Network Function Virtualization and Software Defined Networks (NFV-SDN), Palo Alto, CA, USA, pp. 148-153. doi: 10.1109/NFV-SDN.2016.7919490. (2016)<br />
<br />
== Scope ==<br />
<br />
The following figure shows the scope of the emulator solution and its mapping to a simplified ETSI NFV reference architecture in which it replaces the network function virtualisation infrastructure (NFVI) and the virtualised infrastructure manager (VIM). The design of vim-emu is based on a tool called Containernet which extends the well-known Mininet emulation framework and allows us to use standard Docker containers as VNFs within the emulated network. It also allows adding and removing containers from the emulated network at runtime which is not possible in Mininet. This concept allows us to use the emulator like a cloud infrastructure in which we can start and stop compute resources (in the form of Docker containers) at any point in time.<br />
<br />
[[File:Vim-emu-etsi-mapping.png|300px]]<br />
<br />
== Architecture ==<br />
<br />
The vim-emu system design follows a highly customizable approach that offers plugin interfaces for most of its components, like cloud API endpoints, container resource limitation models, or topology generators.<br />
<br />
In contrast to classical Mininet topologies, vim-emu topologies do not describe single network hosts connected to the emulated network. Instead, they define available PoPs which are logical cloud data centers in which compute resources can be started at emulation time. In the most simplified version, the internal network of each PoP is represented by a single SDN switch to which compute resources can be connected. This can be done as the focus is on emulating multi-PoP environments in which a MANO system has full control over the placement of VNFs on different PoPs but limited insights about PoP internals. We extended Mininet's Python-based topology API with methods to describe and add PoPs. The use of a Python-based API has the benefit that developers can use scripts to define or algorithmically generate topologies.<br />
<br />
Besides an API to define emulation topologies, an API to start and stop compute resources within the emulated PoPs is available. Von-emu uses the concept of flexible cloud API endpoints. A cloud API endpoint is an interface to one or multiple PoPs that provides typical infrastructure-as-a-service (IaaS) semantics to manage compute resources. Such an endpoint can be an OpenStack Nova or HEAT like interface, or a simplified REST interface for the emulator CLI. These endpoints can be easily implemented by writing small, Python-based modules that translate incoming requests (e.g., an OpenStack Nova start compute) to emulator specific requests (e.g., start Docker container in PoP1).<br />
<br />
As illustrated in the following figure, our platform automatically starts OpenStack-like control interfaces for each of the emulated PoPs which allow MANO systems to start, stop and manage VNFs. Specifically, our system provides the core functionalities of OpenStack's Nova, Heat, Keystone, Glance, and Neutron APIs. Even though not all of these APIs are directly required to manage VNFs, all of them are needed to let the MANO systems believe that each emulated PoP in our platform is a real OpenStack deployment.<br />
From the perspective of the MANO systems, this setup looks like a real-world multi-VIM deployment, i.e., the MANO system's southbound interfaces can connect to the OpenStack-like VIM interfaces of each emulated PoP. A demonstration of this setup was presented at [http://ieeexplore.ieee.org/abstract/document/8004250/ IEEE NetSoft 2017].<br />
<br />
[[File:Vim-emu-setup.png|400px]]<br />
<br />
----<br />
<br />
== Example: OSM using vim-emu ==<br />
<br />
This section gives an end-to-end usage example that shows how to connect OSM to a vim-emu instance and how to on-board and instantiate an example network service with two VNFs on the emulated infrastructure. All given paths are relative to the vim-emu repository root. The same example is also available for the classic build of OSM: [[VIM_emulator_classic_build_walkthrough|vim-emu classic build walkthrough]].<br />
<br />
{{#evu:https://www.youtube.com/watch?v=Iji6FFIKL0w<br />
|alignment=center<br />
}}<br />
<br />
=== Example service: ''pingpong'' ===<br />
<br />
==== Source descriptors ====<br />
<br />
* Ping VNF (default ubuntu:trusty Docker container): <code>vim-emu/examples/vnfs/ping_vnf/</code><br />
* Pong VNF (default ubuntu:trusty Docker container): <code>vim-emu/examples/vnfs/pong_vnf/</code><br />
* Network service descriptor (NSD): <code>vim-emu/examples/services/pingpong_ns/</code><br />
<br />
==== Pre-packed VNF and NS packages ====<br />
<br />
* Ping VNF: <code>vim-emu/examples/vnfs/ping.tar.gz</code><br />
* Pong VNF: <code>vim-emu/examples/vnfs/pong.tar.gz</code><br />
* NSD: <code>vim-emu/examples/services/pingpong_nsd.tar.gz</code><br />
<br />
=== Walkthrough ===<br />
<br />
==== Step 0: Make sure Open vSwitch is installed ====<br />
<br />
Open vSwitch must be installed on the host on which you want to install OSM and vim-emu.<br />
<br />
$ sudo apt-get install openvswitch-switch<br />
<br />
==== Step 1: Install OSM and vim-emu ====<br />
<br />
Install OSM together with the emulator.<br />
<br />
$ ./install_osm.sh --vimemu<br />
<br />
===== Step 1.1: Start the emulator =====<br />
Check if the emulator is running:<br />
<br />
$ docker ps | grep vim-emu<br />
<br />
If not, start it with the following command:<br />
<br />
$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python3 examples/osm_default_daemon_topology_2_pop.py<br />
<br />
<br />
===== Step 1.2: Configure environment =====<br />
<br />
You need to set the correct environment variables, i.e., you need to get the IP address of the vim-emu container to be able to add it as a VIM to your OSM installation:<br />
<br />
<nowiki><br />
$ export VIMEMU_HOSTNAME=$(sudo docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' vim-emu)<br />
</nowiki><br />
<br />
==== Step 2: Attach OSM to vim-emu ====<br />
<br />
# connect OSM to emulated VIM<br />
$ osm vim-create --name emu-vim1 --user username --password password --auth_url http://$VIMEMU_HOSTNAME:6001/v2.0 --tenant tenantName --account_type openstack<br />
<br />
# list vims<br />
$ osm vim-list<br />
+----------+--------------------------------------+<br />
| vim name | uuid |<br />
+----------+--------------------------------------+<br />
| emu-vim1 | a8175948-efcf-11e7-94ad-00163eba993f |<br />
+----------+--------------------------------------+<br />
<br />
==== Step 3: On-board example ''pingpong'' service ====<br />
<br />
The example can be found in the vim-emu git repository: https://osm.etsi.org/gitweb/?p=osm/vim-emu.git;a=summary.<br />
<br />
# Clone the vim-emu repository containing the pingpong example<br />
$ git clone https://osm.etsi.org/gerrit/osm/vim-emu.git<br />
<br />
# VNFs<br />
$ osm vnfd-create vim-emu/examples/vnfs/ping.tar.gz<br />
$ osm vnfd-create vim-emu/examples/vnfs/pong.tar.gz<br />
<br />
# NS<br />
$ osm nsd-create vim-emu/examples/services/pingpong_nsd.tar.gz<br />
<br />
# You can now check OSM's GUI to see the VNFs and NS in the catalog. Or:<br />
$ osm vnfd-list<br />
+-----------+--------------------------------------+<br />
| vnfd name | id |<br />
+-----------+--------------------------------------+<br />
| ping | 2c632bc7-15f6-4997-a581-b9032ea4672c |<br />
| pong | e6fe076d-9d1f-4f05-a641-44b3e09df961 |<br />
+-----------+--------------------------------------+<br />
<br />
$ osm nsd-list<br />
+----------+--------------------------------------+<br />
| nsd name | id |<br />
+----------+--------------------------------------+<br />
| pingpong | 776746fe-7c48-4f0c-8509-67da1f8c0678 |<br />
+----------+--------------------------------------+<br />
<br />
==== Step 4: Instantiate example ''pingpong'' service ====<br />
<br />
$ osm ns-create --nsd_name pingpong --ns_name test --vim_account emu-vim1<br />
<br />
==== Step 5: Check service instance ====<br />
<br />
# using OSM client<br />
<br />
$ osm ns-list<br />
+------------------+--------------------------------------+--------------------+---------------+-----------------+<br />
| ns instance name | id | operational status | config status | detailed status |<br />
+------------------+--------------------------------------+--------------------+---------------+-----------------+<br />
| test | 566e6c36-5f42-4f3d-89c7-dadcca01ae0d | running | configured | done |<br />
+------------------+--------------------------------------+--------------------+---------------+-----------------+<br />
<br />
==== Step 6: Interact with deployed VNFs ====<br />
<br />
# connect to ping VNF container '''(in another terminal window)''':<br />
$ sudo docker exec -it mn.dc1_test-1-ubuntu-1 /bin/bash<br />
<br />
# show network config<br />
root@dc1_test-nsi:/# ifconfig<br />
eth0 Link encap:Ethernet HWaddr 02:42:ac:11:00:03<br />
inet addr:172.17.0.3 Bcast:0.0.0.0 Mask:255.255.0.0<br />
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1<br />
RX packets:8 errors:0 dropped:0 overruns:0 frame:0<br />
TX packets:0 errors:0 dropped:0 overruns:0 carrier:0<br />
collisions:0 txqueuelen:0<br />
RX bytes:648 (648.0 B) TX bytes:0 (0.0 B)<br />
<br />
ping0-0 Link encap:Ethernet HWaddr 4a:57:93:a0:d4:9d<br />
inet addr:192.168.100.3 Bcast:192.168.100.255 Mask:255.255.255.0<br />
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1<br />
RX packets:0 errors:0 dropped:0 overruns:0 frame:0<br />
TX packets:0 errors:0 dropped:0 overruns:0 carrier:0<br />
collisions:0 txqueuelen:1000<br />
RX bytes:0 (0.0 B) TX bytes:0 (0.0 B)<br />
<br />
# ping the pong VNF over the attached management network<br />
root@dc1_test-1-ubuntu-1:/# ping 192.168.100.4<br />
PING 192.168.100.4 (192.168.100.4) 56(84) bytes of data.<br />
64 bytes from 192.168.100.4: icmp_seq=1 ttl=64 time=0.596 ms<br />
64 bytes from 192.168.100.4: icmp_seq=2 ttl=64 time=0.070 ms<br />
--- 192.168.100.4 ping statistics ---<br />
2 packets transmitted, 2 received, 0% packet loss, time 999ms<br />
rtt min/avg/max/mdev = 0.048/0.059/0.070/0.011 ms<br />
<br />
==== Step 7: Shut down ====<br />
<br />
# delete service instance<br />
$ osm ns-delete test<br />
<br />
==== (optional) Step 8: Check vim-emu and its status ====<br />
<br />
# connect to vim-emu Docker container to see its logs ( '''do in another terminal window''')<br />
$ sudo docker logs -f vim-emu<br />
<br />
# check if the emulator is running in the container<br />
$ sudo docker exec vim-emu vim-emu datacenter list<br />
+---------+-----------------+----------+----------------+--------------------+<br />
| Label | Internal Name | Switch | # Containers | # Metadata Items |<br />
+=========+=================+==========+================+====================+<br />
| dc2 | dc2 | dc2.s1 | 0 | 0 |<br />
+---------+-----------------+----------+----------------+--------------------+<br />
| dc1 | dc1 | dc1.s1 | 0 | 0 |<br />
+---------+-----------------+----------+----------------+--------------------+ <br />
<br />
# check running service<br />
$ sudo docker exec vim-emu vim-emu compute list<br />
+--------------+----------------------------+---------------+------------------+-------------------------+<br />
| Datacenter | Container | Image | Interface list | Datacenter interfaces |<br />
+==============+============================+===============+==================+=========================+<br />
| dc1 | dc1_test.ping.1.ubuntu | ubuntu:trusty | ping0-0 | dc1.s1-eth2 |<br />
+--------------+----------------------------+---------------+------------------+-------------------------+<br />
| dc1 | dc1_test.pong.2.ubuntu | ubuntu:trusty | pong0-0 | dc1.s1-eth3 |<br />
+--------------+----------------------------+---------------+------------------+-------------------------+<br />
<br />
<br />
----<br />
<br />
== Build & Installation ==<br />
There are multiple ways to install and use the emulation platform. The easiest way is the automated installation using the OSM installer. The bare-metal installation requires a freshly installed Ubuntu 16.04 LTS and is done by an ansible playbook. Another option is to use a nested Docker environment to run the emulator inside a Docker container.<br />
<br />
=== Automated installation (with OSM) ===<br />
<br />
The following command will install OSM as well as the emulator (as a Docker container) on a local machine. It is recommended to use a machine with Ubuntu 18.04.<br />
<br />
$ ./install_osm.sh --vimemu<br />
<br />
=== Manual installation (vim-emu only) ===<br />
==== Option 1: Bare-metal installation ====<br />
<br />
* Requires: Ubuntu 18.04 LTS<br />
<br />
$ sudo apt-get install ansible git aptitude<br />
<br />
===== Step 1: Containernet installation =====<br />
<br />
$ cd<br />
$ git clone https://github.com/containernet/containernet.git<br />
$ cd ~/containernet/ansible<br />
$ sudo ansible-playbook -i "localhost," -c local install.yml<br />
<br />
===== Step 2: vim-emu installation =====<br />
<br />
$ cd<br />
$ git clone https://osm.etsi.org/gerrit/osm/vim-emu.git<br />
$ cd ~/vim-emu/ansible<br />
$ sudo ansible-playbook -i "localhost," -c local install.yml<br />
$ cd ..<br />
$ sudo python3 setup.py develop <br />
<br />
==== Option 2: Nested Docker Deployment ====<br />
This option requires a Docker installation on the host machine on which the emulator should be deployed.<br />
<br />
$ git clone https://osm.etsi.org/gerrit/osm/vim-emu.git<br />
$ cd ~/vim-emu<br />
<br />
# build the container: <br />
$ docker build -t vim-emu-img .<br />
<br />
# run the (interactive) container:<br />
$ docker run --name vim-emu -it --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img /bin/bash<br />
<br />
# alternative: run container with emulator in service mode<br />
$ docker run --name vim-emu -t -d --rm --privileged --pid='host' --network=netosm -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python3 examples/osm_default_daemon_topology_2_pop.py<br />
<br />
== Additional information and links ==<br />
<br />
* Main publication: M. Peuster, H. Karl, and S. v. Rossem: [http://ieeexplore.ieee.org/document/7919490/ '''MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments''']. IEEE Conference on Network Function Virtualization and Software Defined Networks (NFV-SDN), Palo Alto, CA, USA, pp. 148-153. doi: 10.1109/NFV-SDN.2016.7919490. (2016)<br />
<br />
<br />
* [https://github.com/containernet/vim-emu Official vim-emu repository mirror on GitHub]<br />
* [https://osm.etsi.org/wikipub/index.php/VIM_emulator Official vim-emu documentation in the OSM wiki]<br />
* [https://github.com/containernet/vim-emu Full vim-emu documentation on GitHub]<br />
* [http://mininet.org Mininet]<br />
* [https://containernet.github.io Containernet]<br />
<br />
== Contact ==<br />
<br />
If you have questions, please use the OSM TECH mailing list: [mailto:OSM_TECH@LIST.ETSI.ORG OSM_TECH@LIST.ETSI.ORG].<br />
<br />
Manuel Peuster (vim-emu lead developer)<br />
* Mail: <manuel (at) peuster (dot) de><br />
* Twitter: [https://twitter.com/ManuelPeuster @ManuelPeuster]<br />
* GitHub: [https://github.com/mpeuster @mpeuster]<br />
* Website: [https://peuster.de]</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Fault_Management&diff=6100OSM Fault Management2021-02-17T17:17:08Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
This documentation corresponds now to Release FIVE, previous documentation related to Fault Management has been deprecated.<br />
<br />
==Basic functionality==<br />
<br />
=== Logs & Events ===<br />
As of Release 5.0.0, logs can be monitored on a per-container basis via command line, like this:<br />
<br />
docker logs <container id or name><br />
<br />
For example:<br />
<br />
docker logs osm_lcm.1.tkb8yr6v762d28ird0edkunlv<br />
<br />
Logs can also be found in the corresponding volume of the host filesystem: '''/var/lib/containers/[container-id]/[container-id].json.log'''<br />
<br />
Furthermore, there are some important events flowing between components through the Kafka bus, which can be monitored on a per-topic basis by external tools.<br />
<br />
=== Alarm Manager for Metrics ===<br />
As of Release FIVE, MON includes a new module called 'mon-evaluator'. The only use case supported today by this module is the configuration of alarms and evaluation of thresholds related to metrics, for the Policy Manager module (POL) to take actions such as [[OSM_Autoscaling|auto-scaling]]. <br />
<br />
Whenever a threshold is crossed and an alarm is triggered, the notification is generated by MON and put in the Kafka bus so other components can consume them. This event is today logged by both MON (generates notification) and POL (consumes notification, for its auto-scaling action)<br />
<br />
By default, threshold evaluation occurs every 30 seconds. This value can be changed by setting an environment variable, for example:<br />
docker service update --env-add OSMMON_EVALUATOR_INTERVAL=15 osm_mon<br />
<br />
Further information regarding how to configure alarms through VNFDs for the supported use case can be found at the [[OSM_Autoscaling|auto-scaling documentation]]<br />
<br />
Reference diagram:<br />
<br />
[[File:osm_fm_rel5.png|800px|Diagram of OSM FM and ELK Experimental add-ons]]<br />
<br />
==Experimental functionality==<br />
As in the previous release, an optional 'OSM ELK' stack is available to allow for events visualization, consisting of the following tools:<br />
* Elastisearch - scalable search engine and event database.<br />
* Filebeat & Metricbeat - part of Elastic 'beats', which evolve the former Logstash component to provide generic logs and metrics collection, respectively.<br />
* Kibana - Graphical tool for exploring all the collected events and generating customized views and dashboards.<br />
<br />
=== Enabling the OSM ELK Stack ===<br />
If you want to install OSM along with the ELK stack, run the installer as follows:<br />
<br />
./install_osm.sh --elk_stack<br />
<br />
If you just want to add the ELK stack to an existing OSM installation, run the installer as follows:<br />
<br />
./install_osm.sh -o elk_stack<br />
<br />
This will install four additional docker containers (Elasticsearch, Filebeat, Metricbeat and Kibana), as well as download a Docker image for an auxiliary tool named [https://www.elastic.co/guide/en/elasticsearch/client/curator/5.5/index.html Curator] (bobrik/curator)<br />
<br />
If you need to remove it at some point in time, just run the following command:<br />
<br />
docker stack rm osm_elk<br />
<br />
If you need to deploy the stack again after being removed:<br />
docker stack deploy -c /etc/osm/docker/osm_elk/docker-compose.yml osm_elk<br />
<br />
'''IMPORTANT''': As time passes and more events are generated in your system, and depending on your configured searches, views and dashboards, Elasticsearch database which become very big, which may not be desirable in testing environments.<br />
In order to delete your data periodically, you can launch a Curator container that will delete the saved indexes, freeing the associated disk space.<br />
<br />
For example, to delete all the data older than the last day:<br />
docker run --rm --name curator --net host --entrypoint curator_cli bobrik/curator:5.5.4 --host localhost delete_indices --filter_list '[{"filtertype":"age","source":"creation_date","direction":"older","unit":"days","unit_count":1}]'<br />
Or to delete the data older than 2 hours:<br />
docker run --rm --name curator --net host --entrypoint curator_cli bobrik/curator:5.5.4 --host localhost delete_indices --filter_list '[{"filtertype":"age","source":"creation_date","direction":"older","unit":"hours","unit_count":2}]'<br />
<br />
=== Testing the OSM ELK Stack ===<br />
<br />
# Download the sample dashboards to your desktop from this link (right click, save link as): https://osm-download.etsi.org/ftp/osm-4.0-four/4th-hackfest/other/osm_kibana_dashboards.json<br />
# Visit Kibana at http://[OSM_IP]:5601 and:<br />
## Go to "Management" --> Saved Objects --> Import (select the downloaded file)<br />
## Go to "Dashboard" and select the "OSM System Dashboard", which connects to other three sub-dashboards (You may need to redefine "filebeat-*" as the default 'index-pattern' by selecting it, marking the star and revisiting the Dashboards)<br />
## Metrics (from Metricbeat) and logs (from Filebeat) should appear at the corresponding visualizations.<br />
<br />
<br />
[[File:osm_kibana_dashboard.png|800px|OSM Kibana Sample Dashboard]]<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_instantiation_parameters&diff=6099OSM instantiation parameters2021-02-17T17:16:55Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
When creating a NS instance, it is possible to pass instantiation parameters to OSM using the "--config" option of the client or the "config" parameter of the UI. In this section we will illustrate through some of the existing examples how to specify those parameters using OSM client:<br />
<br />
===Specify a VIM network name for a NS VLD===<br />
In a generic way, the mapping can be specified in the following way, where 'vldnet' is the name of the network in the NS descriptor and 'netVIM1' is the VIM network that you want to use:<br />
--config '{vld: [ {name: vldnet, vim-network-name: netVIM1} ] }'<br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_1_vnfd.tar.gz hackfest1-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_1_nsd.tar.gz hackfest1-ns]; images: [https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%202%20-%20Creating%20a%20basic%20VNF%20and%20NS.pdf creating a basic VNF and NS]''') in the following way:<br />
<br />
osm ns-create --ns_name hf1 --nsd_name hackfest1-ns --vim_account openstack1 --config '{vld: [ {name: mgmtnet, vim-network-name: mgmt} ] }'<br />
<br />
===Specify a VIM network name for an internal VLD of a VNF===<br />
In this scenario, the mapping can be specified in the following way, where '1' is the member vnf index of the constituent vnf in the NS descriptor, 'internal' is the name of internal-vld in the VNF descriptor and 'netVIM1' is the VIM network that you want to use:<br />
--config '{vnf: [ {member-vnf-index: "1", internal-vld: [ {name: internal, vim-network-name: netVIM1} ] } ] }'<br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_vnfd.tar.gz hackfest2-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_nsd.tar.gz hackfest2-ns]; images:[https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%203%20-%20Modeling%20multi-VDU%20VNF%20v2.pdf modeling multi-VDU VNF]''') in the following way:<br />
osm ns-create --ns_name hf2 --nsd_name hackfest2-ns --vim_account openstack1 --config '{vnf: [ {member-vnf-index: "1", internal-vld: [ {name: internal, vim-network-name: mgmt} ] } ] }'<br />
<br />
===Specify IP profile information and IP for a NS VLD===<br />
In a generic way, the mapping can be specified in the following way, where 'datanet' is the name of the network in the NS descriptor, ip-profile you have to fill the associated parameters with the data model ( [http://osm-download.etsi.org/ftp/osm-doc/nsd.html# NS data model] ), and vnfd-connection-point-ref is the reference to the connection point:<br />
--config '{vld: [ {name: datanet, ip-profile: {...}, vnfd-connection-point-ref: {...} } ] }'<br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_vnfd.tar.gz hackfest2-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_nsd.tar.gz hackfest2-ns]; images:[https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%203%20-%20Modeling%20multi-VDU%20VNF%20v2.pdf modeling multi-VDU VNF]''') in the following way:<br />
osm ns-create --ns_name hf2 --nsd_name hackfest2-ns --vim_account openstack1 --config '{vld: [ {name: datanet, ip-profile: {ip-version: ipv4 ,subnet-address: "192.168.100.0/24", gateway-address: "0.0.0.0", dns-server: [{address: "8.8.8.8"}],dhcp-params: {count: 100, start-address: "192.168.100.20", enabled: true}}, vnfd-connection-point-ref: [ {member-vnf-index-ref: "1", vnfd-connection-point-ref: vnf-data, ip-address: "192.168.100.17"}]}]}'<br />
<br />
===Specify IP profile information for an internal VLD of a VNF===<br />
In this scenario, the mapping can be specified in the following way, where '1' is the member vnf index of the constituent vnf in the NS descriptor, 'internal' is the name of internal-vld in the VNF descriptor and ip-profile you have to fill the associated parameters with the data model ( [http://osm-download.etsi.org/ftp/osm-doc/vnfd.html VNF data model] ):<br />
<br />
--config '{vnf: [ {member-vnf-index: "1", internal-vld: [ {name: internal, ip-profile: {...} ] } ] }'<br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_vnfd.tar.gz hackfest2-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_nsd.tar.gz hackfest2-ns]; images:[https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%203%20-%20Modeling%20multi-VDU%20VNF%20v2.pdf modeling multi-VDU VNF]''') in the following way:<br />
<br />
osm ns-create --ns_name hf2 --nsd_name hackfest2-ns --vim_account openstack1 --config '{vnf: [ {member-vnf-index: "1", internal-vld: [ {name: internal, ip-profile: {ip-version: ipv4 ,subnet-address: "192.168.100.0/24", gateway-address: "0.0.0.0", dns-server: [{address: "8.8.8.8"}] ,dhcp-params: {count: 100, start-address: "192.168.100.20", enabled: true}}}]}]} '<br />
<br />
===Specify IP address and/or MAC address for an interface===<br />
<br />
====Specify IP address for an interface====<br />
In this scenario, the mapping can be specified in the following way, where '1' is the member vnf index of the constituent vnf in the NS descriptor, 'internal' is the name of internal-vld in the VNF descriptor ,ip-profile you have to fill the associated parameters with the data model ( [http://osm-download.etsi.org/ftp/osm-doc/vnfd.html VNF data model] ), 'id1' is the internal-connection-point id and 'a.b.c.d' is the IP that you have to specify for this scenario:<br />
<br />
--config '{vnf: [ {member-vnf-index: "1", internal-vld: [ {name: internal, ip-profile: {...}, internal-connection-point: [{id-ref: id1, ip-address: "a.b.c.d"}] ] } ] }'<br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_vnfd.tar.gz hackfest2-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_nsd.tar.gz hackfest2-ns]; images:[https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%203%20-%20Modeling%20multi-VDU%20VNF%20v2.pdf modeling multi-VDU VNF]''') in the following way:<br />
osm ns-create --ns_name hf2 --nsd_name hackfest2-ns --vim_account ost4 --config '{vnf: [ {member-vnf-index: "1", internal-vld: [ {name: internal, ip-profile: {ip-version: ipv4 ,subnet-address: "192.168.100.0/24", gateway-address: "0.0.0.0", dns-server: [{address: "8.8.8.8"}] ,dhcp-params: {count: 100, start-address: "192.168.100.20", enabled: true}}, internal-connection-point: [{id-ref: mgmtVM-internal, ip-address: "192.168.100.3"}]}]}]}'<br />
<br />
====Specify MAC address for an interface====<br />
In this scenario, the mapping can be specified in the following way, where '1' is the member vnf index of the constituent vnf in the NS descriptor, 'id1' is the id of VDU in the VNF descriptor and 'interf1' is the name of the interface to which you want to add the MAC address:<br />
--config '{vnf: [ {member-vnf-index: "1", vdu: [ {id: id1, interface: [{name: interf1, mac-address: "aa:bb:cc:dd:ee:ff" }]} ] } ] } '<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_1_vnfd.tar.gz hackfest1-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_1_nsd.tar.gz hackfest1-ns]; images: [https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%202%20-%20Creating%20a%20basic%20VNF%20and%20NS.pdf creating a basic VNF and NS]''') in the following way:<br />
osm ns-create --ns_name hf12 --nsd_name hackfest1-ns --vim_account openstack1 --config '{vnf: [ {member-vnf-index: "1", vdu: [ {id: hackfest1VM, interface: [{name: vdu-eth0, mac-address: "52:33:44:55:66:21"}]} ] } ] } '<br />
<br />
====Specify IP address and MAC address for an interface====<br />
In the following scenario, we will bring together the two previous cases <br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_vnfd.tar.gz hackfest2-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_nsd.tar.gz hackfest2-ns]; images:[https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%203%20-%20Modeling%20multi-VDU%20VNF%20v2.pdf modeling multi-VDU VNF]''') in the following way:<br />
<br />
osm ns-create --ns_name hf12 --nsd_name hackfest2-ns --vim_account ost4 --config '{vnf: [ {member-vnf-index: "1", internal-vld: [ {name: internal , ip-profile: {ip-version: ipv4, subnet-address: "192.168.100.0/24", gateway-address: "0.0.0.0", dns-server: [{address: "8.8.8.8"}] , dhcp-params: {count: 100, start-address: "192.168.100.20", enabled: true} }, internal-connection-point: [ {id-ref: mgmtVM-internal, ip-address: "192.168.100.3"} ] }, ], vdu: [ {id: mgmtVM, interface: [{name: mgmtVM-eth0, mac-address: "52:33:44:55:66:21"}]} ] } ] } '<br />
<br />
===Force floating IP address for an interface===<br />
In a generic way, the mapping can be specified in the following way, where 'id1' is the name of the VDU in the VNF descriptor and 'interf1' is the name of the interface:<br />
--config '{vnf: [ {member-vnf-index: "1", vdu: [ {id: id1, interface: [{name: interf1, floating-ip-required: True }]} ] } ] } '<br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_vnfd.tar.gz hackfest2-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_nsd.tar.gz hackfest2-ns]; images:[https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%203%20-%20Modeling%20multi-VDU%20VNF%20v2.pdf modeling multi-VDU VNF]''') in the following way:<br />
osm ns-create --ns_name hf2 --nsd_name hackfest2-ns --vim_account openstack1 --config '{vnf: [ {member-vnf-index: "1", vdu:[ {id: mgmtVM, interface: [{name: mgmtVM-eth0, floating-ip-required: True }]} ] } ] } '<br />
<br />
Make sure 'vim-network-name' in NS Descriptor has access to the outside to be able to use the parameter 'floating-ip-required'.<br />
<br />
===Multi-site deployments (specifying different VIM accounts for different VNFs)===<br />
In this scenario, the mapping can be specified in the following way, where '1 and 2' are the member vnf index of the constituent vnfs in the NS descriptor, 'vim1 and vim2' are the names of vim accounts and 'netVIM1 and netVIM2' are the VIM networks that you want to use:<br />
<br />
--config '{vnf: [ {member-vnf-index: "1", vim_account: vim1}, {member-vnf-index: "2", vim_account: vim2} ], vld: [ {name: datanet, vim-network-name: {vim1: netVIM1, vim2: netVIM2} } ] }'<br />
# NOTE: From release SIX (current master) add 'wim_account: False' (inside --config) to avoid wim network connectivity if you have not a WIM in your system<br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_vnfd.tar.gz hackfest2-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_2_nsd.tar.gz hackfest2-ns]; images:[https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%203%20-%20Modeling%20multi-VDU%20VNF%20v2.pdf modeling multi-VDU VNF]''') in the following way:<br />
osm ns-create --ns_name hf12 --nsd_name hackfest2-ns --vim_account openstack1 --config '{vnf: [ {member-vnf-index: "1", vim_account: openstack1}, {member-vnf-index: "2", vim_account: openstack3} ], vld: [ {name: mgmtnet, vim-network-name: {openstack1: mgmt, openstack3: mgmt} } ] }' <br />
<br />
===Specifying a volume ID for a VNF volume===<br />
<br />
In a generic way, the mapping can be specified in the following way, where 'VM1' is the name of the VDU, 'Storage1' is the volume name in VNF descriptor and '05301095-d7ee-41dd-b520-e8ca08d18a55' is the volume id:<br />
<br />
--config '{vnf: [ {member-vnf-index: "1", vdu: [ {id: VM1, volume: [ {name: Storage1, vim-volume-id: 05301095-d7ee-41dd-b520-e8ca08d18a55} ] } ] } ] }'<br />
<br />
You can try it using one of the examples of the hackfest ('''descriptors: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_1_vnfd.tar.gz hackfest1-vnf], [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_1_nsd.tar.gz hackfest1-ns]; images: [https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/US1604.qcow2 ubuntu1604], presentation: [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/20180626%20OSM%20Hackfest%20-%20Session%202%20-%20Creating%20a%20basic%20VNF%20and%20NS.pdf creating a basic VNF and NS]''') in the following way:<br />
<br />
With the previous hackfest example, according [http://osm-download.etsi.org/ftp/osm-doc/vnfd.html VNF data model] you will add in VNF Descriptor:<br />
<nowiki><br />
volumes:<br />
- name: Storage1<br />
size: 'Size of the volume'<br />
</nowiki><br />
<br />
osm ns-create --ns_name h1 --nsd_name hackfest1-ns --vim_account openstack1 --config '{vnf: [ {member-vnf-index: "1", vdu: [ {id: hackfest1VM, volume: [ {name: Storage1, vim-volume-id: 8ab156fd-0f8e-4e01-b434-a0fce63ce1cf} ] } ] } ] }'<br />
<br />
<br />
===Adding additonal parameters===<br />
<br />
From release SIX (current master) additional user parameters can be added, and they land at vdu:cloud-init (Jinja2 format) and/or vnf-configuration primitives (enclosed by <>). Here is an example of VNF descriptor that uses two parameters called "touch_filename" and "touch_filename2"<br />
<pre><br />
vnfd:<br />
...<br />
vnf-configuration:<br />
config-primitive:<br />
- name: touch<br />
parameter:<br />
- data-type: STRING<br />
default-value: <touch_filename2><br />
name: filename<br />
initial-config-primitive:<br />
- name: config<br />
parameter:<br />
- name: ssh-hostname<br />
value: <rw_mgmt_ip> # this paramater is internal<br />
- name: ssh-username<br />
value: ubuntu<br />
- name: ssh-password<br />
value: osm4u<br />
seq: '1'<br />
- name: touch<br />
parameter:<br />
- name: filename<br />
value: <touch_filename><br />
seq: '2'<br />
</pre><br />
<br />
And they can be provided with:<br />
--config '{additionalParamsForVnf: [{member-vnf-index: "1", additionalParams: {touch_filename: your-value, touch_filename2: your-value2}}]}'</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_client&diff=6097OSM client2021-02-17T17:16:36Z<p>Ramonsalguer: </p>
<hr />
<div>{{MARKDOWN}}<br />
<br />
**THIS PAGE IS DEPRECATED**. OSM User Guide has been moved to a new location: **<https://osm.etsi.org/docs/user-guide/>**<br />
<br />
---<br />
<br />
In those cases where you have an OSM already installed in a remote server, you might still want to operate it from your local computer using the OSM client. The OSM client provides you a client library and a command-line tool to operate OSM..<br />
<br />
## Installation<br />
<br />
OSM client comes bundled with OSM installation, so if you successfully installed OSM, you already have it.<br />
<br />
In addition, you can also install it in a different computer. In order to install OSM client, you will need a Linux machine and follow this procedure.<br />
<br />
```bash<br />
wget -qO - https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/OSM%20ETSI%20Release%20Key.gpg | sudo apt-key add -<br />
sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX stable devops osmclient"<br />
sudo apt-get update<br />
sudo -H pip install python-magic<br />
sudo apt-get install python-osmclient<br />
```<br />
<br />
## Usage (client commands)<br />
<br />
Once installed, type “osm” to see a list of commands. If installed in a host different from where OSM is running, at minimum you will need to specify the OSM host, either via an environment variable or via the osm command line (see “osm --help” for info).<br />
<br />
```bash<br />
export OSM_HOSTNAME="127.0.0.1"<br />
```<br />
<br />
**Usage:**<br />
<br />
```bash<br />
osm [OPTIONS] COMMAND [ARGS]...<br />
```<br />
<br />
**Options:**<br />
<br />
```bash<br />
--hostname TEXT hostname of server. Also can set OSM_HOSTNAME in<br />
environment<br />
--user TEXT user (defaults to admin). Also can set OSM_USER in<br />
environment<br />
--password TEXT password (defaults to admin). Also can set OSM_PASSWORD in<br />
environment<br />
--project TEXT project (defaults to admin). Also can set OSM_PROJECT in<br />
environment<br />
--help Show this message and exit.<br />
```<br />
<br />
**Commands:**<br />
<br />
```bash<br />
netslice-instance-create creates a new Network Slice Instance<br />
netslice-instance-delete deletes a Network Slice Instance (NSI)<br />
netslice-instance-list list all Network Slice Instances (NSI)<br />
netslice-instance-op-list shows the history of operations over a...<br />
netslice-instance-op-show shows the info of an operation over a Network<br />
Slice Instance(NSI)<br />
netslice-instance-show shows the content of a Network Slice Instance<br />
(NSI)<br />
netslice-template-create creates a new Network Slice Template (NST)<br />
netslice-template-delete deletes a Network Slice Template (NST)<br />
netslice-template-list list all Network Slice Templates (NST) in the...<br />
netslice-template-show shows the content of a Network Slice Template<br />
(NST)<br />
netslice-template-update updates a Network Slice Template (NST)<br />
nf-list list all NF instances Options: --ns TEXT NS...<br />
nfpkg-create creates a new NFpkg<br />
nfpkg-delete deletes a NFpkg<br />
nfpkg-list list all NF pkg (VNF pkg, PNF pkg, HNF pkg)...<br />
nfpkg-show shows the content of a NF Descriptor<br />
nfpkg-update updates a NFpkg<br />
ns-action executes an action/primitive over a NS...<br />
ns-alarm-create creates a new alarm for a NS instance<br />
ns-create creates a new Network Service instance<br />
ns-delete deletes a NS instance<br />
ns-list list all NS instances Options: --filter...<br />
ns-metric-export exports a metric to the internal OSM bus,...<br />
ns-op-list shows the history of operations over a NS...<br />
ns-op-show shows the info of an operation<br />
ns-show shows the info of a NS instance<br />
nsd-create creates a new NSD/NSpkg<br />
nsd-delete deletes a NSD/NSpkg<br />
nsd-list list all NSD/NS pkg in the system<br />
nsd-show shows the content of a NSD<br />
nsd-update updates a NSD/NSpkg<br />
nsi-create creates a new Network Slice Instance<br />
nsi-delete deletes a Network Slice Instance (NSI)<br />
nsi-list list all Network Slice Instances (NSI)<br />
nsi-op-list shows the history of operations over a...<br />
nsi-op-show shows the info of an operation over a Network<br />
Slice Instance(NSI)<br />
nsi-show shows the content of a Network Slice Instance<br />
(NSI)<br />
nspkg-create creates a new NSD/NSpkg<br />
nspkg-delete deletes a NSD/NSpkg<br />
nspkg-list list all NSD/NS pkg in the system<br />
nspkg-show shows the content of a NSD<br />
nspkg-update updates a NSD/NSpkg<br />
nst-create creates a new Network Slice Template (NST)<br />
nst-delete deletes a Network Slice Template (NST)<br />
nst-list list all Network Slice Templates (NST) in the...<br />
nst-show shows the content of a Network Slice Template<br />
(NST)<br />
nst-update updates a Network Slice Template (NST)<br />
pdu-create adds a new Physical Deployment Unit to the<br />
catalog<br />
pdu-delete deletes a Physical Deployment Unit (PDU)<br />
pdu-list list all Physical Deployment Units (PDU)<br />
pdu-show shows the content of a Physical Deployment Unit<br />
(PDU)<br />
project-create Creates a new project NAME: name of the...<br />
project-delete deletes a project NAME: name or ID of the...<br />
project-list list all projects<br />
project-show shows the details of a project NAME: name or...<br />
project-update Update a project name :param ctx: :param...<br />
role-create creates a role<br />
role-delete deletes a role<br />
role-list list all roles<br />
role-show show specific role<br />
role-update updates a role<br />
sdnc-create creates a new SDN controller<br />
sdnc-delete deletes an SDN controller NAME: name or ID of...<br />
sdnc-list list all SDN controllers<br />
sdnc-show shows the details of an SDN controller NAME:...<br />
sdnc-update updates an SDN controller<br />
upload-package uploads a VNF package or NS package FILENAME:...<br />
user-create Creates a new user USERNAME: name of the...<br />
user-delete deletes a user NAME: name or ID of the user...<br />
user-list list all users<br />
user-show shows the details of a user NAME: name or ID...<br />
user-update Update a user information USERNAME: name of...<br />
vim-create creates a new VIM account<br />
vim-delete deletes a VIM account NAME: name or ID of the...<br />
vim-list list all VIM accounts<br />
vim-show shows the details of a VIM account NAME: name...<br />
vim-update updates a VIM account<br />
vnf-list list all NF instances<br />
vnf-scale Executes a VNF scale (adding/removing VDUs)...<br />
vnf-show shows the info of a VNF instance<br />
vnfd-create creates a new VNFD/VNFpkg<br />
vnfd-delete deletes a VNFD/VNFpkg<br />
vnfd-list list all VNFD/VNF pkg in the system<br />
vnfd-show shows the content of a VNFD<br />
vnfd-update updates a new VNFD/VNFpkg<br />
vnfpkg-create creates a new VNFD/VNFpkg<br />
vnfpkg-delete deletes a VNFD/VNFpkg<br />
vnfpkg-list list all VNFD/VNF pkg in the system<br />
vnfpkg-show shows the content of a VNFD<br />
vnfpkg-update updates a VNFD/VNFpkg<br />
wim-create creates a new WIM account<br />
wim-delete deletes a WIM account NAME: name or ID of the...<br />
wim-list list all WIM accounts<br />
wim-show shows the details of a WIM account NAME: name...<br />
wim-update updates a WIM account<br />
```<br />
<br />
## Enable autocompletion<br />
<br />
You can enable autocompletion in OSM client by creating a file osm-complete.sh in the following way:<br />
<br />
```bash<br />
mkdir -p $HOME/.bash_completion.d<br />
_OSM_COMPLETE=source osm > $HOME/.bash_completion.d/osm-complete.sh<br />
```<br />
<br />
Then you can add the following to your $HOME/.bashrc file:<br />
```bash<br />
. .bash_completion.d/osm-complete.sh<br />
```<br />
<br />
## Other installation methods<br />
<br />
### Installing from git repo<br />
<br />
```bash<br />
# Ubuntu pre-requirements<br />
sudo apt install python-pip libcurl4-gnutls-dev libgnutls-dev<br />
# CentOS pre-requirements<br />
# sudo yum install python-pip libcurl-devel gnutls-devel<br />
sudo -H pip install python-magic<br />
# Install OSM client from the git repo.<br />
# You can install the latest client from master branch in this way:<br />
sudo -H pip install git+https://osm.etsi.org/gerrit/osm/osmclient<br />
# You could also install a specific tag/version in this way<br />
sudo -H pip install git+https://osm.etsi.org/gerrit/osm/osmclient@v6.0.1<br />
```<br />
<br />
### Installing from cloned repo (for developers)<br />
<br />
```bash<br />
# Ubuntu pre-requirements<br />
sudo apt install python-pip libcurl4-gnutls-dev libgnutls-dev<br />
# Make sure that <br />
# sudo yum install python-pip libcurl-devel gnutls-devel<br />
sudo -H pip install python-magic<br />
# Clone the osmclient repo and install OSM client from the git repo.<br />
git clone https://osm.etsi.org/gerrit/osm/osmclient<br />
sudo -H pip install osmclient<br />
```<br />
<br />
## Using osmclient as a library to interact with OSM<br />
<br />
Assuming that you have installed python-osmclient package, it's pretty simple to write some Python code to interact with OSM.<br />
<br />
### Simple Python code to get the list of NS packages<br />
<br />
```python<br />
from osmclient import client<br />
from osmclient.common.exceptions import ClientException<br />
hostname = "127.0.0.1"<br />
myclient = client.Client(host=hostname, sol005=True)<br />
resp = myclient.nsd.list()<br />
print yaml.safe_dump(resp)<br />
```<br />
<br />
### Simple Python code to get the list of VNF packages from a specific user and project<br />
<br />
The code will print for each package a pretty table, then the full details in yaml<br />
```python<br />
from osmclient import client<br />
from osmclient.common.exceptions import ClientException<br />
import yaml<br />
from prettytable import PrettyTable<br />
hostname = "127.0.0.1"<br />
user = admin<br />
password = admin<br />
project = admin<br />
kwargs = {}<br />
if user is not None:<br />
kwargs['user']=user<br />
if password is not None:<br />
kwargs['password']=password<br />
if project is not None:<br />
kwargs['project']=project<br />
myclient = client.Client(host=hostname, sol005=True, **kwargs)<br />
resp = myclient.vnfd.list()<br />
print yaml.safe_dump(resp)<br />
```</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_client&diff=6096OSM client2021-02-17T17:16:23Z<p>Ramonsalguer: </p>
<hr />
<div>{{MARKDOWN}}<br />
<br />
**THIS PAGE IS DEPRECATED**. OSM User Guide has been moved to a new location: **<https://osm.etsi.org/docs/user-guide/>**<br />
<br />
---<br />
<br />
**THIS PAGE IS DEPRECATED**. OSM User Guide has been moved to a new location: **<https://osm.etsi.org/docs/user-guide/>**<br />
<br />
---<br />
<br />
In those cases where you have an OSM already installed in a remote server, you might still want to operate it from your local computer using the OSM client. The OSM client provides you a client library and a command-line tool to operate OSM..<br />
<br />
## Installation<br />
<br />
OSM client comes bundled with OSM installation, so if you successfully installed OSM, you already have it.<br />
<br />
In addition, you can also install it in a different computer. In order to install OSM client, you will need a Linux machine and follow this procedure.<br />
<br />
```bash<br />
wget -qO - https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/OSM%20ETSI%20Release%20Key.gpg | sudo apt-key add -<br />
sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX stable devops osmclient"<br />
sudo apt-get update<br />
sudo -H pip install python-magic<br />
sudo apt-get install python-osmclient<br />
```<br />
<br />
## Usage (client commands)<br />
<br />
Once installed, type “osm” to see a list of commands. If installed in a host different from where OSM is running, at minimum you will need to specify the OSM host, either via an environment variable or via the osm command line (see “osm --help” for info).<br />
<br />
```bash<br />
export OSM_HOSTNAME="127.0.0.1"<br />
```<br />
<br />
**Usage:**<br />
<br />
```bash<br />
osm [OPTIONS] COMMAND [ARGS]...<br />
```<br />
<br />
**Options:**<br />
<br />
```bash<br />
--hostname TEXT hostname of server. Also can set OSM_HOSTNAME in<br />
environment<br />
--user TEXT user (defaults to admin). Also can set OSM_USER in<br />
environment<br />
--password TEXT password (defaults to admin). Also can set OSM_PASSWORD in<br />
environment<br />
--project TEXT project (defaults to admin). Also can set OSM_PROJECT in<br />
environment<br />
--help Show this message and exit.<br />
```<br />
<br />
**Commands:**<br />
<br />
```bash<br />
netslice-instance-create creates a new Network Slice Instance<br />
netslice-instance-delete deletes a Network Slice Instance (NSI)<br />
netslice-instance-list list all Network Slice Instances (NSI)<br />
netslice-instance-op-list shows the history of operations over a...<br />
netslice-instance-op-show shows the info of an operation over a Network<br />
Slice Instance(NSI)<br />
netslice-instance-show shows the content of a Network Slice Instance<br />
(NSI)<br />
netslice-template-create creates a new Network Slice Template (NST)<br />
netslice-template-delete deletes a Network Slice Template (NST)<br />
netslice-template-list list all Network Slice Templates (NST) in the...<br />
netslice-template-show shows the content of a Network Slice Template<br />
(NST)<br />
netslice-template-update updates a Network Slice Template (NST)<br />
nf-list list all NF instances Options: --ns TEXT NS...<br />
nfpkg-create creates a new NFpkg<br />
nfpkg-delete deletes a NFpkg<br />
nfpkg-list list all NF pkg (VNF pkg, PNF pkg, HNF pkg)...<br />
nfpkg-show shows the content of a NF Descriptor<br />
nfpkg-update updates a NFpkg<br />
ns-action executes an action/primitive over a NS...<br />
ns-alarm-create creates a new alarm for a NS instance<br />
ns-create creates a new Network Service instance<br />
ns-delete deletes a NS instance<br />
ns-list list all NS instances Options: --filter...<br />
ns-metric-export exports a metric to the internal OSM bus,...<br />
ns-op-list shows the history of operations over a NS...<br />
ns-op-show shows the info of an operation<br />
ns-show shows the info of a NS instance<br />
nsd-create creates a new NSD/NSpkg<br />
nsd-delete deletes a NSD/NSpkg<br />
nsd-list list all NSD/NS pkg in the system<br />
nsd-show shows the content of a NSD<br />
nsd-update updates a NSD/NSpkg<br />
nsi-create creates a new Network Slice Instance<br />
nsi-delete deletes a Network Slice Instance (NSI)<br />
nsi-list list all Network Slice Instances (NSI)<br />
nsi-op-list shows the history of operations over a...<br />
nsi-op-show shows the info of an operation over a Network<br />
Slice Instance(NSI)<br />
nsi-show shows the content of a Network Slice Instance<br />
(NSI)<br />
nspkg-create creates a new NSD/NSpkg<br />
nspkg-delete deletes a NSD/NSpkg<br />
nspkg-list list all NSD/NS pkg in the system<br />
nspkg-show shows the content of a NSD<br />
nspkg-update updates a NSD/NSpkg<br />
nst-create creates a new Network Slice Template (NST)<br />
nst-delete deletes a Network Slice Template (NST)<br />
nst-list list all Network Slice Templates (NST) in the...<br />
nst-show shows the content of a Network Slice Template<br />
(NST)<br />
nst-update updates a Network Slice Template (NST)<br />
pdu-create adds a new Physical Deployment Unit to the<br />
catalog<br />
pdu-delete deletes a Physical Deployment Unit (PDU)<br />
pdu-list list all Physical Deployment Units (PDU)<br />
pdu-show shows the content of a Physical Deployment Unit<br />
(PDU)<br />
project-create Creates a new project NAME: name of the...<br />
project-delete deletes a project NAME: name or ID of the...<br />
project-list list all projects<br />
project-show shows the details of a project NAME: name or...<br />
project-update Update a project name :param ctx: :param...<br />
role-create creates a role<br />
role-delete deletes a role<br />
role-list list all roles<br />
role-show show specific role<br />
role-update updates a role<br />
sdnc-create creates a new SDN controller<br />
sdnc-delete deletes an SDN controller NAME: name or ID of...<br />
sdnc-list list all SDN controllers<br />
sdnc-show shows the details of an SDN controller NAME:...<br />
sdnc-update updates an SDN controller<br />
upload-package uploads a VNF package or NS package FILENAME:...<br />
user-create Creates a new user USERNAME: name of the...<br />
user-delete deletes a user NAME: name or ID of the user...<br />
user-list list all users<br />
user-show shows the details of a user NAME: name or ID...<br />
user-update Update a user information USERNAME: name of...<br />
vim-create creates a new VIM account<br />
vim-delete deletes a VIM account NAME: name or ID of the...<br />
vim-list list all VIM accounts<br />
vim-show shows the details of a VIM account NAME: name...<br />
vim-update updates a VIM account<br />
vnf-list list all NF instances<br />
vnf-scale Executes a VNF scale (adding/removing VDUs)...<br />
vnf-show shows the info of a VNF instance<br />
vnfd-create creates a new VNFD/VNFpkg<br />
vnfd-delete deletes a VNFD/VNFpkg<br />
vnfd-list list all VNFD/VNF pkg in the system<br />
vnfd-show shows the content of a VNFD<br />
vnfd-update updates a new VNFD/VNFpkg<br />
vnfpkg-create creates a new VNFD/VNFpkg<br />
vnfpkg-delete deletes a VNFD/VNFpkg<br />
vnfpkg-list list all VNFD/VNF pkg in the system<br />
vnfpkg-show shows the content of a VNFD<br />
vnfpkg-update updates a VNFD/VNFpkg<br />
wim-create creates a new WIM account<br />
wim-delete deletes a WIM account NAME: name or ID of the...<br />
wim-list list all WIM accounts<br />
wim-show shows the details of a WIM account NAME: name...<br />
wim-update updates a WIM account<br />
```<br />
<br />
## Enable autocompletion<br />
<br />
You can enable autocompletion in OSM client by creating a file osm-complete.sh in the following way:<br />
<br />
```bash<br />
mkdir -p $HOME/.bash_completion.d<br />
_OSM_COMPLETE=source osm > $HOME/.bash_completion.d/osm-complete.sh<br />
```<br />
<br />
Then you can add the following to your $HOME/.bashrc file:<br />
```bash<br />
. .bash_completion.d/osm-complete.sh<br />
```<br />
<br />
## Other installation methods<br />
<br />
### Installing from git repo<br />
<br />
```bash<br />
# Ubuntu pre-requirements<br />
sudo apt install python-pip libcurl4-gnutls-dev libgnutls-dev<br />
# CentOS pre-requirements<br />
# sudo yum install python-pip libcurl-devel gnutls-devel<br />
sudo -H pip install python-magic<br />
# Install OSM client from the git repo.<br />
# You can install the latest client from master branch in this way:<br />
sudo -H pip install git+https://osm.etsi.org/gerrit/osm/osmclient<br />
# You could also install a specific tag/version in this way<br />
sudo -H pip install git+https://osm.etsi.org/gerrit/osm/osmclient@v6.0.1<br />
```<br />
<br />
### Installing from cloned repo (for developers)<br />
<br />
```bash<br />
# Ubuntu pre-requirements<br />
sudo apt install python-pip libcurl4-gnutls-dev libgnutls-dev<br />
# Make sure that <br />
# sudo yum install python-pip libcurl-devel gnutls-devel<br />
sudo -H pip install python-magic<br />
# Clone the osmclient repo and install OSM client from the git repo.<br />
git clone https://osm.etsi.org/gerrit/osm/osmclient<br />
sudo -H pip install osmclient<br />
```<br />
<br />
## Using osmclient as a library to interact with OSM<br />
<br />
Assuming that you have installed python-osmclient package, it's pretty simple to write some Python code to interact with OSM.<br />
<br />
### Simple Python code to get the list of NS packages<br />
<br />
```python<br />
from osmclient import client<br />
from osmclient.common.exceptions import ClientException<br />
hostname = "127.0.0.1"<br />
myclient = client.Client(host=hostname, sol005=True)<br />
resp = myclient.nsd.list()<br />
print yaml.safe_dump(resp)<br />
```<br />
<br />
### Simple Python code to get the list of VNF packages from a specific user and project<br />
<br />
The code will print for each package a pretty table, then the full details in yaml<br />
```python<br />
from osmclient import client<br />
from osmclient.common.exceptions import ClientException<br />
import yaml<br />
from prettytable import PrettyTable<br />
hostname = "127.0.0.1"<br />
user = admin<br />
password = admin<br />
project = admin<br />
kwargs = {}<br />
if user is not None:<br />
kwargs['user']=user<br />
if password is not None:<br />
kwargs['password']=password<br />
if project is not None:<br />
kwargs['project']=project<br />
myclient = client.Client(host=hostname, sol005=True, **kwargs)<br />
resp = myclient.vnfd.list()<br />
print yaml.safe_dump(resp)<br />
```</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Openstack_configuration&diff=6090Openstack configuration2021-02-17T16:58:43Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
__TOC__<br />
<br />
=Configure openstack for OSM (basic)=<br />
<br />
'''1. Guarantee that Openstack API endpoints are reachable from OSM (particularly from RO container)'''<br />
<br />
'''2. Create a management network, with DHCP enabled, reachable from OSM (particularly from VCA container)'''<br />
<br />
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:<br />
neutron net-create mgmt --provider:network_type=vlan --provider:physical_network=physnet_em1 --provider:segmentation_id=500 --shared<br />
neutron subnet-create --name subnet-mgmt mgmt 10.208.0.0/24 --allocation-pool start=10.208.0.2,end=10.208.0.254<br />
<br />
'''3. Create a valid tenant/user'''<br />
<br />
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.<br />
<br />
'''4. Upload images'''<br />
<br />
For the time being, it is required to upload the images of the VNFs manually at openstack, using the following command:<br />
<br />
openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 --public cirros034<br />
<br />
'''5. Modify default security group or create a new one'''<br />
<br />
By default openstack apply the "default" security group that blocks any incoming traffic to the VM. However ssh access might be 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_TWO)#Add_openstack_to_OSM|Add openstack to OSM]] )<br />
<br />
=Configure Openstack for full EPA support in OSM =<br />
<br />
Besides the instructions above for any Openstack, you should do extra configuration to configure Openstack for running VNFs which use SRIOV interfaces.<br />
<br />
'''DO NOT consider this as the final configuration guide for Openstack with EPA. Please check Openstack docs and Openstack downstream distros' docs to get a further understanding and the up-to-date required configuration.'''<br />
<br />
'''Note: The configuration shown below works with Openstack Newton, and it might not work with later versions.'''<br />
<br />
* The compute nodes need to have a whitelist for the interfaces with SRIOV and passthrough enabled, and those interface need to be associated to a physical network label e.g. “physnet”. This can be done in the file /etc/nova/nova.conf :<br />
pci_passthrough_whitelist=[{"devname": "p3p1", "physical_network": "physnet"}, {"devname": "p3p2", "physical_network": "physnet"}]<br />
<br />
* The neutron controller needs to be updated to add “sriovnicswitch” to the mechanism_drivers. This can be done in the file “/etc/neutron/plugins/ml2/ml2_conf.ini” <br />
mechanism_drivers =openvswitch,sriovnicswitch<br />
<br />
* The neutron controller needs to be updated to set the vlans to be used for the defined physical network label. This can be done in the file “/etc/neutron/plugins/ml2/ml2_conf.ini”. For instance, to set the vlans from 2000 to 3000:<br />
network_vlan_ranges =physnet:2000:3000<br />
<br />
* The neutron controller needs to be updated to allow the supported NIC vendor’s product ID. This can be done in the file “/etc/neutron/plugins/ml2/ml2_conf.ini” to <br />
[ml2_sriov]<br />
supported_pci_vendor_devs = 8086:10ed<br />
<br />
* The nova controller needs to be updated to allow proper scheduling of SR-IOV and Passthrough devices, by adding the PciPassthroughFilter filter to the list of filters. This can be done in the file “/etc/nova/nova.conf”:<br />
scheduler_available_filters=nova.scheduler.filters.all_filters<br />
scheduler_default_filters=RetryFilter,AvailabilityZoneFilter,RamFilter,ComputeFilter,ComputeCapabilitiesFilter,ImagePropertiesFilter,CoreFilter, PciPassthroughFilter<br />
<br />
The previous configuration has been collected from the links below. Please check them to get more details:<br />
* https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/network_functions_virtualization_product_guide/<br />
* https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/network_functions_virtualization_planning_guide/<br />
* https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/network_functions_virtualization_configuration_guide/<br />
* https://docs.openstack.org/newton/networking-guide/config-sriov.html<br />
<br />
=Add openstack to OSM=<br />
<br />
There is a parameter called '''--config''' used to supply general configuration options. This paremeter can be used when creating the datacenter using the OSM client or when adding the datacenter directly to the RO (both at datacenter creation and datacenter attachment to openmano tenant -the latter prevails-).<br />
<br />
The following configuration can be added:<br />
* '''management_network_id''', '''management_network_name''': VIM management network id/name to use for the management VLD of NS descriptors. By default it uses same vim network name as VLD name. It can be set also at instantiation time.<br />
* '''security_groups''': To be used for the deployment<br />
* '''availability_zone''': To be used for the deployment. It can be:<br />
** a single availability zone (all deployments will land in that zone), e.g. 'availability_zone: controller'<br />
** several availability zones, which enables affinity and anti-affinity deployments, e.g. 'availability_zone: [zone1, zone2]'<br />
* '''region_name''': The region where the VM must be deployed.<br />
* '''insecure''': (By default false). When true it allows authorization over a non trusted certificate over https<br />
* '''ca_cert''': (incompatible with insecure). root certificate file to use for validating the openstack certificate<br />
* '''use_existing_flavors''': (By default false). Set to "True" to use the closer flavor with enough resources instead of creating a new flavor with the exact requirements. This option does not work for EPA (cpu pinning, huge pages, ...) where openmano still tries to create a flavor with the needed extra expects. Use this options when you do not have admin credentials (Available from future v2.0.2 version)<br />
* '''vim_type''': Set to "VIO" to use VMware Integrated openstack as VIM<br />
* '''use_internal_endpoint''': Set to True to force using internal endpoints<br />
<br />
For openstack API v3, the following parameters are required:<br />
* '''project_domain_id''', '''project_domain_name''': If not provided, "default" is used for project_domain_id<br />
* '''user_domain_id''', '''user_domain_name''': If not provided, "default" is used for user_domain_id<br />
* '''APIversion'''. Only required if the auth-url URL does not end with "v3". Set it to "v3.3" or "3" to use this openstack API version.<br />
<br />
ADVANCED configuration:<br />
<br />
* '''keypair''': To be added in addition to the keypair allocated on the VNF descriptor. Provide the name of an openstack keypair<br />
* '''dataplane_physical_net''': The physical network label used in Openstack both to identify SRIOV and passthrough interfaces (nova configuration) and also to specify the VLAN ranges used by SR-IOV interfaces (neutron configuration). In case of VMware Integrated Openstack (VIO) provide moref ID of distributed virtual switch.<br />
* '''use_floating_ip''': (By default false). When boolean true, a management interface of a VNFD is automatically assigned a floating_ip -if possible-. If there is not any floating ip avalialble, it tries to get one if there is only one pool. You can use a string "pool_id" (public network id) instead of boolean true, to indicate the pool to use in case there are several. Note that deployment is not aborted if failing to asign a floating ip. The prefered method instead of this is to use a provider network<br />
* '''dataplane_net_vlan_range''': In case of VMware Integrated Openstack (VIO) provide vlan ranges for the SRIOV (binding direct) networks in format ['start_ID - end_ID']<br />
* '''microversion''': This is an Openstack-only parameter that allows to specify a specific microversion to be used in nova. When using 'microversion: 2.32', it enables the use of Virtual Device Role Tagging, which allows to identify each VM interface with a tag (the tag will be the name of the interface in the VNFD) and convey that information to the VM as metadata. This implementation approach is due to the warning message in https://developer.openstack.org/api-guide/compute/microversions.html where it is stated that microversion backwards compatibility is not guaranteed and clients should always require a specific microversion. This functionality was introduced would not work with Openstack versions previous to Newton.<br />
* '''no_port_security_extension''': Use for those openstack that do not have the port_security_extension. This property allows neutron to disable the port security. If this option is set, port security will never be disabled regardless of the descriptor indication.<br />
* '''disable_network_port_security''': Use for those openstack that do not support port security enabled at network level (although port_security_extension is present). This property allows neutron to disable the port security by default at the time of network creation for all ports created on the created networks. <br />
<br />
The content of config is a yaml format text. The recomendation is to use a comma separated list between curly brackets {} and quotes. For instance, the following config is used to add a VMware Integrated Openstack where floating IP addresses will be assigned to VNF mgmt interfaces, all deployments must land in the availability_zone "controller", and the vlan ranges for the SRIOV networks will be 1-5 and 7-10:<br />
--config='{use_floating_ip: True, availability_zone: zone1, dataplane_net_vlan_range: ["1-5" , "7-10"]}}'<br />
<br />
==Using the OSM client==<br />
osm vim-create --name openstack-site --user admin --password userpwd --auth_url http://10.10.10.11:5000/v2.0 --tenant admin --account_type openstack --config='{security_groups: default, keypair: mykey}'</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=EPA_and_SDN_assist&diff=6089EPA and SDN assist2021-02-17T16:58:09Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
__TOC__<br />
<br />
=Introduction=<br />
OSM supports EPA (Enhanced Platform Awareness) since Rel ZERO (May 2016). EPA features like use of hugepages memory, CPU pinning, NUMA pinning, and the use of passthrough and SR-IOV interfaces, can be used in OSM's VNF descriptors since then.<br />
<br />
If your VIM supports EPA, then you don't need to do anything extra to use it from OSM. VIM connectors in OSM take advantage of EPA capabilities if the VIM supports it. All you need to do is build your descriptors and deploy.<br />
<br />
However, as you may have noticed, not all VIMs support EPA. To overcome this limitation, OSM has added the following two features:<br />
* Since Rel ONE (October 2016), OSM includes openvim as a reference VIM, with full support of EPA. You can follow the instructions in this '''[[OpenVIM_installation_(Release_THREE)|link]]''' to install and use openvim.<br />
* Since Rel TWO (April 2017), OSM includes a new capability in the Resource Orchestrator called '''[[#SDN assist|SDN assist]]'''. Through this capability, OSM can manage, via the RO, the dataplane underlay conectivity through an external SDN controller. The only requirement for the VIM is that it must able to use SRIOV and/or passthrough interfaces, and expose the assigned interfaces so that the RO can use them to create the underlay connectivity. By default, the SDN assist capability is disabled when a datacenter or VIM is added to OSM, but you can instruct OSM to enable it per datacenter.<br />
<br />
=SDN assist=<br />
<br />
==Introduction==<br />
The way SDN assist works, succinctly, is as follows. OSM will deploy the VMs of a NS with Passthrough and/or SRIOV interfaces, then will get from the VIM (in your case, Openstack) the compute node where the VM was deployed and the physical interface assigned to the VM (identified by its PCI address). Then, OSM will map those interfaces to Openflow ports in the switch making use of the mapping that you should have introduced in the system, and finally OSM will create the dataplane networks by talking to the SDN controller and connecting the appropriate Openflow ports to the same network.<br />
<br />
The module in charge of this is the OSM-RO (Resource Orchestrator). It uses an internal library to manage the underlay connectivity via SDN. The library relies on Openflow pro-active rules to configure the connectivity in the switch. The current library includes plugins for FloodLight, ONOS and OpenDayLight.<br />
<br />
==General requirements==<br />
The general requirements are:<br />
* A dataplane switch with Openflow capabilities that will connect the physical interfaces of the VIM compute nodes.<br />
* An external SDN controller controlling the previous dataplane switch.<br />
* The mapping between the switch ports (identified by name) and the compute node interfaces (identified by host-id and PCI address)<br />
* Some VIMs as Openstack requires admin credentials in order to be able to get the physical place of the SRIOV/passthrough VM interfaces<br />
<br />
In addition to the general requirements, every VIM will have to be properly configured.<br />
<br />
==Openstack configuration==<br />
You should do extra configuration to configure Openstack for running VNFs which use SRIOV or passthrough interfaces. You can find a reference guide in this '''[https://osm.etsi.org/wikipub/index.php/Openstack_configuration_(Release_THREE)#Configure_Openstack_for_OSM_.28EPA.29 link]'''.<br />
<br />
=Using SDN assist=<br />
<br />
==Adding a SDN controller to OSM==<br />
<br />
This is done through RO CLI. Enter in the RO container (lxc exec RO bash) and type:<br />
<br />
export OPENMANO_TENANT=osm # Indicate the RO tenant to use<br />
<br />
In order to set the information of an existing sdn controller, use the following sintax:<br />
root@RO:~# openmano sdn-controller-create -h<br />
usage: openmano sdn-controller-create [-h] [--verbose] [--debug]<br />
[--description DESCRIPTION] [--ip IP]<br />
[--port PORT] [--dpid DPID]<br />
[--type TYPE] [--user USER]<br />
[--passwd PASSWORD]<br />
name<br />
<br />
positional arguments:<br />
name name of the SDN controller<br />
<br />
optional arguments:<br />
-h, --help show this help message and exit<br />
--verbose, -v increase verbosity level. Use several times<br />
--debug, -d show debug information<br />
--description DESCRIPTION<br />
description of the SDN controller<br />
--ip IP IP of the SDN controller<br />
--port PORT Port of the SDN controller<br />
--dpid DPID DPID of the dataplane switch controlled by this SDN<br />
controller<br />
--type TYPE Specify the SDN controller type. Valid types are<br />
'opendaylight' and 'floodlight'<br />
--user USER user credentials for the SDN controller<br />
--passwd PASSWORD password credentials for the SDN controller<br />
<br />
<br />
For example:<br />
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 <br />
onos<br />
98113d4a-51b7-11e7-8f07-00163e1229e4 mySDN ACTIVE<br />
<br />
You can list the defined SDN controllers like this:<br />
root@RO:~# openmano sdn-controller-list<br />
{<br />
"sdn_controllers": [<br />
{<br />
"status": "ACTIVE", <br />
"password": "sdnpasswd", <br />
"uuid": "98113d4a-51b7-11e7-8f07-00163e1229e4", <br />
"last_error": null, <br />
"dpid": "56:55:12:12:12:12:12:12", <br />
"version": null, <br />
"user": "sdnuser", <br />
"ip": "192.168.15.2", <br />
"nets_with_same_vlan": "false", <br />
"type": "onos", <br />
"port": 8080, <br />
"name": "mySDN"<br />
}<br />
]<br />
}<br />
<br />
You can manage SDN controllers with sdn-controller-create/list/edit/delete<br />
<br />
Note that at SDN creation, connectivity and credentials are not checked.<br />
<br />
==Enabling SDN assist in a VIM (associate a SDN controller with a VIM)==<br />
<br />
If we check the information of the datacenter we can see that this is disabled by default. No information about SDN can be seen in the config section:<br />
<br />
root@RO:~# openmano datacenter-list mydc -vvv<br />
datacenter:<br />
config: null<br />
created_at: '2017-06-02T07:55:41'<br />
description: mydc<br />
name: mydc<br />
type: openstack<br />
uuid: dfcd6ca2-4768-11e7-8f07-00163e1229e4<br />
vim_tenants:<br />
- config:<br />
dataplane_physical_net: physnet_sriov<br />
use_floating_ip: true<br />
passwd: '******'<br />
user: osm<br />
vim_tenant_id: null<br />
vim_tenant_name: osm<br />
vim_url: http://10.0.0.12:5000/v2.0<br />
vim_url_admin: null<br />
<br />
In order to add the sdn controller to the datacenter:<br />
root@RO:~# openmano datacenter-edit mydc --sdn-controller mySDN<br />
Edit datacenter mydc (y/N)? y<br />
dfcd6ca2-4768-11e7-8f07-00163e1229e4 mydc 2017-06-02T07:55:41 <br />
<br />
And now we can see this information in the datacenter:<br />
root@RO:~# openmano datacenter-list mydc -vvv<br />
datacenter:<br />
config:<br />
sdn-controller: 98113d4a-51b7-11e7-8f07-00163e1229e4<br />
created_at: '2017-06-02T07:55:41'<br />
description: mydc<br />
name: mydc<br />
type: openstack<br />
uuid: dfcd6ca2-4768-11e7-8f07-00163e1229e4<br />
vim_tenants:<br />
- config:<br />
dataplane_physical_net: physnet_sriov<br />
use_floating_ip: true<br />
passwd: '******'<br />
user: osm<br />
vim_tenant_id: null<br />
vim_tenant_name: osm<br />
vim_url: http://10.0.0.12:5000/v2.0<br />
vim_url_admin: null<br />
<br />
In order to remove the sdn controller:<br />
root@RO:~# openmano datacenter-edit mydc --sdn-controller null<br />
Edit datacenter mydc (y/N)? y<br />
dfcd6ca2-4768-11e7-8f07-00163e1229e4 mydc 2017-06-02T07:55:41<br />
<br />
==Adding a port mapping==<br />
A sample of sdn port mapping can be found in RO/sdn/sdn_port_mapping.yaml<br />
root@RO:~# tail -n 24 RO/sdn/sdn_port_mapping.yaml<br />
---<br />
#The mapping is composed of a list of compute nodes. Each compute nodes has two elements:<br />
#"compute_node": name to identify the compute node within the datacenter<br />
#"ports": list of ports mapped to a switch for that compute node.<br />
#The information to identify the SDN controller and the dataplane switch is obtained from the datacenter information<br />
- compute_node: "compute node 1"<br />
ports:<br />
#Each mapped port contains the following information:<br />
#"pci": pci address of the port in the compute node. This is a mandatory parameter<br />
#"switch_mac": MAC address of the corresponding port in the dataplane switch.<br />
#"switch_port": Openflow name of the port in the dataplane switch.<br />
#"switch_mac" or "switch_port" must be specified. Both of them could be specified<br />
- pci: "0000:81:00.0"<br />
switch_port: "port-2/1"<br />
- pci: "0000:81:00.1"<br />
switch_mac: "52:54:00:94:21:22"<br />
- compute_node: "compute node 2"<br />
ports:<br />
- pci: "0000:81:00.0"<br />
switch_port: "port-2/3"<br />
switch_mac: "52:54:00:94:22:21"<br />
- pci: "0000:81:00.1"<br />
switch_port: "port-2/4"<br />
switch_mac: "52:54:00:94:22:22"<br />
<br />
In order to populate the port-mapping:<br />
root@RO:~# openmano datacenter-sdn-port-mapping-set mydc RO/sdn/sdn_port_mapping.yaml<br />
sdn_port_mapping:<br />
- {compute_node: compute node 1, ofc_id: 963b5616-4769-11e7-8f07-00163e1229e4, pci: '0000:81:00.0',<br />
region: dfcd6ca2-4768-11e7-8f07-00163e1229e4, switch_dpid: '00:01:64:00:6a:e6:b3:14',<br />
switch_mac: null, switch_port: port-2/1, uuid: 977b50f8-51b9-11e7-8f07-00163e1229e4}<br />
- {compute_node: compute node 1, ofc_id: 963b5616-4769-11e7-8f07-00163e1229e4, pci: '0000:81:00.1',<br />
region: dfcd6ca2-4768-11e7-8f07-00163e1229e4, switch_dpid: '00:01:64:00:6a:e6:b3:14',<br />
switch_mac: '52:54:00:94:21:22', switch_port: null, uuid: 977b50f9-51b9-11e7-8f07-00163e1229e4}<br />
- {compute_node: compute node 2, ofc_id: 963b5616-4769-11e7-8f07-00163e1229e4, pci: '0000:81:00.0',<br />
region: dfcd6ca2-4768-11e7-8f07-00163e1229e4, switch_dpid: '00:01:64:00:6a:e6:b3:14',<br />
switch_mac: '52:54:00:94:22:21', switch_port: port-2/3, uuid: 977b50fa-51b9-11e7-8f07-00163e1229e4}<br />
- {compute_node: compute node 2, ofc_id: 963b5616-4769-11e7-8f07-00163e1229e4, pci: '0000:81:00.1',<br />
region: dfcd6ca2-4768-11e7-8f07-00163e1229e4, switch_dpid: '00:01:64:00:6a:e6:b3:14',<br />
switch_mac: '52:54:00:94:22:22', switch_port: port-2/4, uuid: 977b50fb-51b9-11e7-8f07-00163e1229e4}<br />
<br />
To overwrite the port mapping the same instruction can be used.<br />
<br />
To clear the port mapping:<br />
root@RO:~# openmano datacenter-sdn-port-mapping-clear mydc<br />
Clean SDN port mapping for datacenter dfcd6ca2-4768-11e7-8f07-00163e1229e4 (y/N)? y<br />
{result: 4 deleted from of_port_mapping}<br />
<br />
==Managing dataplane networks with external connectivity==<br />
Create a new network in the VIM and an associated network for the SDN assist<br />
root@RO:~# openmano vim-net-create --name mydc_net --type data --datacenter mydc<br />
d30315d5-4ed7-442b-94e4-cf81d058ae00 mydc_net ACTIVE <br />
<br />
Now you can include in the network a port (and a vlan as optional parameter) of the dataplane switch that will provide access to an external element. As an additional parameter, the mac address of the external element can also be specified in this command using --mac<br />
root@RO:~# openmano vim-net-sdn-attach mydc_net Te1/1 --vlan 300 --datacenter mydc<br />
Success 062a50b4-51bd-11e7-9496-00163eb5e904<br />
<br />
Now when listing the network we can see this port belongs to vim network and if we deploy a NS using dataplane interfaces connected to this network all of them will be able to communicate with the external element/network through the attached port.<br />
root@RO:~# openmano vim-net-list --datacenter mydc mydc_net<br />
d30315d5-4ed7-442b-94e4-cf81d058ae00 mydc_net ACTIVE 2017-06-15T11:23:08Z<br />
sdn_attached_ports:<br />
- switch_port: Te1/1<br />
uuid: 062a50b4-51bd-11e7-9496-00163eb5e904<br />
vlan: 300<br />
<br />
In order to remove a port from a network you can use the --id option to remove a specific port from the network or --all to remove all of them:<br />
root@RO:~# openmano vim-net-sdn-detach mydc_net --all --datacenter mydc<br />
Confirm action' (y/N)? y<br />
Success<br />
root@RO:~# openmano vim-net-list --datacenter mydc mydc_net<br />
d30315d5-4ed7-442b-94e4-cf81d058ae00 mydc_net ACTIVE 2017-06-15T11:23:08Z<br />
<br />
=Additional information=<br />
<br />
*[[Developer HowTo for openvim#Creating_a_new_SDN_plugin|Creating a new plugin for SDN assist]]</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=How_to_install_OSM_in_Amazon_EC2&diff=6088How to install OSM in Amazon EC22021-02-17T16:56:25Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
= Requirements =<br />
<br />
'''Resources:'''<br />
* MINIMUM: 2 CPUs, 4 GB RAM, 20GB disk and a single interface with Internet access<br />
* RECOMMENDED: 2 CPUs, 8 GB RAM, 40GB disk and a single interface with Internet access<br />
<br />
'''Instance Type/AMI:'''<br />
* Recommended Instance Type: m5.xlarge (https://aws.amazon.com/ec2/instance-types/)<br />
* Ubuntu 16.04 (64-bit variant required) as base AMI (http://releases.ubuntu.com/16.04/)<br />
* Ubuntu AMI’s: https://cloud-images.ubuntu.com/locator/ec2/<br />
* Launching an EC2 instance: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html#ec2-launch-instance<br />
<br />
<br />
'''''The following installation steps assume that you already have an EC2 instance launched which meets the minimum requirements mentioned above.'''''<br />
<br />
<br />
= OSM Installation =<br />
<br />
1. Install OSM and save installation logs to a file for troubleshooting if needed:<br />
<br />
wget https://osm-download.etsi.org/ftp/osm-6.0-six/install_osm.sh<br />
chmod +x install_osm.sh<br />
./install_osm.sh 2>&1 | tee osm_install_log.txt<br />
<br />
2. Answer the following dialog box questions accordingly:<br />
<br />
* The installation will configure LXD, install juju, install docker CE and init a docker swarm, as pre-requirements. Do you want to proceed (Y/n)? Y<br />
* Do you want to configure the LXD bridge? Yes<br />
* Do you want to setup an IPv4 subnet? Yes<br />
* ''<< '''Default values''' apply for next questions >>''<br />
* Do you want to setup an IPv6 subnet? No<br />
<br />
3. You will notice 10 Docker Containers created on the EC2 instance. Check the status of the containers and Docker service:<br />
docker stack ps osm |grep -i running<br />
docker service ls<br />
<br />
4. Create the AWS VIM Account (AWS Site)<br />
<br />
NOTE: Make sure to select the region in which your EC2 instance resides.<br />
<br />
osm vim-create --name aws-site --user <aws-access-key> --password <aws-secret-key> --auth_url https://aws.amazon.com --tenant admin --account_type aws --config '{region_name: us-west-2, flavor_info: “{t2.nano: {cpus: 1, disk: 100, ram: 512}, t2.micro: {cpus: 1, disk: 100, ram: 1024}, t2.small: {cpus: 1, disk: 100, ram: 2048}, m1.small: {cpus: 1, disk: 160, ram: 1741}}”}'<br />
<br />
5. Access the OSM Console via the EC2 Instance’s Private IP from another EC2 Instance in the same subnet:<br />
<br />
NOTE: You can use a Windows instance to easily access the OSM Console. <br />
Launching an EC2 Windows Instance:<br />
https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/EC2_GetStarted.html#ec2-launch-instance<br />
<br />
http://1.2.3.4<br />
username: admin<br />
password: admin<br />
<br />
6. Deploy/Test a network service by using any of the available VNF and NS packagers from ‘https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/’:<br />
wget https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_1alt_nsd.tar.gz<br />
wget https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/hackfest_1alt_vnfd.tar.gz<br />
<br />
osm vnfd-create hackfest_1alt_vnfd.tar.gz<br />
osm nsd-create hackfest_1alt_nsd.tar.gz<br />
osm ns-create --ns_name hackfest1alt --nsd_name hackfest1alt-ns --vim_account aws-site --ssh_keys <PUBKEY_FILE> --config '{vld: [ {name: mgmtnet, vim-network-name: subnet-xxxxxxx} ] }'<br />
osm ns-list<br />
osm ns-show hackfest1alt</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Advanced_OSM_installation_procedures&diff=6087Advanced OSM installation procedures2021-02-17T16:56:14Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
= Installer commands =<br />
<br />
'''Usage:'''<br />
./install_osm.sh [OPTIONS]<br />
With no options, it will install OSM from binaries.<br />
<br />
'''Options:'''<br />
--uninstall: uninstall OSM: remove the containers and delete NAT rules<br />
--source: install OSM from source code using the latest stable tag<br />
-r <repo>: use specified repository name for osm packages<br />
-R <release>: use specified release for osm binaries (deb packages, lxd images, ...)<br />
-u <repo base>: use specified repository url for osm packages<br />
-k <repo key>: use specified repository public key url<br />
-b <refspec>: install OSM from source code using a specific branch (master, v2.0, ...) or tag<br />
-b master (main dev branch)<br />
-b v2.0 (v2.0 branch)<br />
-b tags/v1.1.0 (a specific tag)<br />
...<br />
--lxdimages: download lxd images from OSM repository instead of creating them from scratch<br />
-l <lxd_repo>: use specified repository url for lxd images<br />
-p <path>: use specified repository path for lxd images<br />
--lightweight: install lightweight build of OSM (default installation)<br />
--soui: install classic build of OSM (Rel THREE v3.1, based on LXD containers, with SO and UI)<br />
--vimemu: additionally deploy the VIM emulator as a docker container<br />
--elk_stack: additionally deploy an ELK docker stack for event logging<br />
--pm_stack: additionally deploy a Prometheus+Grafana stack for performance monitoring (PM)<br />
-o <ADDON>: do not install OSM, but ONLY one of the addons (vimemu, elk_stack, pm_stack) (assumes OSM is already installed)<br />
--develop: (deprecated, use '-b master') install OSM from source code using the master branch<br />
--nat: install only NAT rules<br />
--noconfigure: DO NOT install osmclient, DO NOT install NAT rules, DO NOT configure modules<br />
--showopts: print chosen options and exit (only for debugging)<br />
-y: do not prompt for confirmation, assumes yes<br />
-D <devops path> use local devops installation path<br />
-h / --help: prints help</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_client&diff=6086OSM client2021-02-17T16:56:02Z<p>Ramonsalguer: </p>
<hr />
<div>{{MARKDOWN}}<br />
<br />
**THIS PAGE IS DEPRECATED**. OSM User Guide has been moved to a new location: **<https://osm.etsi.org/docs/user-guide/>**<br />
<br />
---<br />
<br />
In those cases where you have an OSM already installed in a remote server, you might still want to operate it from your local computer using the OSM client. The OSM client provides you a client library and a command-line tool to operate OSM..<br />
<br />
## Installation<br />
<br />
OSM client comes bundled with OSM installation, so if you successfully installed OSM, you already have it.<br />
<br />
In addition, you can also install it in a different computer. In order to install OSM client, you will need a Linux machine and follow this procedure.<br />
<br />
```bash<br />
wget -qO - https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/OSM%20ETSI%20Release%20Key.gpg | sudo apt-key add -<br />
sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX stable devops osmclient"<br />
sudo apt-get update<br />
sudo -H pip install python-magic<br />
sudo apt-get install python-osmclient<br />
```<br />
<br />
## Usage (client commands)<br />
<br />
Once installed, type “osm” to see a list of commands. If installed in a host different from where OSM is running, at minimum you will need to specify the OSM host, either via an environment variable or via the osm command line (see “osm --help” for info).<br />
<br />
```bash<br />
export OSM_HOSTNAME="127.0.0.1"<br />
```<br />
<br />
**Usage:**<br />
<br />
```bash<br />
osm [OPTIONS] COMMAND [ARGS]...<br />
```<br />
<br />
**Options:**<br />
<br />
```bash<br />
--hostname TEXT hostname of server. Also can set OSM_HOSTNAME in<br />
environment<br />
--user TEXT user (defaults to admin). Also can set OSM_USER in<br />
environment<br />
--password TEXT password (defaults to admin). Also can set OSM_PASSWORD in<br />
environment<br />
--project TEXT project (defaults to admin). Also can set OSM_PROJECT in<br />
environment<br />
--help Show this message and exit.<br />
```<br />
<br />
**Commands:**<br />
<br />
```bash<br />
netslice-instance-create creates a new Network Slice Instance<br />
netslice-instance-delete deletes a Network Slice Instance (NSI)<br />
netslice-instance-list list all Network Slice Instances (NSI)<br />
netslice-instance-op-list shows the history of operations over a...<br />
netslice-instance-op-show shows the info of an operation over a Network<br />
Slice Instance(NSI)<br />
netslice-instance-show shows the content of a Network Slice Instance<br />
(NSI)<br />
netslice-template-create creates a new Network Slice Template (NST)<br />
netslice-template-delete deletes a Network Slice Template (NST)<br />
netslice-template-list list all Network Slice Templates (NST) in the...<br />
netslice-template-show shows the content of a Network Slice Template<br />
(NST)<br />
netslice-template-update updates a Network Slice Template (NST)<br />
nf-list list all NF instances Options: --ns TEXT NS...<br />
nfpkg-create creates a new NFpkg<br />
nfpkg-delete deletes a NFpkg<br />
nfpkg-list list all NF pkg (VNF pkg, PNF pkg, HNF pkg)...<br />
nfpkg-show shows the content of a NF Descriptor<br />
nfpkg-update updates a NFpkg<br />
ns-action executes an action/primitive over a NS...<br />
ns-alarm-create creates a new alarm for a NS instance<br />
ns-create creates a new Network Service instance<br />
ns-delete deletes a NS instance<br />
ns-list list all NS instances Options: --filter...<br />
ns-metric-export exports a metric to the internal OSM bus,...<br />
ns-op-list shows the history of operations over a NS...<br />
ns-op-show shows the info of an operation<br />
ns-show shows the info of a NS instance<br />
nsd-create creates a new NSD/NSpkg<br />
nsd-delete deletes a NSD/NSpkg<br />
nsd-list list all NSD/NS pkg in the system<br />
nsd-show shows the content of a NSD<br />
nsd-update updates a NSD/NSpkg<br />
nsi-create creates a new Network Slice Instance<br />
nsi-delete deletes a Network Slice Instance (NSI)<br />
nsi-list list all Network Slice Instances (NSI)<br />
nsi-op-list shows the history of operations over a...<br />
nsi-op-show shows the info of an operation over a Network<br />
Slice Instance(NSI)<br />
nsi-show shows the content of a Network Slice Instance<br />
(NSI)<br />
nspkg-create creates a new NSD/NSpkg<br />
nspkg-delete deletes a NSD/NSpkg<br />
nspkg-list list all NSD/NS pkg in the system<br />
nspkg-show shows the content of a NSD<br />
nspkg-update updates a NSD/NSpkg<br />
nst-create creates a new Network Slice Template (NST)<br />
nst-delete deletes a Network Slice Template (NST)<br />
nst-list list all Network Slice Templates (NST) in the...<br />
nst-show shows the content of a Network Slice Template<br />
(NST)<br />
nst-update updates a Network Slice Template (NST)<br />
pdu-create adds a new Physical Deployment Unit to the<br />
catalog<br />
pdu-delete deletes a Physical Deployment Unit (PDU)<br />
pdu-list list all Physical Deployment Units (PDU)<br />
pdu-show shows the content of a Physical Deployment Unit<br />
(PDU)<br />
project-create Creates a new project NAME: name of the...<br />
project-delete deletes a project NAME: name or ID of the...<br />
project-list list all projects<br />
project-show shows the details of a project NAME: name or...<br />
project-update Update a project name :param ctx: :param...<br />
role-create creates a role<br />
role-delete deletes a role<br />
role-list list all roles<br />
role-show show specific role<br />
role-update updates a role<br />
sdnc-create creates a new SDN controller<br />
sdnc-delete deletes an SDN controller NAME: name or ID of...<br />
sdnc-list list all SDN controllers<br />
sdnc-show shows the details of an SDN controller NAME:...<br />
sdnc-update updates an SDN controller<br />
upload-package uploads a VNF package or NS package FILENAME:...<br />
user-create Creates a new user USERNAME: name of the...<br />
user-delete deletes a user NAME: name or ID of the user...<br />
user-list list all users<br />
user-show shows the details of a user NAME: name or ID...<br />
user-update Update a user information USERNAME: name of...<br />
vim-create creates a new VIM account<br />
vim-delete deletes a VIM account NAME: name or ID of the...<br />
vim-list list all VIM accounts<br />
vim-show shows the details of a VIM account NAME: name...<br />
vim-update updates a VIM account<br />
vnf-list list all NF instances<br />
vnf-scale Executes a VNF scale (adding/removing VDUs)...<br />
vnf-show shows the info of a VNF instance<br />
vnfd-create creates a new VNFD/VNFpkg<br />
vnfd-delete deletes a VNFD/VNFpkg<br />
vnfd-list list all VNFD/VNF pkg in the system<br />
vnfd-show shows the content of a VNFD<br />
vnfd-update updates a new VNFD/VNFpkg<br />
vnfpkg-create creates a new VNFD/VNFpkg<br />
vnfpkg-delete deletes a VNFD/VNFpkg<br />
vnfpkg-list list all VNFD/VNF pkg in the system<br />
vnfpkg-show shows the content of a VNFD<br />
vnfpkg-update updates a VNFD/VNFpkg<br />
wim-create creates a new WIM account<br />
wim-delete deletes a WIM account NAME: name or ID of the...<br />
wim-list list all WIM accounts<br />
wim-show shows the details of a WIM account NAME: name...<br />
wim-update updates a WIM account<br />
```<br />
<br />
## Enable autocompletion<br />
<br />
You can enable autocompletion in OSM client by creating a file osm-complete.sh in the following way:<br />
<br />
```bash<br />
mkdir -p $HOME/.bash_completion.d<br />
_OSM_COMPLETE=source osm > $HOME/.bash_completion.d/osm-complete.sh<br />
```<br />
<br />
Then you can add the following to your $HOME/.bashrc file:<br />
```bash<br />
. .bash_completion.d/osm-complete.sh<br />
```<br />
<br />
## Other installation methods<br />
<br />
### Installing from git repo<br />
<br />
```bash<br />
# Ubuntu pre-requirements<br />
sudo apt install python-pip libcurl4-gnutls-dev libgnutls-dev<br />
# CentOS pre-requirements<br />
# sudo yum install python-pip libcurl-devel gnutls-devel<br />
sudo -H pip install python-magic<br />
# Install OSM client from the git repo.<br />
# You can install the latest client from master branch in this way:<br />
sudo -H pip install git+https://osm.etsi.org/gerrit/osm/osmclient<br />
# You could also install a specific tag/version in this way<br />
sudo -H pip install git+https://osm.etsi.org/gerrit/osm/osmclient@v6.0.1<br />
```<br />
<br />
### Installing from cloned repo (for developers)<br />
<br />
```bash<br />
# Ubuntu pre-requirements<br />
sudo apt install python-pip libcurl4-gnutls-dev libgnutls-dev<br />
# Make sure that <br />
# sudo yum install python-pip libcurl-devel gnutls-devel<br />
sudo -H pip install python-magic<br />
# Clone the osmclient repo and install OSM client from the git repo.<br />
git clone https://osm.etsi.org/gerrit/osm/osmclient<br />
sudo -H pip install osmclient<br />
```<br />
<br />
## Using osmclient as a library to interact with OSM<br />
<br />
Assuming that you have installed python-osmclient package, it's pretty simple to write some Python code to interact with OSM.<br />
<br />
### Simple Python code to get the list of NS packages<br />
<br />
```python<br />
from osmclient import client<br />
from osmclient.common.exceptions import ClientException<br />
hostname = "127.0.0.1"<br />
myclient = client.Client(host=hostname, sol005=True)<br />
resp = myclient.nsd.list()<br />
print yaml.safe_dump(resp)<br />
```<br />
<br />
### Simple Python code to get the list of VNF packages from a specific user and project<br />
<br />
The code will print for each package a pretty table, then the full details in yaml<br />
```python<br />
from osmclient import client<br />
from osmclient.common.exceptions import ClientException<br />
import yaml<br />
from prettytable import PrettyTable<br />
hostname = "127.0.0.1"<br />
user = admin<br />
password = admin<br />
project = admin<br />
kwargs = {}<br />
if user is not None:<br />
kwargs['user']=user<br />
if password is not None:<br />
kwargs['password']=password<br />
if project is not None:<br />
kwargs['project']=project<br />
myclient = client.Client(host=hostname, sol005=True, **kwargs)<br />
resp = myclient.vnfd.list()<br />
print yaml.safe_dump(resp)<br />
```</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_client&diff=6085OSM client2021-02-17T16:55:22Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
{{MARKDOWN}}<br />
<br />
In those cases where you have an OSM already installed in a remote server, you might still want to operate it from your local computer using the OSM client. The OSM client provides you a client library and a command-line tool to operate OSM..<br />
<br />
## Installation<br />
<br />
OSM client comes bundled with OSM installation, so if you successfully installed OSM, you already have it.<br />
<br />
In addition, you can also install it in a different computer. In order to install OSM client, you will need a Linux machine and follow this procedure.<br />
<br />
```bash<br />
wget -qO - https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/OSM%20ETSI%20Release%20Key.gpg | sudo apt-key add -<br />
sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX stable devops osmclient"<br />
sudo apt-get update<br />
sudo -H pip install python-magic<br />
sudo apt-get install python-osmclient<br />
```<br />
<br />
## Usage (client commands)<br />
<br />
Once installed, type “osm” to see a list of commands. If installed in a host different from where OSM is running, at minimum you will need to specify the OSM host, either via an environment variable or via the osm command line (see “osm --help” for info).<br />
<br />
```bash<br />
export OSM_HOSTNAME="127.0.0.1"<br />
```<br />
<br />
**Usage:**<br />
<br />
```bash<br />
osm [OPTIONS] COMMAND [ARGS]...<br />
```<br />
<br />
**Options:**<br />
<br />
```bash<br />
--hostname TEXT hostname of server. Also can set OSM_HOSTNAME in<br />
environment<br />
--user TEXT user (defaults to admin). Also can set OSM_USER in<br />
environment<br />
--password TEXT password (defaults to admin). Also can set OSM_PASSWORD in<br />
environment<br />
--project TEXT project (defaults to admin). Also can set OSM_PROJECT in<br />
environment<br />
--help Show this message and exit.<br />
```<br />
<br />
**Commands:**<br />
<br />
```bash<br />
netslice-instance-create creates a new Network Slice Instance<br />
netslice-instance-delete deletes a Network Slice Instance (NSI)<br />
netslice-instance-list list all Network Slice Instances (NSI)<br />
netslice-instance-op-list shows the history of operations over a...<br />
netslice-instance-op-show shows the info of an operation over a Network<br />
Slice Instance(NSI)<br />
netslice-instance-show shows the content of a Network Slice Instance<br />
(NSI)<br />
netslice-template-create creates a new Network Slice Template (NST)<br />
netslice-template-delete deletes a Network Slice Template (NST)<br />
netslice-template-list list all Network Slice Templates (NST) in the...<br />
netslice-template-show shows the content of a Network Slice Template<br />
(NST)<br />
netslice-template-update updates a Network Slice Template (NST)<br />
nf-list list all NF instances Options: --ns TEXT NS...<br />
nfpkg-create creates a new NFpkg<br />
nfpkg-delete deletes a NFpkg<br />
nfpkg-list list all NF pkg (VNF pkg, PNF pkg, HNF pkg)...<br />
nfpkg-show shows the content of a NF Descriptor<br />
nfpkg-update updates a NFpkg<br />
ns-action executes an action/primitive over a NS...<br />
ns-alarm-create creates a new alarm for a NS instance<br />
ns-create creates a new Network Service instance<br />
ns-delete deletes a NS instance<br />
ns-list list all NS instances Options: --filter...<br />
ns-metric-export exports a metric to the internal OSM bus,...<br />
ns-op-list shows the history of operations over a NS...<br />
ns-op-show shows the info of an operation<br />
ns-show shows the info of a NS instance<br />
nsd-create creates a new NSD/NSpkg<br />
nsd-delete deletes a NSD/NSpkg<br />
nsd-list list all NSD/NS pkg in the system<br />
nsd-show shows the content of a NSD<br />
nsd-update updates a NSD/NSpkg<br />
nsi-create creates a new Network Slice Instance<br />
nsi-delete deletes a Network Slice Instance (NSI)<br />
nsi-list list all Network Slice Instances (NSI)<br />
nsi-op-list shows the history of operations over a...<br />
nsi-op-show shows the info of an operation over a Network<br />
Slice Instance(NSI)<br />
nsi-show shows the content of a Network Slice Instance<br />
(NSI)<br />
nspkg-create creates a new NSD/NSpkg<br />
nspkg-delete deletes a NSD/NSpkg<br />
nspkg-list list all NSD/NS pkg in the system<br />
nspkg-show shows the content of a NSD<br />
nspkg-update updates a NSD/NSpkg<br />
nst-create creates a new Network Slice Template (NST)<br />
nst-delete deletes a Network Slice Template (NST)<br />
nst-list list all Network Slice Templates (NST) in the...<br />
nst-show shows the content of a Network Slice Template<br />
(NST)<br />
nst-update updates a Network Slice Template (NST)<br />
pdu-create adds a new Physical Deployment Unit to the<br />
catalog<br />
pdu-delete deletes a Physical Deployment Unit (PDU)<br />
pdu-list list all Physical Deployment Units (PDU)<br />
pdu-show shows the content of a Physical Deployment Unit<br />
(PDU)<br />
project-create Creates a new project NAME: name of the...<br />
project-delete deletes a project NAME: name or ID of the...<br />
project-list list all projects<br />
project-show shows the details of a project NAME: name or...<br />
project-update Update a project name :param ctx: :param...<br />
role-create creates a role<br />
role-delete deletes a role<br />
role-list list all roles<br />
role-show show specific role<br />
role-update updates a role<br />
sdnc-create creates a new SDN controller<br />
sdnc-delete deletes an SDN controller NAME: name or ID of...<br />
sdnc-list list all SDN controllers<br />
sdnc-show shows the details of an SDN controller NAME:...<br />
sdnc-update updates an SDN controller<br />
upload-package uploads a VNF package or NS package FILENAME:...<br />
user-create Creates a new user USERNAME: name of the...<br />
user-delete deletes a user NAME: name or ID of the user...<br />
user-list list all users<br />
user-show shows the details of a user NAME: name or ID...<br />
user-update Update a user information USERNAME: name of...<br />
vim-create creates a new VIM account<br />
vim-delete deletes a VIM account NAME: name or ID of the...<br />
vim-list list all VIM accounts<br />
vim-show shows the details of a VIM account NAME: name...<br />
vim-update updates a VIM account<br />
vnf-list list all NF instances<br />
vnf-scale Executes a VNF scale (adding/removing VDUs)...<br />
vnf-show shows the info of a VNF instance<br />
vnfd-create creates a new VNFD/VNFpkg<br />
vnfd-delete deletes a VNFD/VNFpkg<br />
vnfd-list list all VNFD/VNF pkg in the system<br />
vnfd-show shows the content of a VNFD<br />
vnfd-update updates a new VNFD/VNFpkg<br />
vnfpkg-create creates a new VNFD/VNFpkg<br />
vnfpkg-delete deletes a VNFD/VNFpkg<br />
vnfpkg-list list all VNFD/VNF pkg in the system<br />
vnfpkg-show shows the content of a VNFD<br />
vnfpkg-update updates a VNFD/VNFpkg<br />
wim-create creates a new WIM account<br />
wim-delete deletes a WIM account NAME: name or ID of the...<br />
wim-list list all WIM accounts<br />
wim-show shows the details of a WIM account NAME: name...<br />
wim-update updates a WIM account<br />
```<br />
<br />
## Enable autocompletion<br />
<br />
You can enable autocompletion in OSM client by creating a file osm-complete.sh in the following way:<br />
<br />
```bash<br />
mkdir -p $HOME/.bash_completion.d<br />
_OSM_COMPLETE=source osm > $HOME/.bash_completion.d/osm-complete.sh<br />
```<br />
<br />
Then you can add the following to your $HOME/.bashrc file:<br />
```bash<br />
. .bash_completion.d/osm-complete.sh<br />
```<br />
<br />
## Other installation methods<br />
<br />
### Installing from git repo<br />
<br />
```bash<br />
# Ubuntu pre-requirements<br />
sudo apt install python-pip libcurl4-gnutls-dev libgnutls-dev<br />
# CentOS pre-requirements<br />
# sudo yum install python-pip libcurl-devel gnutls-devel<br />
sudo -H pip install python-magic<br />
# Install OSM client from the git repo.<br />
# You can install the latest client from master branch in this way:<br />
sudo -H pip install git+https://osm.etsi.org/gerrit/osm/osmclient<br />
# You could also install a specific tag/version in this way<br />
sudo -H pip install git+https://osm.etsi.org/gerrit/osm/osmclient@v6.0.1<br />
```<br />
<br />
### Installing from cloned repo (for developers)<br />
<br />
```bash<br />
# Ubuntu pre-requirements<br />
sudo apt install python-pip libcurl4-gnutls-dev libgnutls-dev<br />
# Make sure that <br />
# sudo yum install python-pip libcurl-devel gnutls-devel<br />
sudo -H pip install python-magic<br />
# Clone the osmclient repo and install OSM client from the git repo.<br />
git clone https://osm.etsi.org/gerrit/osm/osmclient<br />
sudo -H pip install osmclient<br />
```<br />
<br />
## Using osmclient as a library to interact with OSM<br />
<br />
Assuming that you have installed python-osmclient package, it's pretty simple to write some Python code to interact with OSM.<br />
<br />
### Simple Python code to get the list of NS packages<br />
<br />
```python<br />
from osmclient import client<br />
from osmclient.common.exceptions import ClientException<br />
hostname = "127.0.0.1"<br />
myclient = client.Client(host=hostname, sol005=True)<br />
resp = myclient.nsd.list()<br />
print yaml.safe_dump(resp)<br />
```<br />
<br />
### Simple Python code to get the list of VNF packages from a specific user and project<br />
<br />
The code will print for each package a pretty table, then the full details in yaml<br />
```python<br />
from osmclient import client<br />
from osmclient.common.exceptions import ClientException<br />
import yaml<br />
from prettytable import PrettyTable<br />
hostname = "127.0.0.1"<br />
user = admin<br />
password = admin<br />
project = admin<br />
kwargs = {}<br />
if user is not None:<br />
kwargs['user']=user<br />
if password is not None:<br />
kwargs['password']=password<br />
if project is not None:<br />
kwargs['project']=project<br />
myclient = client.Client(host=hostname, sol005=True, **kwargs)<br />
resp = myclient.vnfd.list()<br />
print yaml.safe_dump(resp)<br />
```</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=How_to_upgrade_the_OSM_Platform&diff=6084How to upgrade the OSM Platform2021-02-17T16:55:08Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
__TOC__<br />
<br />
== Upgrading the OSM platform ==<br />
Due to the new architecture and dockerized components introduced from OSM Release FOUR, OSM platform upgrade is easier than ever. Upgrading to the latest minor version is as simple as running again the installer:<br />
<br />
wget https://osm-download.etsi.org/ftp/osm-6.0-six/install_osm.sh<br />
chmod +x install_osm.sh<br />
./install_osm.sh<br />
<br />
You will be asked if you want to proceed with the installation and configuration of LXD, juju, docker CE and the initialization of a local docker swarm, as pre-requirements. Please answer "y".<br />
<br />
Then, some dialog messages related to LXD configuration will be shown. This is what you have to answer:<br />
* Do you want to configure the LXD bridge? '''Yes'''<br />
* Do you want to setup an IPv4 subnet? '''Yes'''<br />
* ''<< '''Default values''' apply for next questions >>''<br />
* Do you want to setup an IPv6 subnet? '''No'''<br />
<br />
That's all. You will have the newest OSM version installed.<br />
<br />
== Upgrading the OSM platform from docker images using the latest daily testing docker image or a specific tag ==<br />
<br />
<span style="color:red">Upgrading to the latest daily docker image might lead to potential issues. Moreover, every new re-deployment of the stack will involve a download of a new docker daily image if it exists. Unless you are really sure about what you are doing, please use this procedure with caution.</span><br />
<br />
You can use option -t in the installer to specify a specific docker tag to be used by the installer.<br />
<br />
To install the latest daily images:<br />
./install_osm.sh -t releasesix-daily<br />
<br />
To install a previous version e.g. v5.0.3:<br />
./install_osm.sh -t v5.0.3<br />
<br />
The previous commands will do the installation and deployment of the stack, but will not make it persistent after re-deployments of the stack (or reboots). In order to make it persistent, you will have to update the file "docker-compose.yaml". Below an example to update it to use releasesix-daily tag: <br />
<br />
sudo sed -i "s/ro\:\${TAG\:-latest}/ro\:\${TAG\:-releasesix-daily}/" /etc/osm/docker/docker-compose.yaml<br />
sudo sed -i "s/lcm\:\${TAG\:-latest}/lcm\:\${TAG\:-releasesix-daily}/" /etc/osm/docker/docker-compose.yaml<br />
sudo sed -i "s/mon\:\${TAG\:-latest}/mon\:\${TAG\:-releasesix-daily}/" /etc/osm/docker/docker-compose.yaml<br />
sudo sed -i "s/pol\:\${TAG\:-latest}/pol\:\${TAG\:-releasesix-daily}/" /etc/osm/docker/docker-compose.yaml<br />
sudo sed -i "s/nbi\:\${TAG\:-latest}/nbi\:\${TAG\:-releasesix-daily}/" /etc/osm/docker/docker-compose.yaml<br />
sudo sed -i "s/light-ui\:\${TAG\:-latest}/light-ui\:\${TAG\:-releasesix-daily}/" /etc/osm/docker/docker-compose.yaml<br />
sudo sed -i "s/keystone\:\${TAG\:-latest}/keystone\:\${TAG\:-releasesix-daily}/" /etc/osm/docker/docker-compose.yaml<br />
docker stack rm osm && sleep 20<br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
The osmclient will have to be updated independently. In order to use the latest "testing" osmclient, you will have to update the debian repo to use the testing repo, remove the previous debian package and install the one from the new repo as follows:<br />
sudo apt-get remove python-osmclient<br />
sudo add-apt-repository -r "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX stable osmclient"<br />
sudo add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX-daily testing osmclient"<br />
sudo apt-get update<br />
sudo apt-get install python-osmclient<br />
dpkg -l |grep python-osmclient #to check the installed version<br />
<br />
== Upgrading a specific component to use your own cloned repo (e.g. for developing purposes) ==<br />
<br />
<span style="color:red">Upgrading a specific OSM component without upgrading the others accordingly may lead to potential inconsistencies. Unless you are really sure about what you are doing, please use this procedure with caution.</span><br />
<br />
<span style="color:red">The procedure below involves building manually some docker images. The developer environment might require updating manually the MTU of the docker default "bridge" network following the procedure in this link: https://docs.docker.com/network/bridge/</span><br />
<br />
For RO (ro and ro-db):<br />
docker pull mysql:5<br />
git clone https://osm.etsi.org/gerrit/osm/RO<br />
#you can then work in the cloned repo, apply patches with git pull, etc.<br />
docker build RO -f RO/Dockerfile-local -t opensourcemano/ro:develop --no-cache<br />
docker service update osm_ro --force --image opensourcemano/ro:develop<br />
# In order to make this change persistent after reboots or restart of the docker stack<br />
# you will have to update the file /etc/osm/docker/docker-compose.yaml to reflect the change<br />
# in the docker image, for instance:<br />
# sudo sed -i "s/ro\:\${TAG\:-latest}/ro\:\${TAG\:-develop}/" /etc/osm/docker/docker-compose.yaml<br />
# docker stack rm osm && sleep 60<br />
# docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
For LCM:<br />
git clone https://osm.etsi.org/gerrit/osm/LCM<br />
#you can then work in the cloned repo, apply patches with git pull, etc.<br />
docker build LCM -f LCM/Dockerfile.local -t opensourcemano/lcm:develop --no-cache<br />
docker service update osm_lcm --force --image opensourcemano/lcm:develop<br />
# In order to make this change persistent after reboots or restart of the docker stack<br />
# you will have to update the file /etc/osm/docker/docker-compose.yaml to reflect the change<br />
# in the docker image, for instance:<br />
# sudo sed -i "s/lcm\:\${TAG\:-latest}/lcm\:\${TAG\:-develop}/" /etc/osm/docker/docker-compose.yaml<br />
# docker stack rm osm && sleep 60<br />
# docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
For MON:<br />
git clone https://osm.etsi.org/gerrit/osm/MON<br />
#you can then work in the cloned repo, apply patches with git pull, etc.<br />
docker build MON -f MON/docker/Dockerfile -t opensourcemano/mon:develop --no-cache<br />
docker service update osm_mon --force --image opensourcemano/mon:develop<br />
# In order to make this change persistent after reboots or restart of the docker stack<br />
# you will have to update the file /etc/osm/docker/docker-compose.yaml to reflect the change<br />
# in the docker image, for instance:<br />
# sudo sed -i "s/mon\:\${TAG\:-latest}/mon\:\${TAG\:-develop}/" /etc/osm/docker/docker-compose.yaml<br />
# docker stack rm osm && sleep 60<br />
# docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
For POL:<br />
git clone https://osm.etsi.org/gerrit/osm/POL<br />
#you can then work in the cloned repo, apply patches with git pull, etc.<br />
docker build POL -f POL/docker/Dockerfile -t opensourcemano/pol:develop --no-cache<br />
docker service update osm_pol --force --image opensourcemano/pol:develop<br />
# In order to make this change persistent after reboots or restart of the docker stack<br />
# you will have to update the file /etc/osm/docker/docker-compose.yaml to reflect the change<br />
# in the docker image, for instance:<br />
# sudo sed -i "s/pol\:\${TAG\:-latest}/pol\:\${TAG\:-develop}/" /etc/osm/docker/docker-compose.yaml<br />
# docker stack rm osm && sleep 60<br />
# docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
For NBI:<br />
git clone https://osm.etsi.org/gerrit/osm/NBI<br />
#you can then work in the cloned repo, apply patches with git pull, etc.<br />
docker build NBI -f NBI/Dockerfile.local -t opensourcemano/nbi:develop --no-cache<br />
docker service update osm_nbi --force --image opensourcemano/nbi:develop<br />
# In order to make this change persistent after reboots or restart of the docker stack<br />
# you will have to update the file /etc/osm/docker/docker-compose.yaml to reflect the change<br />
# in the docker image, for instance:<br />
# sudo sed -i "s/nbi\:\${TAG\:-latest}/nbi\:\${TAG\:-develop}/" /etc/osm/docker/docker-compose.yaml<br />
# docker stack rm osm && sleep 60<br />
# docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
For light UI:<br />
git clone https://osm.etsi.org/gerrit/osm/LW-UI<br />
#you can then work in the cloned repo, apply patches with git pull, etc.<br />
docker build LW-UI -f LW-UI/docker/Dockerfile -t opensourcemano/light-ui:develop --no-cache<br />
docker service update osm_light-ui --force --image opensourcemano/light-ui:develop<br />
# In order to make this change persistent after reboots or restart of the docker stack<br />
# you will have to update the file /etc/osm/docker/docker-compose.yaml to reflect the change<br />
# in the docker image, for instance:<br />
# sudo sed -i "s/light-ui\:\${TAG\:-latest}/light-ui\:\${TAG\:-develop}/" /etc/osm/docker/docker-compose.yaml<br />
# docker stack rm osm && sleep 60<br />
# docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
== (OLD, CURRENTLY NOT WORKING) Upgrading only a specific component from source code to use the master branch or an old version (advanced users) ==<br />
<br />
<span style="color:red">Upgrading a specific OSM component without upgrading the others accordingly may lead to potential inconsistencies. Unless you are really sure about what you are doing, please use this procedure with caution.</span><br />
<br />
You can use options -b and -m in the installer:<br />
./install_osm.sh --help<br />
usage: ./install_osm.sh [OPTIONS]<br />
Install OSM from binaries or source code (by default, from binaries)<br />
OPTIONS<br />
...<br />
-b <refspec>: install OSM from source code using a specific branch (master, v2.0, ...) or tag<br />
-b master (main dev branch)<br />
-b v2.0 (v2.0 branch)<br />
-b tags/v1.1.0 (a specific tag)<br />
...<br />
-m <MODULE>: install OSM but only rebuild the specified docker images (RO, LCM, NBI, LW-UI, MON, KAFKA, MONGO, NONE)<br />
<br />
Or to use master branch in LCM:<br />
./install_osm.sh -m LCM -b master<br />
<br />
Or to use an old version of MON:<br />
./install_osm.sh -m MON -b tags/v5.0.2</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=How_to_run_OSM_on_Vagrant&diff=6083How to run OSM on Vagrant2021-02-17T16:54:59Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
__TOC__<br />
<br />
=== Basic instructions ===<br />
<br />
Pre-built OSM vagrant images are available here: https://app.vagrantup.com/osm<br />
<br />
The pre-built image requires 4GB of memory and 2 VCPUs.<br />
<br />
1) Install vagrant (https://www.vagrantup.com) and virtualbox (https://www.virtualbox.org/)<br />
<br />
2) Create the initial Vagrantfile in a predefined directory of your choice:<br />
<br />
vagrant init osm/releasesix<br />
<br />
* Note: to ensure the latest version is downloaded, destroy any previous existing OSM boxes (vagrant box list / vagrant box remove)<br />
<br />
3) Edit the generated Vagrantfile if you need to customize, for example, opened ports and assigned memory:<br />
<br />
* If you would like to access the OSM Web client externally from the virtualbox VM, you can open up port 80 (mapped to 8080 at your host) by uncommenting this line:<br />
# config.vm.network "forwarded_port", guest: 80, host: 8080<br />
<br />
4) Start OSM:<br />
<br />
vagrant up<br />
<br />
* Note: warnings related to "Vagrant unable to mount VirtualBox shared folders" can be safely ignored.<br />
<br />
5) ssh to OSM:<br />
<br />
vagrant ssh<br />
<br />
You are ready to use OSM !<br />
<br />
=== Additional notes ===<br />
* If at any time you need to change something from the Vagrantfile, you can apply the changes by reloading the VM:<br />
vagrant reload<br />
<br />
* If you need to copy a file to your vagrant machine, just run 'vagrant ssh-config' and copy the private key path, then:<br />
scp -P 2222 -i /path/to/private_key someFileName.txt vagrant@127.0.0.1:<br />
<br />
* To use a manually downloaded image, add the box to Vagrant and create a matching Vagrantfile:<br />
vagrant box add osm/releasesix /path/to/vagrant.box<br />
vagrant init osm/releasesix<br />
<br />
* If at any point you need to add the optional components (elk_stack, pm_stack...) you can do so by downloading the installer from inside your VM and executing it with the -o option, for example:<br />
wget https://osm-download.etsi.org/ftp/osm-6.0-six/install_osm.sh<br />
chmod +x install_osm.sh<br />
./install_osm.sh -o pm_stack<br />
<br />
* Please note that you may need to add more forwarded ports, for example, to access Grafana after adding the pm_stack, you would need to add a line like this one to your Vagrantfile, then run 'vagrant reload':<br />
config.vm.network "forwarded_port", guest: 3000, host: 3000<br />
<br />
=== Vagrant + VIM Emulator Quickstart ===<br />
<br />
vagrant init osm/releasesix<br />
vagrant up<br />
vagrant ssh<br />
<br />
# startup VIM-EMU<br />
# new version of installer will have the vim-emu start by default<br />
sudo docker run --name vim-emu -t -d --restart always --privileged --pid='host' --network=netOSM -v /var/run/docker.sock:/var/run/docker.sock vim-emu-img python examples/osm_default_daemon_topology_2_pop.py<br />
<br />
export OSM_HOSTNAME=127.0.0.1<br />
export OSM_SOL005=True<br />
<br />
export VIMEMU_HOSTNAME=$(sudo docker inspect -f '<nowiki>{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}</nowiki>' vim-emu)<br />
<br />
osm vim-create --name emu-vim1 --user username --password password --auth_url http://$VIMEMU_HOSTNAME:6001/v2.0 --tenant tenantName --account_type openstack<br />
<br />
git clone https://osm.etsi.org/gerrit/osm/vim-emu.git<br />
osm vnfd-create vim-emu/examples/vnfs/ping.tar.gz<br />
osm vnfd-create vim-emu/examples/vnfs/pong.tar.gz<br />
osm nsd-create vim-emu/examples/services/pingpong_nsd.tar.gz<br />
osm ns-create --nsd_name pingpong --ns_name test --vim_account emu-vim1<br />
<br />
vagrant@vagrant:~$ osm ns-list<br />
+------------------+--------------------------------------+--------------------+---------------+---------------------------------------------------------------------------------------------+<br />
| ns instance name | id | operational status | config status | detailed status |<br />
+------------------+--------------------------------------+--------------------+---------------+---------------------------------------------------------------------------------------------+<br />
| test | 05a363b0-4ac1-49a1-a4b1-9680e39b1ade | init | init | Waiting ns ready at RO. RO_id=2c569b2a-b21f-495b-9837-6a469f565044; VMs: 0/2, networks: 0/1 |<br />
+------------------+--------------------------------------+--------------------+---------------+---------------------------------------------------------------------------------------------+<br />
vagrant@vagrant:~$ osm ns-list<br />
+------------------+--------------------------------------+--------------------+---------------+---------------------------------------------------------------------------------------------+<br />
| ns instance name | id | operational status | config status | detailed status |<br />
+------------------+--------------------------------------+--------------------+---------------+---------------------------------------------------------------------------------------------+<br />
| test | 05a363b0-4ac1-49a1-a4b1-9680e39b1ade | init | init | Waiting ns ready at RO. RO_id=2c569b2a-b21f-495b-9837-6a469f565044; VMs: 0/2, networks: 0/1 |<br />
+------------------+--------------------------------------+--------------------+---------------+---------------------------------------------------------------------------------------------+</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Release_FOUR&diff=6082OSM Release FOUR2021-02-17T16:54:49Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
Open Source MANO (OSM) is the open source community that aims to deliver a production-quality MANO stack for NFV, capable of consuming openly published information models, available to everyone, suitable for all VNFs, operationally significant and VIM-independent. OSM is aligned to NFV ISG information models while providing first-hand feedback based on its implementation experience.<br />
<br />
Release FOUR brings a number of improvements over previous releases. For the full list of new features, please refer to the [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFOUR-FINAL.pdf Rel FOUR White Paper]. For a comprehensive overview of OSM functionalities, you can also refer to the release notes of former releases ([https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseONE-FINAL.pdf ONE], [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTWO-FINAL.pdf TWO], [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTHREE-FINAL.pdf THREE]).<br />
<br />
'''OSM Release FOUR Pre-view and Demo'''<br />
{{#evu:https://www.youtube.com/watch?v=KgsaA-HCX40<br />
|alignment=left<br />
}}<br />
<br />
<br />
__TOC__<br />
<br />
=Assumptions about interaction with VIMs and VNFs=<br />
The following figure illustrates OSM interaction with VIMs and VNFs:<br />
* OSM talks to the VIM for the deployment of VNFs and VLs connecting them<br />
* OSM talks to the VNFs deployed in a VIM to run day-0, day-1 and day-2 configuration primitives.<br />
<br />
[[File:Osmtopology.png|600px|OSM Release 4]]<br />
<br />
In order for OSM to work, it is assumed that:<br />
* Each VIM has an API endpoint reachable from OSM<br />
* Each VIM has a so called management network which provides IP address to VNFs<br />
* That management network is reachable from OSM<br />
<br />
=Install OSM Release FOUR=<br />
<br />
This release introduces a new lightweight build, which is a cloud-native, ''dockerized'' OSM installation featuring a new kafka bus for asynchronous communications, a lighter orchestrator, performance/fault management features, a SOL005-aligned NBI, and a new GUI and OSM client leveraging the unified REST API that the NBI exposes. This build does not include the SO and UI components, which are still available in the ''classic build''.<br />
<br />
== Default installation procedure ==<br />
<br />
All you need to run OSM Release FOUR is a single server or VM with the following requirements:<br />
* MINIMUM: 2 CPUs, 4 GB RAM, 20GB disk and a single interface with Internet access<br />
* RECOMMENDED: 2 CPUs, 8 GB RAM, 40GB disk and a single interface with Internet access<br />
* Ubuntu16.04 (64-bit variant required) as base image (http://releases.ubuntu.com/16.04/)<br />
<br />
Once you have prepared the host with the previous requirements, all you need to do is:<br />
wget https://osm-download.etsi.org/ftp/osm-4.0-four/install_osm.sh<br />
chmod +x install_osm.sh<br />
./install_osm.sh<br />
<br />
'''TIP:''' In order to facilitate potential trobleshooting later, it is recommended to save the full log of your installation process:<br />
wget https://osm-download.etsi.org/ftp/osm-4.0-four/install_osm.sh<br />
chmod +x install_osm.sh<br />
$ ./install_osm.sh 2>&1 | tee osm_install_log.txt<br />
<br />
You will be asked if you want to proceed with the installation and configuration of LXD, juju, docker CE and the initialization of a local docker swarm, as pre-requirements. Please answer "y".<br />
<br />
Then, some dialog messages related to LXD configuration will be shown. This is what you have to answer:<br />
* Do you want to configure the LXD bridge? '''Yes'''<br />
* Do you want to setup an IPv4 subnet? '''Yes'''<br />
* ''<< '''Default values''' apply for next questions >>''<br />
* Do you want to setup an IPv6 subnet? '''No'''<br />
<br />
After the installation completes, you will need to add the following environment variables to the end of your .bashrc file and then source it with ''source .bashrc''<br />
export OSM_HOSTNAME=127.0.0.1<br />
export OSM_SOL005=True<br />
<br />
If you want to run docker commands, you will also need to either reload the shell or run the following command to add your user to the 'docker' group:<br />
newgrp docker<br />
<br />
===Installation including optional components===<br />
<br />
You can include optional components in your installation by adding the following flags:<br />
* '''VIM Emulator:''' --vimemu (more information [[VIM emulator|here]])<br />
* '''Performance Management features with Prometheus/Grafana:''' --pm_stack (more information [https://osm.etsi.org/wikipub/index.php?title=OSM_Performance_Management&oldid=2991 here])<br />
* '''Fault Management features with ELK:''' --elk_stack (more information [https://osm.etsi.org/wikipub/index.php?title=OSM_Fault_Management&direction=prev&oldid=3911 here])<br />
<br />
Example:<br />
./install_osm.sh --elk_stack --pm_stack --vimemu<br />
<br />
===Other installation options===<br />
* If you need to install the Classic Build (Rel 3.1), you can follow [[Classic_OSM_Build | this guide]]<br />
* You can also run OSM using a pre-built [https://app.vagrantup.com/osm/boxes/osm vagrant] image: [[How_to_run_OSM_on_Vagrant]]<br />
* For other special installation options, please refer to the [[OSM_Release_FOUR_Documentation#Alternative_installation_methods | release documentation]].<br />
<br />
'''Following instructions will focus only on the default (lightweight) build.'''<br />
<br />
==Checking your installation==<br />
<br />
After some time, you will get a fresh OSM Release FOUR installation. You can access to the UI in the following URL (user:admin, password: admin): http://1.2.3.4, replacing 1.2.3.4 with the IP address of your host. <br />
<br />
[[File:Osm_lwb_ui_login.png|600px|OSM home]]<br />
<br />
[[File:Osm_lwb_ui.png|600px|OSM Release FOUR installation result]]<br />
<br />
As a result of the installation, ten docker containers are created in the host. You can check they are running by issuing the following commands:<br />
docker stack ps osm |grep -i running<br />
docker service ls<br />
<br />
[[File:Osm_containers.png|600px|OSM Docker containers]]<br />
<br />
At any time, you can quickly relaunch your deployment by using the pre-built docker images, like this:<br />
docker stack rm osm<br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
To check the logs of any container:<br />
docker service logs osm_lcm # for LCM<br />
<br />
OSM client, a python-based CLI for OSM, will be available as well in the host machine.<br />
Via the OSM client, you can manage descriptors, NS and VIM complete lifecycle and some new performance and fault-management features.<br />
<br />
=Adding VIM accounts=<br />
Before proceeding, make sure that you have a site with a VIM configured to run with OSM. Different kinds of VIMs are currently supported by OSM:<br />
*'''OpenVIM.''' Check the following link to know how to install and use openvim for OSM: [[OpenVIM installation (Release THREE) | OpenVIM installation]]. Openvim must run in 'normal' mode (not test or fake) to have real virtual machines reachable from OSM.<br />
*'''OpenStack.''' Check the following link to learn how to configure OpenStack to be used by OSM: [[Openstack_configuration_(Release_FOUR) | Openstack configuration]]<br />
*'''VMware vCloud Director.''' Check the following link to learn how to configure VMware VCD to be used by OSM: [[Configuring_VMware_vCloud_Director_for_OSM_Release_FOUR | Configuring VMware vCloud Director]]<br />
*'''Amazon Web Services (AWS).''' Check the following link to learn how to configure AWS (EC2 and Virtual Private Cloud) to be used by OSM: [[Configuring_AWS_for_OSM_Release_FOUR | Configuring AWS for OSM]]<br />
OSM can manage external SDN controllers to perform the dataplane underlay network connectivity on behalf of the VIM. See [[EPA and SDN assist]]<br />
<br />
==Adding VIMs through OSM client==<br />
===OpenVIM site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openvim-site", IP address: 10.10.10.10, VIM tenant: "osm")<br />
osm vim-create --name openvim-site --auth_url http://10.10.10.10:9080/openvim --account_type openvim \<br />
--description "Openvim site" --tenant osm --user dummy --password dummy<br />
<br />
===Openstack site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openstack-site", IP address: 10.10.10.11, VIM tenant: "admin", user: "admin", password: "userpwd")<br />
osm vim-create --name openstack-site --user admin --password userpwd \<br />
--auth_url http://10.10.10.11:5000/v2.0 --tenant admin --account_type openstack<br />
<br />
For advanced options, please refer to the [[Openstack_configuration_(Release_FOUR)#Add_openstack_to_OSM | OpenStack Setup Guide]].<br />
<br />
===VMware vCloud Director site===<br />
*Execute the following command, using the appropriate parameters (e.g. site name: "vmware-site", IP address: 10.10.10.12, VIM tenant: "vmware-tenant", user: "osm", password: "osm4u", admin user: "admin", admin password: "adminpwd", organization: "orgVDC")<br />
osm vim-create --name vmware-site --user osm --password osm4u --auth_url https://10.10.10.12 \<br />
--tenant vmware-tenant --account_type vmware \<br />
--config '{admin_username: user, admin_password: passwd, orgname: organization, nsx_manager: "http://10.10.10.12",<br />
nsx_user: user, nsx_password: userpwd,"vcenter_port": port, "vcenter_user":user, "vcenter_password":password,<br />
"vcenter_ip": 10.10.10.14}'<br />
<br />
For advanced options, please refer to the [[Configuring_VMware_vCloud_Director_for_OSM_Release_FOUR#Add_vCloud_using_OSM_Client | vCloud Director Setup Guide]].<br />
<br />
===VMware Integrated Openstack (VIO) site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openstack-site-vio4", IP address: 10.10.10.12, VIM tenant: "admin", user: "admin", password: "passwd")<br />
osm vim-create --name VIO --user admin --password passwd --auth_url https://10.10.10.12:5000/v3 --tenant admin \<br />
--account_type openstack --config '{use_floating_ip: True, insecure: true, vim_type: VIO, APIversion: v3.3,<br />
dataplane_physical_net: dvs-46, "use_internal_endpoint":true,"dataplane_net_vlan_range":["31-35","37-39"]}'<br />
<br />
With respect to Openstack, the additional configuration for VIO is the following:<br />
* '''vim_type''': Set to "VIO" to use VMware Integrated openstack as VIM <br />
* '''use_internal_endpoint''': When true it allows use of private API endpoints<br />
* '''dataplane_physical_net''': The configured network_vlan_ranges at neutron for the SRIOV (binding direct) and passthrough (binding direct-physical) networks, e.g. 'physnet_sriov' in the above configuration. In case of VMware Integrated Openstack (VIO) provide moref ID of distributed virtual switch, e.g 'dvs-46' in above configuration.<br />
* '''dataplane_net_vlan_range''': In case of VMware Integrated Openstack (VIO) provide vlan ranges for the SRIOV (binding direct) networks in format ['start_ID - end_ID']<br />
<br />
For common options, you may refer to the general [[Openstack_configuration_(Release_FOUR)#Add_openstack_to_OSM | OpenStack Setup Guide]].<br />
<br />
===Amazon Web Services (AWS) site===<br />
*Execute the following command, using the appropriate parameters (e.g. site name: "aws-site", VIM tenant: "admin", user: "XXX", password: "YYY")<br />
osm vim-create --name aws-site --user XXX --password YYY --auth_url https://aws.amazon.com --tenant admin \<br />
--account_type aws --config '{region_name: eu-central-1, flavor_info: {t2.nano: {cpus: 1, disk: 100, ram: 512},<br />
t2.micro: {cpus: 1, disk: 100, ram: 1024}, t2.small: {cpus: 1, disk: 100, ram: 2048},<br />
m1.small: {cpus: 1, disk: 160, ram: 1741}}}'<br />
<br />
For advanced options, please refer to the [[Configuring_AWS_for_OSM_Release_FOUR#Add_AWS_to_OSM | AWS Setup Guide]].<br />
<br />
==Adding VIMs through GUI==<br />
Just access the ''VIM Accounts'' tab, click the ''New VIM'' button and fill the parameters accordingly.<br />
<br />
[[File:Osmvim.png|600px|AddingVIMUI]]<br />
<br />
=Deploying your first Network Service=<br />
In this example we will deploy the following Network Service, consisting of two simple VNFs based on CirrOS connected by a simple VLD.<br />
<br />
[[File:cirros_2vnf_ns.png|500px|NS with 2 CirrOS VNF]]<br />
<br />
Before going on, download the required VNF and NS packages from this URL: https://osm-download.etsi.org/ftp/osm-3.0-three/examples/cirros_2vnf_ns/<br />
<br />
==Onboarding a VNF==<br />
<br />
The onboarding of a VNF in OSM involves adding the corresponding VNF package to the system. This process also assumes, as a pre-condition, that the corresponding VM images are available in the VIM(s) where it will be instantiated.<br />
<br />
===Uploading VM image(s) to the VIM(s)===<br />
In this example, only a vanilla CirrOS 0.3.4 image is need. It can be obtained from the following link: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img<br />
<br />
If not available, it would be required to upload the image into the VIM. Instructions differ from one VIM to another:<br />
*In Openstack:<br />
openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 cirros034<br />
*In OpenVIM:<br />
#copy your image to the NFS shared folder (e.g. /mnt/openvim-nfs)<br />
cp ./cirros-0.3.4-x86_64-disk.img /mnt/openvim-nfs/<br />
openvim image-create --name cirros034 --path /mnt/openvim-nfs/cirros-0.3.4-x86_64-disk.img<br />
<br />
===VNF package onboarding===<br />
<br />
*From the UI:<br />
**Go to Projects --> Admin --> VNF Packages (''Open List'')<br />
**Click on the Onboard VNFD button<br />
**Drag and drop the VNF package file cirros_vnf.tar.gz in the importing area.<br />
[[File:vnfd_onboard_r4.png|600px|Onboarding a VNF]]<br />
*From OSM client:<br />
osm vnfd-create cirros_vnf.tar.gz<br />
osm vnfd-list<br />
<br />
==Onboarding a NS==<br />
*From the UI:<br />
**Go to Projects --> Admin --> NS Packages (''Open List'')<br />
**Click on the Onboard NSD button<br />
**Drag and drop the NS package file cirros_2vnf_ns.tar.gz in the importing area.<br />
[[File:nsd_onboard_r4.png|600px|Onboarding a NS]]<br />
*From OSM client:<br />
osm nsd-create cirros_2vnf_ns.tar.gz<br />
osm nsd-list<br />
<br />
==Instantiating the NS==<br />
*From the UI:<br />
**Go to Projects --> Admin --> NS Packages (''Open List'')<br />
**Next the NS descriptor to be instantiated, click on Launch<br />
[[File:nsd_list.png|600px|Instantiating a NS (step 1)]] <br />
**Fill the form, adding at least a name and selecting the VIM<br />
[[File:new_ns.png|600px|Instantiating a NS (step 2)]] <br />
* From OSM client:<br />
osm ns-create --nsd_name cirros_2vnf_ns --ns_name <ns-instance-name> --vim_account <data-center-name><br />
osm ns-list<br />
<br />
'''Instantiation parameters can be specified using both CLI and UI. There are some examples collected in this wiki page: [[OSM instantiation parameters]].'''<br />
<br />
==Using old descriptors from Release TWO==<br />
<br />
Beware that old Release TWO descriptors cannot be directly used by OSM Release FOUR.<br />
<br />
You should use this '''[[Creating your own VNF package#Migrating old descriptors to release FOUR|conversion tool]]''' to convert them to Release FOUR format and '''[[Creating your own VNF package|create the corresponding package]]'''.<br />
<br />
=What's next?=<br />
<br />
If you want to learn more, you can refer to the rest of '''[[OSM_Release_FOUR_Documentation | OSM documentation]]'''.<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Reference_VNF_and_NS_Descriptors&diff=6081Reference VNF and NS Descriptors2021-02-17T16:54:35Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
= Reference NS#1: Testing an endpoint VNF =<br />
<br />
The following network service captures a simple test setup where a VNF is tested with a traffic generator VNF (or a simple VNF/VM with a basic client application). For simplicity, this network service assumes that the VNF under test is the endpoint of a given service (e.g. DNS, AAA, etc.) and does not require special conditions or resource allocation besides the usual in a standard cloud environments.<br />
<br />
[[File:example_ns_1.png | 450px | right | Reference NS #1: Testing an endpoint VNF]]<br />
<br />
In this example, unless otherwise specified in the description, the following defaults apply:<br />
* CPs are regular para-virtualized interfaces (VirtIO or equivalent).<br />
* VLs provide E-LAN connectivity via regular (overlay) networks provided by the VIM.<br />
* VLs provide IP addressing via DHCP if applicable.<br />
* Mapping between internal and external CPs may be either direct (as aliases) or via an intermediate VL.<br />
* VIM+NFVI can guarantee predictable ordering of guest interfaces' virtual PCI addresses.<br />
<br />
In the case of REF_NS_1:<br />
* When deploying the NS, VL1 would be typically mapped to a pre-created VIM network intended to provide management IP address to VNFs via DHCP.<br />
* DHCP in VL2 may be optional.<br />
<br />
<br />
== Reference VNF#11: Endpoint VNF ==<br />
[[File:ref_vnf_11.png | 350px | right | Reference VNF#11: Endpoint]]<br />
<br />
=== Description in common language ===<br />
* '''Name:''' Ref_VNF_11<br />
** '''Component:''' Ref_VM1<br />
*** '''Memory:''' 2 GB<br />
*** '''CPU:''' 2 vCPU<br />
*** '''Storage:''' 8 GB<br />
*** '''Image:''' ref_vm1.qcow2<br />
** '''Component:''' Ref_VM2<br />
*** '''Memory:''' 4GB<br />
*** '''CPU:''' 2 vCPU<br />
*** '''Storage:''' 16GB<br />
*** '''Image:''' ref_vm2.qcow2<br />
** '''Internal Virtual Link:''' VL12<br />
*** No DHCP server is enabled.<br />
*** Static addressing may be used at CP iface11 and CP iface21.<br />
<br />
=== OSM VNF descriptor for VNF#11 ===<br />
[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/vnfd/ref11_vnf/src/ref11_vnfd.yaml VNF11.yaml]<br />
<br />
== Reference VNF#21: Generator 1 port ==<br />
[[File:ref_vnf_21.png | 350px | right | Reference VNF#21: Generator 1 port]]<br />
<br />
=== Description in common language ===<br />
* '''Name:''' Ref_VNF_21<br />
** '''Component:''' Ref_VM5<br />
*** '''Memory:''' 1 GB<br />
*** '''CPU:''' 1 vCPU<br />
*** '''Storage:''' 16 GB<br />
*** '''Image:''' ref_vm21.qcow2<br />
<br />
=== OSM VNF descriptor for VNF#21 ===<br />
[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/vnfd/ref21_vnf/src/ref21_vnfd.yaml VNF21.yaml]<br />
<br />
== OSM NS descriptor for NS#1 ==<br />
[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/nsd/ref1_ns/src/ref1_nsd.yaml NS1.yaml]<br />
<br />
= Reference NS #2: Testing a middle point VNF =<br />
[[File:example_ns_2.png | 400px | right | Reference NS #2: Testing a middle point VNF]]<br />
<br />
The following network service captures a more advanced test setup where the VNF under test is a middlepoint in the communication (e.g. router, EPC) and might require special conditions or resource allocation and connectivity foreseen in NFV ISG specs. In this case, the traffic generator VNF behaves as source and sink of traffic and might also require special resource allocation.<br />
<br />
In this example, unless otherwise specified in the description, the following applies:<br />
* Same defaults as in NS#1<br />
* vCPUs must be pinned to dedicated physical CPUs, with no over subscription.<br />
* CPUs, memory and interfaces (if applicable) to be assigned to a given VM should belong to the same socket (NUMA awareness).<br />
* Memory assigned to VMs should be backed by host's huge pages memory.<br />
* VL2 and VL3 are E-Line underlay connectivity. No DHCP is required.<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
== Reference VNF#12: Middle point VNF ==<br />
[[File:ref_vnf_12.png | 400px | right | Reference VNF#12: Middle point]]<br />
<br />
=== Description in common language ===<br />
* '''Name:''' Ref_VNF_12<br />
** '''Component:''' Ref_VM3<br />
*** '''Memory:''' 2 GB huge pages<br />
*** '''CPU:''' 2 vCPU (= CPU)<br />
*** '''Storage:''' 8 GB<br />
*** '''Image:''' ref_vm3.qcow2<br />
** '''Component:''' Ref_VM4<br />
*** '''Memory:''' 4GB<br />
*** '''CPU:''' 2 vCPU<br />
*** '''Storage:''' 16GB<br />
*** '''Image:''' ref_vm4.qcow2<br />
** '''Connection Point:''' iface42 (west)<br />
*** '''Type:''' Passthrough<br />
** '''Connection Point:''' iface43 (east)<br />
*** '''Type:''' SR-IOV<br />
<br />
=== OSM VNF descriptor for VNF#12 ===<br />
[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/vnfd/ref12_vnf/src/ref12_vnfd.yaml VNF12.yaml]<br />
<br />
== Reference VNF#22: Generator 2 ports ==<br />
<br />
[[File:ref_vnf_22.png | 400px | right | Reference VNF#22: Generator 2 ports]]<br />
<br />
=== Description in common language ===<br />
* '''Name:''' Ref_VNF_22<br />
** '''Component:''' Ref_VM6<br />
*** '''Memory:''' 1 GB huge pages<br />
*** '''CPU:''' 1 vCPU (= CPU)<br />
*** '''Storage:''' 16 GB<br />
*** '''Image:''' ref_vm22.qcow2<br />
** '''Connection Point:''' iface61 (west)<br />
*** '''Type:''' Passthrough<br />
** '''Connection Point:''' iface62 (east)<br />
*** '''Type:''' SR-IOV<br />
<br />
=== OSM VNF descriptor for VNF#22 ===<br />
[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/vnfd/ref22_vnf/src/ref22_vnfd.yaml VNF22.yaml]<br />
<br />
== OSM NS descriptor for NS#2 ==<br />
[https://osm.etsi.org/gitweb/?p=osm/devops.git;a=blob;f=descriptor-packages/nsd/ref2_ns/src/ref2_nsd.yaml NS2.yaml]<br />
<br />
= Resources =<br />
The template used to create these NS/VNF diagrams is available at:<br />
[https://drive.google.com/open?id=0B0IUJnTZzp2iUnJUb1JFSGpBRGs Reference_NS-VNF_diagrams.pptx]</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Information_Model&diff=6080OSM Information Model2021-02-17T16:54:25Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
==YANG model in OSM repos==<br />
<br />
YANG models can be found in the IM repo under the models folder:<br />
https://osm.etsi.org/gitweb/?p=osm/IM.git;a=tree<br />
<br />
OSM uses [https://github.com/mbj4668/pyang pyang] and [https://github.com/robshakir/pyangbind pyangbind] to generate Python classes used by the different OSM components.<br />
<br />
==OSM IM tree representation==<br />
Below you can find tree representations of the VNFD (VNF Descriptor), NSD (Network Service Descriptor), NST (Network Slice Template), VNFR (VNF Record), NSR (Network Service Record), NSI (Network Slice Instance), both in navigable and plain text formats.<br />
<br />
===VNFD tree===<br />
<br />
'''Navigable version:'''<br />
<br />
'''http://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/docs/osm-im/osm_im_trees/vnfd.html'''<br />
<br />
'''Plain text version:'''<br />
<pre><br />
module: vnfd<br />
+--rw vnfd-catalog<br />
+--rw schema-version? string<br />
+--rw vnfd* [id]<br />
+--rw id string<br />
+--rw name string<br />
+--rw short-name? string<br />
+--rw vendor? string<br />
+--rw logo? string<br />
+--rw description? string<br />
+--rw version? string<br />
+--rw vnf-configuration<br />
| +--rw (config-method)?<br />
| | +--:(script)<br />
| | | +--rw script<br />
| | | +--rw script-type? enumeration<br />
| | +--:(juju)<br />
| | +--rw juju<br />
| | +--rw charm? string<br />
| | +--rw proxy? boolean<br />
| | +--rw vca-relationships<br />
| | +--rw relation* [requires provides]<br />
| | +--rw requires string<br />
| | +--rw provides string<br />
| +--rw config-primitive* [name]<br />
| | +--rw name string<br />
| | +--rw parameter* [name]<br />
| | | +--rw name string<br />
| | | +--rw data-type? manotypes:parameter-data-type<br />
| | | +--rw mandatory? boolean<br />
| | | +--rw default-value? string<br />
| | | +--rw parameter-pool? string<br />
| | | +--rw read-only? boolean<br />
| | | +--rw hidden? boolean<br />
| | +--rw user-defined-script? string<br />
| +--rw initial-config-primitive* [seq]<br />
| | +--rw seq uint64<br />
| | +--rw (primitive-type)?<br />
| | +--:(primitive-definition)<br />
| | +--rw name? string<br />
| | +--rw parameter* [name]<br />
| | | +--rw name string<br />
| | | +--rw data-type? manotypes:parameter-data-type<br />
| | | +--rw value? string<br />
| | +--rw user-defined-script? string<br />
| +--rw terminate-config-primitive* [seq]<br />
| | +--rw seq uint64<br />
| | +--rw name? string<br />
| | +--rw parameter* [name]<br />
| | | +--rw name string<br />
| | | +--rw data-type? manotypes:parameter-data-type<br />
| | | +--rw value? string<br />
| | +--rw user-defined-script? string<br />
| +--rw metrics* [name]<br />
| | +--rw name string<br />
| +--rw config-access<br />
| +--rw ssh-access<br />
| +--rw required? boolean<br />
| +--rw default-user? string<br />
+--rw operational-status? vnf-operational-status<br />
+--rw mgmt-interface<br />
| +--rw (endpoint-type)?<br />
| | +--:(ip)<br />
| | | +--rw ip-address? inet:ip-address<br />
| | +--:(vdu-id)<br />
| | | +--rw vdu-id? -> ../../vdu/id<br />
| | +--:(cp)<br />
| | +--rw cp? -> ../../connection-point/name<br />
| +--rw port? inet:port-number<br />
| +--rw dashboard-params<br />
| +--rw path? string<br />
| +--rw https? boolean<br />
| +--rw port? inet:port-number<br />
+--rw internal-vld* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw short-name? string<br />
| +--rw description? string<br />
| +--rw type? manotypes:virtual-link-type<br />
| +--rw root-bandwidth? uint64<br />
| +--rw leaf-bandwidth? uint64<br />
| +--rw internal-connection-point* [id-ref]<br />
| | +--rw id-ref -> ../../../vdu/internal-connection-point/id<br />
| | +--rw ip-address? inet:ip-address<br />
| +--rw provider-network<br />
| | +--rw physical-network? string<br />
| | +--rw segmentation_id? uint32<br />
| +--rw (init-params)?<br />
| +--:(vim-network-ref)<br />
| | +--rw vim-network-name? string<br />
| +--:(vim-network-profile)<br />
| +--rw ip-profile-ref? string<br />
+--rw ip-profiles* [name]<br />
| +--rw name string<br />
| +--rw description? string<br />
| +--rw ip-profile-params<br />
| +--rw ip-version? inet:ip-version<br />
| +--rw subnet-address? inet:ip-prefix<br />
| +--rw gateway-address? inet:ip-address<br />
| +--rw security-group? string<br />
| +--rw dns-server* [address]<br />
| | +--rw address inet:ip-address<br />
| +--rw dhcp-params<br />
| | +--rw enabled? boolean<br />
| | +--rw start-address? inet:ip-address<br />
| | +--rw count? uint32<br />
| +--rw subnet-prefix-pool? string<br />
+--rw connection-point* [name]<br />
| +--rw name string<br />
| +--rw id? string<br />
| +--rw short-name? string<br />
| +--rw type? manotypes:connection-point-type<br />
| +--rw port-security-enabled? boolean<br />
| +--rw internal-vld-ref? -> ../../internal-vld/id<br />
+--rw vdu* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw description? string<br />
| +--rw pdu-type? string<br />
| +--rw count? uint64<br />
| +--rw mgmt-vpci? string<br />
| +--rw vm-flavor<br />
| | +--rw vcpu-count? uint16<br />
| | +--rw memory-mb? uint64<br />
| | +--rw storage-gb? uint64<br />
| +--rw guest-epa<br />
| | +--rw trusted-execution? boolean<br />
| | +--rw mempage-size? enumeration<br />
| | +--rw (cpu-policy)?<br />
| | | +--:(cpu-pinning)<br />
| | | | +--rw cpu-pinning-policy? enumeration<br />
| | | | +--rw cpu-thread-pinning-policy? enumeration<br />
| | | +--:(cpu-quota)<br />
| | | +--rw cpu-quota<br />
| | | +--rw limit? uint64<br />
| | | +--rw reserve? uint64<br />
| | | +--rw shares? uint64<br />
| | +--rw mem-quota<br />
| | | +--rw limit? uint64<br />
| | | +--rw reserve? uint64<br />
| | | +--rw shares? uint64<br />
| | +--rw disk-io-quota<br />
| | | +--rw limit? uint64<br />
| | | +--rw reserve? uint64<br />
| | | +--rw shares? uint64<br />
| | +--rw vif-quota<br />
| | | +--rw limit? uint64<br />
| | | +--rw reserve? uint64<br />
| | | +--rw shares? uint64<br />
| | +--rw pcie-device* [device-id]<br />
| | | +--rw device-id string<br />
| | | +--rw count? uint64<br />
| | +--rw (numa-policy)?<br />
| | +--:(numa-unaware)<br />
| | | +--rw numa-unaware? empty<br />
| | +--:(numa-aware)<br />
| | +--rw numa-node-policy<br />
| | +--rw node-cnt? uint16<br />
| | +--rw mem-policy? enumeration<br />
| | +--rw node* [id]<br />
| | +--rw id uint64<br />
| | +--rw vcpu* [id]<br />
| | | +--rw id uint64<br />
| | +--rw memory-mb? uint64<br />
| | +--rw (om-numa-type)?<br />
| | +--:(cores)<br />
| | | +--rw num-cores? uint8<br />
| | +--:(paired-threads)<br />
| | | +--rw paired-threads<br />
| | | +--rw num-paired-threads? uint8<br />
| | | +--rw paired-thread-ids* [thread-a]<br />
| | | +--rw thread-a uint8<br />
| | | +--rw thread-b? uint8<br />
| | +--:(threads)<br />
| | +--rw num-threads? uint8<br />
| +--rw vswitch-epa<br />
| | +--rw ovs-acceleration? enumeration<br />
| | +--rw ovs-offload? enumeration<br />
| +--rw hypervisor-epa<br />
| | +--rw type? enumeration<br />
| | +--rw version? string<br />
| +--rw host-epa<br />
| | +--rw cpu-model? enumeration<br />
| | +--rw cpu-arch? enumeration<br />
| | +--rw cpu-vendor? enumeration<br />
| | +--rw cpu-socket-count? uint64<br />
| | +--rw cpu-core-count? uint64<br />
| | +--rw cpu-core-thread-count? uint64<br />
| | +--rw cpu-feature* [feature]<br />
| | | +--rw feature cpu-feature-type<br />
| | +--rw om-cpu-model-string? string<br />
| | +--rw om-cpu-feature* [feature]<br />
| | +--rw feature string<br />
| +--rw alarm* [alarm-id]<br />
| | +--rw alarm-id string<br />
| | +--rw vnf-monitoring-param-ref? -> ../../monitoring-param/id<br />
| | +--rw name? string<br />
| | +--rw description? string<br />
| | +--rw vdur-id? string<br />
| | +--rw actions<br />
| | | +--rw ok* [url]<br />
| | | | +--rw url string<br />
| | | +--rw insufficient-data* [url]<br />
| | | | +--rw url string<br />
| | | +--rw alarm* [url]<br />
| | | +--rw url string<br />
| | +--rw repeat? boolean<br />
| | +--rw enabled? boolean<br />
| | +--rw severity? alarm-severity-type<br />
| | +--rw statistic? alarm-statistic-type<br />
| | +--rw operation? relational-operation-type<br />
| | +--rw value? decimal64<br />
| | +--rw period? uint32<br />
| | +--rw evaluations? uint32<br />
| +--rw image? string<br />
| +--rw image-checksum? string<br />
| +--rw alternative-images* [vim-type]<br />
| | +--rw vim-type string<br />
| | +--rw image? string<br />
| | +--rw image-checksum? string<br />
| +--rw vdu-configuration<br />
| | +--rw (config-method)?<br />
| | | +--:(script)<br />
| | | | +--rw script<br />
| | | | +--rw script-type? enumeration<br />
| | | +--:(juju)<br />
| | | +--rw juju<br />
| | | +--rw charm? string<br />
| | | +--rw proxy? boolean<br />
| | | +--rw vca-relationships<br />
| | | +--rw relation* [requires provides]<br />
| | | +--rw requires string<br />
| | | +--rw provides string<br />
| | +--rw config-primitive* [name]<br />
| | | +--rw name string<br />
| | | +--rw parameter* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw data-type? manotypes:parameter-data-type<br />
| | | | +--rw mandatory? boolean<br />
| | | | +--rw default-value? string<br />
| | | | +--rw parameter-pool? string<br />
| | | | +--rw read-only? boolean<br />
| | | | +--rw hidden? boolean<br />
| | | +--rw user-defined-script? string<br />
| | +--rw initial-config-primitive* [seq]<br />
| | | +--rw seq uint64<br />
| | | +--rw (primitive-type)?<br />
| | | +--:(primitive-definition)<br />
| | | +--rw name? string<br />
| | | +--rw parameter* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw data-type? manotypes:parameter-data-type<br />
| | | | +--rw value? string<br />
| | | +--rw user-defined-script? string<br />
| | +--rw terminate-config-primitive* [seq]<br />
| | | +--rw seq uint64<br />
| | | +--rw name? string<br />
| | | +--rw parameter* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw data-type? manotypes:parameter-data-type<br />
| | | | +--rw value? string<br />
| | | +--rw user-defined-script? string<br />
| | +--rw metrics* [name]<br />
| | | +--rw name string<br />
| | +--rw config-access<br />
| | +--rw ssh-access<br />
| | +--rw required? boolean<br />
| | +--rw default-user? string<br />
| +--rw monitoring-param* [id]<br />
| | +--rw id string<br />
| | +--rw nfvi-metric? manotypes:nfvi-metric-type<br />
| | +--rw interface-name-ref? -> ../../interface/name<br />
| +--rw (cloud-init-input)?<br />
| | +--:(inline)<br />
| | | +--rw cloud-init? string<br />
| | +--:(filename)<br />
| | +--rw cloud-init-file? string<br />
| +--rw supplemental-boot-data<br />
| | +--rw boot-data-drive? boolean<br />
| +--rw internal-connection-point* [id]<br />
| | +--rw name? string<br />
| | +--rw id string<br />
| | +--rw short-name? string<br />
| | +--rw type? manotypes:connection-point-type<br />
| | +--rw port-security-enabled? boolean<br />
| | +--rw internal-vld-ref? -> ../../../internal-vld/id<br />
| +--rw interface* [name]<br />
| | +--rw name string<br />
| | +--rw position? uint32<br />
| | +--rw mgmt-interface? boolean<br />
| | +--rw type? interface-type<br />
| | +--rw mac-address? string<br />
| | +--rw (connection-point-type)?<br />
| | | +--:(internal)<br />
| | | | +--rw internal-connection-point-ref? -> ../../internal-connection-point/id<br />
| | | +--:(external)<br />
| | | +--rw external-connection-point-ref? -> ../../../connection-point/name<br />
| | +--rw virtual-interface<br />
| | +--rw type? enumeration<br />
| | +--rw vpci? string<br />
| | +--rw bandwidth? uint64<br />
| +--rw volumes* [name]<br />
| +--rw name string<br />
| +--rw description? string<br />
| +--rw size? uint64<br />
| +--rw (volume-source)?<br />
| | +--:(ephemeral)<br />
| | | +--rw ephemeral? empty<br />
| | +--:(image)<br />
| | +--rw image? string<br />
| | +--rw image-checksum? string<br />
| +--rw device-bus? enumeration<br />
| +--rw device-type? enumeration<br />
+--rw vdu-dependency* [vdu-source-ref]<br />
| +--rw vdu-source-ref -> ../../vdu/id<br />
| +--rw vdu-depends-on-ref? -> ../../vdu/id<br />
+--rw service-function-chain? enumeration<br />
+--rw service-function-type? string<br />
+--rw http-endpoint* [path]<br />
| +--rw path string<br />
| +--rw https? boolean<br />
| +--rw port? inet:port-number<br />
| +--rw username? string<br />
| +--rw password? string<br />
| +--rw polling-interval-secs? uint8<br />
| +--rw method? manotypes:http-method<br />
| +--rw headers* [key]<br />
| +--rw key string<br />
| +--rw value? string<br />
+--rw scaling-group-descriptor* [name]<br />
| +--rw name string<br />
| +--rw scaling-policy* [name]<br />
| | +--rw name string<br />
| | +--rw scaling-type? manotypes:scaling-policy-type<br />
| | +--rw enabled? boolean<br />
| | +--rw scale-in-operation-type? manotypes:scaling-criteria-operation<br />
| | +--rw scale-out-operation-type? manotypes:scaling-criteria-operation<br />
| | +--rw threshold-time uint32<br />
| | +--rw cooldown-time uint32<br />
| | +--rw scaling-criteria* [name]<br />
| | +--rw name string<br />
| | +--rw scale-in-threshold? decimal64<br />
| | +--rw scale-in-relational-operation? manotypes:relational-operation-type<br />
| | +--rw scale-out-threshold? decimal64<br />
| | +--rw scale-out-relational-operation? manotypes:relational-operation-type<br />
| | +--rw vnf-monitoring-param-ref? -> ../../../../monitoring-param/id<br />
| +--rw vdu* [vdu-id-ref]<br />
| | +--rw vdu-id-ref -> ../../../vdu/id<br />
| | +--rw count? uint32<br />
| +--rw min-instance-count? uint32<br />
| +--rw max-instance-count? uint32<br />
| +--rw scaling-config-action* [trigger]<br />
| +--rw trigger manotypes:scaling-trigger<br />
| +--rw vnf-config-primitive-name-ref? -> ../../../vnf-configuration/config-primitive/name<br />
+--rw monitoring-param* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw aggregation-type? aggregation-type<br />
| +--rw (monitoring-type)?<br />
| | +--:(vdu-monitoring-param)<br />
| | | +--rw vdu-monitoring-param<br />
| | | +--rw vdu-ref? -> ../../../vdu/id<br />
| | | +--rw vdu-monitoring-param-ref? -> ../../../vdu[id = current()/../vdu-ref]/monitoring-param/id<br />
| | +--:(vnf-metric)<br />
| | | +--rw vnf-metric<br />
| | | +--rw vnf-metric-name-ref? -> ../../../vnf-configuration/metrics/name<br />
| | +--:(vdu-metric)<br />
| | +--rw vdu-metric<br />
| | +--rw vdu-ref? -> ../../../vdu/id<br />
| | +--rw vdu-metric-name-ref? -> ../../../vdu[id = current()/../vdu-ref]/vdu-configuration/metrics/name<br />
| +--rw http-endpoint-ref? -> ../../http-endpoint/path<br />
| +--rw json-query-method? manotypes:json-query-method<br />
| +--rw json-query-params<br />
| | +--rw json-path? string<br />
| | +--rw object-path? string<br />
| +--rw description? string<br />
| +--rw group-tag? string<br />
| +--rw widget-type? manotypes:widget-type<br />
| +--rw units? string<br />
| +--rw value-type? param-value-type<br />
| +--rw numeric-constraints<br />
| | +--rw min-value? uint64<br />
| | +--rw max-value? uint64<br />
| +--rw text-constraints<br />
| | +--rw min-length? uint8<br />
| | +--rw max-length? uint8<br />
| +--rw value-integer? int64<br />
| +--rw value-decimal? decimal64<br />
| +--rw value-string? string<br />
+--rw placement-groups* [name]<br />
+--rw name string<br />
+--rw requirement? string<br />
+--rw strategy? enumeration<br />
+--rw member-vdus* [member-vdu-ref]<br />
+--rw member-vdu-ref -> ../../../vdu/id<br />
</pre><br />
<br />
===NSD tree===<br />
<br />
'''Navigable version:'''<br />
<br />
'''http://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/docs/osm-im/osm_im_trees/nsd.html'''<br />
<br />
'''Plain text version:'''<br />
<pre><br />
module: nsd<br />
+--rw nsd-catalog<br />
+--rw schema-version? string<br />
+--rw nsd* [id]<br />
+--rw id string<br />
+--rw name string<br />
+--rw short-name? string<br />
+--rw vendor? string<br />
+--rw logo? string<br />
+--rw description? string<br />
+--rw version? string<br />
+--rw connection-point* [name]<br />
| +--rw name string<br />
| +--rw floating-ip-required? boolean<br />
| +--rw type? manotypes:connection-point-type<br />
| +--rw (connection)?<br />
| +--:(vld-ref)<br />
| | +--rw vld-id-ref? -> ../../vld/id<br />
| +--:(vnfd-connection-point-ref)<br />
| +--rw member-vnf-index-ref? -> ../../constituent-vnfd/member-vnf-index<br />
| +--rw vnfd-id-ref? -> ../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
| +--rw vnfd-connection-point-ref? -> /vnfd:vnfd-catalog/vnfd[vnfd:id = current()/../vnfd-id-ref]/connection-point/name<br />
+--rw scaling-group-descriptor* [name]<br />
| +--rw name string<br />
| +--rw scaling-policy* [name]<br />
| | +--rw name string<br />
| | +--rw scaling-type? manotypes:scaling-policy-type<br />
| | +--rw enabled? boolean<br />
| | +--rw scale-in-operation-type? manotypes:scaling-criteria-operation<br />
| | +--rw scale-out-operation-type? manotypes:scaling-criteria-operation<br />
| | +--rw threshold-time uint32<br />
| | +--rw cooldown-time uint32<br />
| | +--rw scaling-criteria* [name]<br />
| | +--rw name string<br />
| | +--rw scale-in-threshold? uint64<br />
| | +--rw scale-in-relational-operation? manotypes:relational-operation-type<br />
| | +--rw scale-out-threshold? uint64<br />
| | +--rw scale-out-relational-operation? manotypes:relational-operation-type<br />
| | +--rw ns-monitoring-param-ref? -> ../../../../monitoring-param/id<br />
| +--rw vnfd-member* [member-vnf-index-ref]<br />
| | +--rw member-vnf-index-ref -> ../../../constituent-vnfd/member-vnf-index<br />
| | +--rw count? uint32<br />
| +--rw min-instance-count? uint32<br />
| +--rw max-instance-count? uint32<br />
| +--rw scaling-config-action* [trigger]<br />
| +--rw trigger manotypes:scaling-trigger<br />
| +--rw ns-config-primitive-name-ref? -> ../../../ns-configuration/config-primitive/name<br />
+--rw vnffgd* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw short-name? string<br />
| +--rw vendor? string<br />
| +--rw description? string<br />
| +--rw version? string<br />
| +--rw rsp* [id]<br />
| | +--rw id string<br />
| | +--rw name? string<br />
| | +--rw vnfd-connection-point-ref* [member-vnf-index-ref]<br />
| | +--rw member-vnf-index-ref -> ../../../../constituent-vnfd/member-vnf-index<br />
| | +--rw order? uint8<br />
| | +--rw vnfd-id-ref? -> ../../../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
| | +--rw vnfd-ingress-connection-point-ref? string<br />
| | +--rw vnfd-egress-connection-point-ref? string<br />
| +--rw classifier* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw rsp-id-ref? -> ../../rsp/id<br />
| +--rw match-attributes* [id]<br />
| | +--rw id string<br />
| | +--rw ip-proto? uint8<br />
| | +--rw source-ip-address? inet:ip-address<br />
| | +--rw destination-ip-address? inet:ip-address<br />
| | +--rw source-port? inet:port-number<br />
| | +--rw destination-port? inet:port-number<br />
| +--rw member-vnf-index-ref? -> ../../../constituent-vnfd/member-vnf-index<br />
| +--rw vnfd-id-ref? -> ../../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
| +--rw vnfd-connection-point-ref? string<br />
+--rw ip-profiles* [name]<br />
| +--rw name string<br />
| +--rw description? string<br />
| +--rw ip-profile-params<br />
| +--rw ip-version? inet:ip-version<br />
| +--rw subnet-address? inet:ip-prefix<br />
| +--rw gateway-address? inet:ip-address<br />
| +--rw security-group? string<br />
| +--rw dns-server* [address]<br />
| | +--rw address inet:ip-address<br />
| +--rw dhcp-params<br />
| | +--rw enabled? boolean<br />
| | +--rw start-address? inet:ip-address<br />
| | +--rw count? uint32<br />
| +--rw subnet-prefix-pool? string<br />
+--rw ns-configuration<br />
| +--rw (config-method)?<br />
| | +--:(script)<br />
| | | +--rw script<br />
| | | +--rw script-type? enumeration<br />
| | +--:(juju)<br />
| | +--rw juju<br />
| | +--rw charm? string<br />
| | +--rw proxy? boolean<br />
| | +--rw vca-relationships<br />
| | +--rw relation* [requires provides]<br />
| | +--rw requires string<br />
| | +--rw provides string<br />
| +--rw config-primitive* [name]<br />
| | +--rw name string<br />
| | +--rw parameter* [name]<br />
| | | +--rw name string<br />
| | | +--rw data-type? manotypes:parameter-data-type<br />
| | | +--rw mandatory? boolean<br />
| | | +--rw default-value? string<br />
| | | +--rw parameter-pool? string<br />
| | | +--rw read-only? boolean<br />
| | | +--rw hidden? boolean<br />
| | +--rw user-defined-script? string<br />
| +--rw initial-config-primitive* [seq]<br />
| | +--rw seq uint64<br />
| | +--rw (primitive-type)?<br />
| | +--:(primitive-definition)<br />
| | +--rw name? string<br />
| | +--rw parameter* [name]<br />
| | | +--rw name string<br />
| | | +--rw data-type? manotypes:parameter-data-type<br />
| | | +--rw value? string<br />
| | +--rw user-defined-script? string<br />
| +--rw terminate-config-primitive* [seq]<br />
| | +--rw seq uint64<br />
| | +--rw name? string<br />
| | +--rw parameter* [name]<br />
| | | +--rw name string<br />
| | | +--rw data-type? manotypes:parameter-data-type<br />
| | | +--rw value? string<br />
| | +--rw user-defined-script? string<br />
| +--rw metrics* [name]<br />
| +--rw name string<br />
+--rw input-parameter-xpath* [xpath]<br />
| +--rw xpath string<br />
| +--rw label? string<br />
| +--rw default-value? string<br />
+--rw parameter-pool* [name]<br />
| +--rw name string<br />
| +--rw range<br />
| +--rw start-value uint32<br />
| +--rw end-value uint32<br />
+--rw key-pair* [name]<br />
| +--rw name string<br />
| +--rw key? string<br />
+--rw user* [name]<br />
| +--rw name string<br />
| +--rw user-info? string<br />
| +--rw key-pair* [name]<br />
| +--rw name string<br />
| +--rw key? string<br />
+--rw vld* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw short-name? string<br />
| +--rw vendor? string<br />
| +--rw description? string<br />
| +--rw version? string<br />
| +--rw type? manotypes:virtual-link-type<br />
| +--rw root-bandwidth? uint64<br />
| +--rw leaf-bandwidth? uint64<br />
| +--rw provider-network<br />
| | +--rw physical-network? string<br />
| | +--rw segmentation_id? uint32<br />
| +--rw mgmt-network? boolean<br />
| +--rw (init-params)?<br />
| | +--:(vim-network-ref)<br />
| | | +--rw vim-network-name? string<br />
| | +--:(vim-network-profile)<br />
| | +--rw ip-profile-ref? -> ../../ip-profiles/name<br />
| +--rw vnfd-connection-point-ref* [member-vnf-index-ref vnfd-connection-point-ref]<br />
| +--rw member-vnf-index-ref -> ../../../constituent-vnfd/member-vnf-index<br />
| +--rw vnfd-connection-point-ref -> /vnfd:vnfd-catalog/vnfd[vnfd:id = current()/../vnfd-id-ref]/connection-point/name<br />
| +--rw vnfd-id-ref? -> ../../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
| +--rw ip-address? inet:ip-address<br />
+--rw constituent-vnfd* [member-vnf-index]<br />
| +--rw member-vnf-index string<br />
| +--rw vnfd-id-ref? -> /vnfd:vnfd-catalog/vnfd/id<br />
| +--rw start-by-default? boolean<br />
+--rw placement-groups* [name]<br />
| +--rw name string<br />
| +--rw requirement? string<br />
| +--rw strategy? enumeration<br />
| +--rw member-vnfd* [member-vnf-index-ref]<br />
| +--rw member-vnf-index-ref -> ../../../constituent-vnfd/member-vnf-index<br />
| +--rw vnfd-id-ref? -> ../../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
+--rw vnf-dependency* [vnf-source-ref]<br />
| +--rw vnf-source-ref -> /vnfd:vnfd-catalog/vnfd/id<br />
| +--rw vnf-depends-on-ref? -> /vnfd:vnfd-catalog/vnfd/id<br />
+--rw monitoring-param* [id]<br />
+--rw id string<br />
+--rw name? string<br />
+--rw value-type? param-value-type<br />
+--rw numeric-constraints<br />
| +--rw min-value? uint64<br />
| +--rw max-value? uint64<br />
+--rw text-constraints<br />
| +--rw min-length? uint8<br />
| +--rw max-length? uint8<br />
+--rw value-integer? int64<br />
+--rw value-decimal? decimal64<br />
+--rw value-string? string<br />
+--rw description? string<br />
+--rw group-tag? string<br />
+--rw widget-type? manotypes:widget-type<br />
+--rw units? string<br />
+--rw aggregation-type? aggregation-type<br />
+--rw vnfd-monitoring-param* [member-vnf-index-ref vnfd-monitoring-param-ref]<br />
+--rw vnfd-id-ref? -> ../../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
+--rw vnfd-monitoring-param-ref -> /vnfd:vnfd-catalog/vnfd[vnfd:id = current()/../vnfd-id-ref]/monitoring-param/id<br />
+--rw member-vnf-index-ref -> ../../../constituent-vnfd/member-vnf-index<br />
</pre><br />
<br />
===NST tree===<br />
<br />
'''Navigable version:'''<br />
<br />
'''http://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/docs/osm-im/osm_im_trees/nst.html'''<br />
<br />
'''Plain text version:'''<br />
<pre><br />
module: nst<br />
+--rw nst* [id]<br />
+--rw id string<br />
+--rw name string<br />
+--rw SNSSAI-identifier<br />
| +--rw slice-service-type network-slice-type<br />
| +--rw slice-differentiator? string<br />
+--rw quality-of-service<br />
| +--rw id uint16<br />
| +--rw resource-type? resource-type<br />
| +--rw priority-level? uint16<br />
| +--rw packet-delay-budget? uint16<br />
| +--rw packet-error-rate? uint16<br />
| +--rw default-max-data-burst? uint16<br />
+--rw netslice-subnet* [id]<br />
| +--rw id string<br />
| +--rw description? string<br />
| +--rw is-shared-nss? boolean<br />
| +--rw nsd-ref -> /nsd:nsd-catalog/nsd/id<br />
| +--rw instantiation-parameters<br />
| +--rw vimAccountId string<br />
| +--rw ssh_keys? string<br />
| +--rw vnf* [member-vnf-index]<br />
| | +--rw member-vnf-index string<br />
| | +--rw vimAccountId? string<br />
| | +--rw vdu* [id]<br />
| | | +--rw id string<br />
| | | +--rw volume* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw vim-volume-id string<br />
| | | +--rw interface* [name]<br />
| | | +--rw name string<br />
| | | +--rw ip-address? inet:ip-address<br />
| | | +--rw mac-address? ietf-yang:mac-address<br />
| | | +--rw floating-ip-required? boolean<br />
| | +--rw internal-vld* [name]<br />
| | +--rw name string<br />
| | +--rw vim-network-name? string<br />
| | +--rw ip-profile<br />
| | | +--rw ip-version? inet:ip-version<br />
| | | +--rw subnet-address? inet:ip-prefix<br />
| | | +--rw gateway-address? inet:ip-prefix<br />
| | | +--rw dns-server* [address]<br />
| | | | +--rw address inet:ip-address<br />
| | | +--rw dhcp-params<br />
| | | +--rw enabled? boolean<br />
| | | +--rw count? uint8<br />
| | | +--rw start-address? inet:ip-address<br />
| | +--rw internal-connection-point* [id-ref]<br />
| | +--rw id-ref string<br />
| | +--rw ip-address? inet:ip-address<br />
| +--rw vld* [name]<br />
| +--rw name string<br />
| +--rw vim-network-name? string<br />
| +--rw ip-profile<br />
| | +--rw ip-version? inet:ip-version<br />
| | +--rw subnet-address? inet:ip-prefix<br />
| | +--rw gateway-address? inet:ip-prefix<br />
| | +--rw dns-server* [address]<br />
| | | +--rw address inet:ip-address<br />
| | +--rw dhcp-params<br />
| | +--rw enabled? boolean<br />
| | +--rw count? uint8<br />
| | +--rw start-address? inet:ip-address<br />
| +--rw vnfd-connection-point-ref* [member-vnf-index-ref vnfd-connection-point-ref]<br />
| +--rw member-vnf-index-ref -> /nsd:nsd-catalog/nsd/constituent-vnfd/member-vnf-index<br />
| +--rw vnfd-connection-point-ref -> /vnfd:vnfd-catalog/vnfd/connection-point/name<br />
| +--rw ip-address? inet:ip-address<br />
+--rw netslice-connection-point* [name]<br />
| +--rw name string<br />
| +--rw floating-ip-required? boolean<br />
| +--rw (connection)?<br />
| +--:(netslice-vld-ref)<br />
| | +--rw netslice-vld-id-ref? -> ../../netslice-vld/id<br />
| +--:(nsd-connection-point-ref)<br />
| +--rw nsd-id-ref? -> /nsd:nsd-catalog/nsd/id<br />
| +--rw nsd-connection-point-ref? -> /nsd:nsd-catalog/nsd/connection-point/name<br />
+--rw netslice-vld* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw short-name? string<br />
| +--rw vendor? string<br />
| +--rw description? string<br />
| +--rw version? string<br />
| +--rw type? manotypes:virtual-link-type<br />
| +--rw root-bandwidth? uint64<br />
| +--rw leaf-bandwidth? uint64<br />
| +--rw provider-network<br />
| | +--rw physical-network? string<br />
| | +--rw segmentation_id? uint32<br />
| +--rw mgmt-network? boolean<br />
| +--rw nss-connection-point-ref* [nss-ref nsd-connection-point-ref]<br />
| +--rw nss-ref -> /nst/netslice-subnet/id<br />
| +--rw nsd-connection-point-ref -> /nsd:nsd-catalog/nsd/connection-point/name<br />
| +--rw ip-address? inet:ip-address<br />
+--rw netslicefgd* [id]<br />
+--rw id string<br />
+--rw name? string<br />
+--rw short-name? string<br />
+--rw vendor? string<br />
+--rw description? string<br />
+--rw version? string<br />
+--rw rsp* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw nsd-connection-point-ref* [nsd-ref]<br />
| +--rw nsd-ref -> /nsd:nsd-catalog/nsd/id<br />
| +--rw order? uint8<br />
| +--rw nsd-connection-point-ref? -> /nsd:nsd-catalog/nsd/connection-point/name<br />
+--rw classifier* [id]<br />
+--rw id string<br />
+--rw name? string<br />
+--rw rsp-id-ref? -> ../../rsp/id<br />
+--rw match-attributes* [id]<br />
| +--rw id string<br />
| +--rw ip-proto? uint8<br />
| +--rw source-ip-address? inet:ip-address<br />
| +--rw destination-ip-address? inet:ip-address<br />
| +--rw source-port? inet:port-number<br />
| +--rw destination-port? inet:port-number<br />
+--rw nsd-ref? -> /nsd:nsd-catalog/nsd/id<br />
+--rw nsd-connection-point-ref? -> /nsd:nsd-catalog/nsd/connection-point/name<br />
</pre><br />
<br />
===VNFR tree===<br />
<br />
'''Navigable version:'''<br />
<br />
'''http://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/docs/osm-im/osm_im_trees/vnfr.html'''<br />
<br />
'''Plain text version:'''<br />
<pre><br />
module: vnfr<br />
augment /osm-project:project:<br />
+--ro vnfr-catalog<br />
+--ro schema-version? string<br />
+--ro vnfr* [id]<br />
+--ro id yang:uuid<br />
+--ro nsr-id-ref? yang:uuid<br />
+--ro member-vnf-index-ref? -> ../../../project-nsd:nsd-catalog/nsd/constituent-vnfd/member-vnf-index<br />
+--ro dashboard-url? inet:uri<br />
+--ro name? string<br />
+--ro short-name? string<br />
+--ro vendor? string<br />
+--ro description? string<br />
+--ro version? string<br />
+--ro create-time? uint32<br />
+--ro uptime? uint32<br />
+--ro vnfd<br />
| +--ro id? string<br />
| +--ro name string<br />
| +--ro short-name? string<br />
| +--ro vendor? string<br />
| +--ro logo? string<br />
| +--ro description? string<br />
| +--ro version? string<br />
| +--ro vnf-configuration<br />
| | +--ro (config-method)?<br />
| | | +--:(script)<br />
| | | | +--ro script<br />
| | | | +--ro script-type? enumeration<br />
| | | +--:(juju)<br />
| | | +--ro juju<br />
| | | +--ro charm? string<br />
| | | +--ro proxy? boolean<br />
| | | +--ro vca-relationships<br />
| | | +--ro relation* [requires provides]<br />
| | | +--ro requires string<br />
| | | +--ro provides string<br />
| | +--ro config-primitive* [name]<br />
| | | +--ro name string<br />
| | | +--ro parameter* [name]<br />
| | | | +--ro name string<br />
| | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | +--ro mandatory? boolean<br />
| | | | +--ro default-value? string<br />
| | | | +--ro parameter-pool? string<br />
| | | | +--ro read-only? boolean<br />
| | | | +--ro hidden? boolean<br />
| | | +--ro user-defined-script? string<br />
| | +--ro initial-config-primitive* [seq]<br />
| | | +--ro seq uint64<br />
| | | +--ro (primitive-type)?<br />
| | | +--:(primitive-definition)<br />
| | | +--ro name? string<br />
| | | +--ro parameter* [name]<br />
| | | | +--ro name string<br />
| | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | +--ro value? string<br />
| | | +--ro user-defined-script? string<br />
| | +--ro terminate-config-primitive* [seq]<br />
| | | +--ro seq uint64<br />
| | | +--ro name? string<br />
| | | +--ro parameter* [name]<br />
| | | | +--ro name string<br />
| | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | +--ro value? string<br />
| | | +--ro user-defined-script? string<br />
| | +--ro metrics* [name]<br />
| | | +--ro name string<br />
| | +--ro config-access<br />
| | +--ro ssh-access<br />
| | +--ro required? boolean<br />
| | +--ro default-user? string<br />
| +--ro operational-status? vnf-operational-status<br />
| +--ro mgmt-interface<br />
| | +--ro (endpoint-type)?<br />
| | | +--:(ip)<br />
| | | | +--ro ip-address? inet:ip-address<br />
| | | +--:(vdu-id)<br />
| | | | +--ro vdu-id? -> ../../vdu/id<br />
| | | +--:(cp)<br />
| | | +--ro cp? -> ../../connection-point/name<br />
| | +--ro port? inet:port-number<br />
| | +--ro dashboard-params<br />
| | +--ro path? string<br />
| | +--ro https? boolean<br />
| | +--ro port? inet:port-number<br />
| +--ro internal-vld* [id]<br />
| | +--ro id string<br />
| | +--ro name? string<br />
| | +--ro short-name? string<br />
| | +--ro description? string<br />
| | +--ro type? manotypes:virtual-link-type<br />
| | +--ro root-bandwidth? uint64<br />
| | +--ro leaf-bandwidth? uint64<br />
| | +--ro internal-connection-point* [id-ref]<br />
| | | +--ro id-ref -> ../../../vdu/internal-connection-point/id<br />
| | | +--ro ip-address? inet:ip-address<br />
| | +--ro provider-network<br />
| | | +--ro physical-network? string<br />
| | | +--ro segmentation_id? uint32<br />
| | +--ro (init-params)?<br />
| | +--:(vim-network-ref)<br />
| | | +--ro vim-network-name? string<br />
| | +--:(vim-network-profile)<br />
| | +--ro ip-profile-ref? string<br />
| +--ro ip-profiles* [name]<br />
| | +--ro name string<br />
| | +--ro description? string<br />
| | +--ro ip-profile-params<br />
| | +--ro ip-version? inet:ip-version<br />
| | +--ro subnet-address? inet:ip-prefix<br />
| | +--ro gateway-address? inet:ip-address<br />
| | +--ro security-group? string<br />
| | +--ro dns-server* [address]<br />
| | | +--ro address inet:ip-address<br />
| | +--ro dhcp-params<br />
| | | +--ro enabled? boolean<br />
| | | +--ro start-address? inet:ip-address<br />
| | | +--ro count? uint32<br />
| | +--ro subnet-prefix-pool? string<br />
| +--ro connection-point* [name]<br />
| | +--ro name string<br />
| | +--ro id? string<br />
| | +--ro short-name? string<br />
| | +--ro type? manotypes:connection-point-type<br />
| | +--ro port-security-enabled? boolean<br />
| | +--ro internal-vld-ref? -> ../../internal-vld/id<br />
| +--ro vdu* [id]<br />
| | +--ro id string<br />
| | +--ro name? string<br />
| | +--ro description? string<br />
| | +--ro pdu-type? string<br />
| | +--ro count? uint64<br />
| | +--ro mgmt-vpci? string<br />
| | +--ro vm-flavor<br />
| | | +--ro vcpu-count? uint16<br />
| | | +--ro memory-mb? uint64<br />
| | | +--ro storage-gb? uint64<br />
| | +--ro guest-epa<br />
| | | +--ro trusted-execution? boolean<br />
| | | +--ro mempage-size? enumeration<br />
| | | +--ro (cpu-policy)?<br />
| | | | +--:(cpu-pinning)<br />
| | | | | +--ro cpu-pinning-policy? enumeration<br />
| | | | | +--ro cpu-thread-pinning-policy? enumeration<br />
| | | | +--:(cpu-quota)<br />
| | | | +--ro cpu-quota<br />
| | | | +--ro limit? uint64<br />
| | | | +--ro reserve? uint64<br />
| | | | +--ro shares? uint64<br />
| | | +--ro mem-quota<br />
| | | | +--ro limit? uint64<br />
| | | | +--ro reserve? uint64<br />
| | | | +--ro shares? uint64<br />
| | | +--ro disk-io-quota<br />
| | | | +--ro limit? uint64<br />
| | | | +--ro reserve? uint64<br />
| | | | +--ro shares? uint64<br />
| | | +--ro vif-quota<br />
| | | | +--ro limit? uint64<br />
| | | | +--ro reserve? uint64<br />
| | | | +--ro shares? uint64<br />
| | | +--ro pcie-device* [device-id]<br />
| | | | +--ro device-id string<br />
| | | | +--ro count? uint64<br />
| | | +--ro (numa-policy)?<br />
| | | +--:(numa-unaware)<br />
| | | | +--ro numa-unaware? empty<br />
| | | +--:(numa-aware)<br />
| | | +--ro numa-node-policy<br />
| | | +--ro node-cnt? uint16<br />
| | | +--ro mem-policy? enumeration<br />
| | | +--ro node* [id]<br />
| | | +--ro id uint64<br />
| | | +--ro vcpu* [id]<br />
| | | | +--ro id uint64<br />
| | | +--ro memory-mb? uint64<br />
| | | +--ro (om-numa-type)?<br />
| | | +--:(cores)<br />
| | | | +--ro num-cores? uint8<br />
| | | +--:(paired-threads)<br />
| | | | +--ro paired-threads<br />
| | | | +--ro num-paired-threads? uint8<br />
| | | | +--ro paired-thread-ids* [thread-a]<br />
| | | | +--ro thread-a uint8<br />
| | | | +--ro thread-b? uint8<br />
| | | +--:(threads)<br />
| | | +--ro num-threads? uint8<br />
| | +--ro vswitch-epa<br />
| | | +--ro ovs-acceleration? enumeration<br />
| | | +--ro ovs-offload? enumeration<br />
| | +--ro hypervisor-epa<br />
| | | +--ro type? enumeration<br />
| | | +--ro version? string<br />
| | +--ro host-epa<br />
| | | +--ro cpu-model? enumeration<br />
| | | +--ro cpu-arch? enumeration<br />
| | | +--ro cpu-vendor? enumeration<br />
| | | +--ro cpu-socket-count? uint64<br />
| | | +--ro cpu-core-count? uint64<br />
| | | +--ro cpu-core-thread-count? uint64<br />
| | | +--ro cpu-feature* [feature]<br />
| | | | +--ro feature cpu-feature-type<br />
| | | +--ro om-cpu-model-string? string<br />
| | | +--ro om-cpu-feature* [feature]<br />
| | | +--ro feature string<br />
| | +--ro alarm* [alarm-id]<br />
| | | +--ro alarm-id string<br />
| | | +--ro vnf-monitoring-param-ref? -> ../../monitoring-param/id<br />
| | | +--ro name? string<br />
| | | +--ro description? string<br />
| | | +--ro vdur-id? string<br />
| | | +--ro actions<br />
| | | | +--ro ok* [url]<br />
| | | | | +--ro url string<br />
| | | | +--ro insufficient-data* [url]<br />
| | | | | +--ro url string<br />
| | | | +--ro alarm* [url]<br />
| | | | +--ro url string<br />
| | | +--ro repeat? boolean<br />
| | | +--ro enabled? boolean<br />
| | | +--ro severity? alarm-severity-type<br />
| | | +--ro statistic? alarm-statistic-type<br />
| | | +--ro operation? relational-operation-type<br />
| | | +--ro value? decimal64<br />
| | | +--ro period? uint32<br />
| | | +--ro evaluations? uint32<br />
| | +--ro image? string<br />
| | +--ro image-checksum? string<br />
| | +--ro alternative-images* [vim-type]<br />
| | | +--ro vim-type string<br />
| | | +--ro image? string<br />
| | | +--ro image-checksum? string<br />
| | +--ro vdu-configuration<br />
| | | +--ro (config-method)?<br />
| | | | +--:(script)<br />
| | | | | +--ro script<br />
| | | | | +--ro script-type? enumeration<br />
| | | | +--:(juju)<br />
| | | | +--ro juju<br />
| | | | +--ro charm? string<br />
| | | | +--ro proxy? boolean<br />
| | | | +--ro vca-relationships<br />
| | | | +--ro relation* [requires provides]<br />
| | | | +--ro requires string<br />
| | | | +--ro provides string<br />
| | | +--ro config-primitive* [name]<br />
| | | | +--ro name string<br />
| | | | +--ro parameter* [name]<br />
| | | | | +--ro name string<br />
| | | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | | +--ro mandatory? boolean<br />
| | | | | +--ro default-value? string<br />
| | | | | +--ro parameter-pool? string<br />
| | | | | +--ro read-only? boolean<br />
| | | | | +--ro hidden? boolean<br />
| | | | +--ro user-defined-script? string<br />
| | | +--ro initial-config-primitive* [seq]<br />
| | | | +--ro seq uint64<br />
| | | | +--ro (primitive-type)?<br />
| | | | +--:(primitive-definition)<br />
| | | | +--ro name? string<br />
| | | | +--ro parameter* [name]<br />
| | | | | +--ro name string<br />
| | | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | | +--ro value? string<br />
| | | | +--ro user-defined-script? string<br />
| | | +--ro terminate-config-primitive* [seq]<br />
| | | | +--ro seq uint64<br />
| | | | +--ro name? string<br />
| | | | +--ro parameter* [name]<br />
| | | | | +--ro name string<br />
| | | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | | +--ro value? string<br />
| | | | +--ro user-defined-script? string<br />
| | | +--ro metrics* [name]<br />
| | | | +--ro name string<br />
| | | +--ro config-access<br />
| | | +--ro ssh-access<br />
| | | +--ro required? boolean<br />
| | | +--ro default-user? string<br />
| | +--ro monitoring-param* [id]<br />
| | | +--ro id string<br />
| | | +--ro nfvi-metric? manotypes:nfvi-metric-type<br />
| | | +--ro interface-name-ref? -> ../../interface/name<br />
| | +--ro (cloud-init-input)?<br />
| | | +--:(inline)<br />
| | | | +--ro cloud-init? string<br />
| | | +--:(filename)<br />
| | | +--ro cloud-init-file? string<br />
| | +--ro supplemental-boot-data<br />
| | | +--ro boot-data-drive? boolean<br />
| | +--ro internal-connection-point* [id]<br />
| | | +--ro name? string<br />
| | | +--ro id string<br />
| | | +--ro short-name? string<br />
| | | +--ro type? manotypes:connection-point-type<br />
| | | +--ro port-security-enabled? boolean<br />
| | | +--ro internal-vld-ref? -> ../../../internal-vld/id<br />
| | +--ro interface* [name]<br />
| | | +--ro name string<br />
| | | +--ro position? uint32<br />
| | | +--ro mgmt-interface? boolean<br />
| | | +--ro type? interface-type<br />
| | | +--ro mac-address? string<br />
| | | +--ro (connection-point-type)?<br />
| | | | +--:(internal)<br />
| | | | | +--ro internal-connection-point-ref? -> ../../internal-connection-point/id<br />
| | | | +--:(external)<br />
| | | | +--ro external-connection-point-ref? -> ../../../connection-point/name<br />
| | | +--ro virtual-interface<br />
| | | +--ro type? enumeration<br />
| | | +--ro vpci? string<br />
| | | +--ro bandwidth? uint64<br />
| | +--ro volumes* [name]<br />
| | +--ro name string<br />
| | +--ro description? string<br />
| | +--ro size? uint64<br />
| | +--ro (volume-source)?<br />
| | | +--:(ephemeral)<br />
| | | | +--ro ephemeral? empty<br />
| | | +--:(image)<br />
| | | +--ro image? string<br />
| | | +--ro image-checksum? string<br />
| | +--ro device-bus? enumeration<br />
| | +--ro device-type? enumeration<br />
| +--ro vdu-dependency* [vdu-source-ref]<br />
| | +--ro vdu-source-ref -> ../../vdu/id<br />
| | +--ro vdu-depends-on-ref? -> ../../vdu/id<br />
| +--ro service-function-chain? enumeration<br />
| +--ro service-function-type? string<br />
| +--ro http-endpoint* [path]<br />
| | +--ro path string<br />
| | +--ro https? boolean<br />
| | +--ro port? inet:port-number<br />
| | +--ro username? string<br />
| | +--ro password? string<br />
| | +--ro polling-interval-secs? uint8<br />
| | +--ro method? manotypes:http-method<br />
| | +--ro headers* [key]<br />
| | +--ro key string<br />
| | +--ro value? string<br />
| +--ro scaling-group-descriptor* [name]<br />
| | +--ro name string<br />
| | +--ro scaling-policy* [name]<br />
| | | +--ro name string<br />
| | | +--ro scaling-type? manotypes:scaling-policy-type<br />
| | | +--ro enabled? boolean<br />
| | | +--ro scale-in-operation-type? manotypes:scaling-criteria-operation<br />
| | | +--ro scale-out-operation-type? manotypes:scaling-criteria-operation<br />
| | | +--ro threshold-time uint32<br />
| | | +--ro cooldown-time uint32<br />
| | | +--ro scaling-criteria* [name]<br />
| | | +--ro name string<br />
| | | +--ro scale-in-threshold? decimal64<br />
| | | +--ro scale-in-relational-operation? manotypes:relational-operation-type<br />
| | | +--ro scale-out-threshold? decimal64<br />
| | | +--ro scale-out-relational-operation? manotypes:relational-operation-type<br />
| | | +--ro vnf-monitoring-param-ref? -> ../../../../monitoring-param/id<br />
| | +--ro vdu* [vdu-id-ref]<br />
| | | +--ro vdu-id-ref -> ../../../vdu/id<br />
| | | +--ro count? uint32<br />
| | +--ro min-instance-count? uint32<br />
| | +--ro max-instance-count? uint32<br />
| | +--ro scaling-config-action* [trigger]<br />
| | +--ro trigger manotypes:scaling-trigger<br />
| | +--ro vnf-config-primitive-name-ref? -> ../../../vnf-configuration/config-primitive/name<br />
| +--ro monitoring-param* [id]<br />
| | +--ro id string<br />
| | +--ro name? string<br />
| | +--ro aggregation-type? aggregation-type<br />
| | +--ro (monitoring-type)?<br />
| | | +--:(vdu-monitoring-param)<br />
| | | | +--ro vdu-monitoring-param<br />
| | | | +--ro vdu-ref? -> ../../../vdu/id<br />
| | | | +--ro vdu-monitoring-param-ref? -> ../../../vdu[id = current()/../vdu-ref]/monitoring-param/id<br />
| | | +--:(vnf-metric)<br />
| | | | +--ro vnf-metric<br />
| | | | +--ro vnf-metric-name-ref? -> ../../../vnf-configuration/metrics/name<br />
| | | +--:(vdu-metric)<br />
| | | +--ro vdu-metric<br />
| | | +--ro vdu-ref? -> ../../../vdu/id<br />
| | | +--ro vdu-metric-name-ref? -> ../../../vdu[id = current()/../vdu-ref]/vdu-configuration/metrics/name<br />
| | +--ro http-endpoint-ref? -> ../../http-endpoint/path<br />
| | +--ro json-query-method? manotypes:json-query-method<br />
| | +--ro json-query-params<br />
| | | +--ro json-path? string<br />
| | | +--ro object-path? string<br />
| | +--ro description? string<br />
| | +--ro group-tag? string<br />
| | +--ro widget-type? manotypes:widget-type<br />
| | +--ro units? string<br />
| | +--ro value-type? param-value-type<br />
| | +--ro numeric-constraints<br />
| | | +--ro min-value? uint64<br />
| | | +--ro max-value? uint64<br />
| | +--ro text-constraints<br />
| | | +--ro min-length? uint8<br />
| | | +--ro max-length? uint8<br />
| | +--ro value-integer? int64<br />
| | +--ro value-decimal? decimal64<br />
| | +--ro value-string? string<br />
| +--ro placement-groups* [name]<br />
| +--ro name string<br />
| +--ro requirement? string<br />
| +--ro strategy? enumeration<br />
| +--ro member-vdus* [member-vdu-ref]<br />
| +--ro member-vdu-ref -> ../../../vdu/id<br />
+--ro vnfd-ref? -> ../../../project-vnfd:vnfd-catalog/vnfd/id<br />
+--ro vnf-configuration<br />
| +--ro (config-method)?<br />
| | +--:(script)<br />
| | | +--ro script<br />
| | | +--ro script-type? enumeration<br />
| | +--:(juju)<br />
| | +--ro juju<br />
| | +--ro charm? string<br />
| | +--ro proxy? boolean<br />
| | +--ro vca-relationships<br />
| | +--ro relation* [requires provides]<br />
| | +--ro requires string<br />
| | +--ro provides string<br />
| +--ro config-primitive* [name]<br />
| | +--ro name string<br />
| | +--ro parameter* [name]<br />
| | | +--ro name string<br />
| | | +--ro data-type? manotypes:parameter-data-type<br />
| | | +--ro mandatory? boolean<br />
| | | +--ro default-value? string<br />
| | | +--ro parameter-pool? string<br />
| | | +--ro read-only? boolean<br />
| | | +--ro hidden? boolean<br />
| | +--ro user-defined-script? string<br />
| +--ro initial-config-primitive* [seq]<br />
| | +--ro seq uint64<br />
| | +--ro (primitive-type)?<br />
| | +--:(primitive-definition)<br />
| | +--ro name? string<br />
| | +--ro parameter* [name]<br />
| | | +--ro name string<br />
| | | +--ro data-type? manotypes:parameter-data-type<br />
| | | +--ro value? string<br />
| | +--ro user-defined-script? string<br />
| +--ro terminate-config-primitive* [seq]<br />
| | +--ro seq uint64<br />
| | +--ro name? string<br />
| | +--ro parameter* [name]<br />
| | | +--ro name string<br />
| | | +--ro data-type? manotypes:parameter-data-type<br />
| | | +--ro value? string<br />
| | +--ro user-defined-script? string<br />
| +--ro metrics* [name]<br />
| +--ro name string<br />
+--ro mgmt-interface<br />
| +--ro ip-address? inet:ip-address<br />
| +--ro port? inet:port-number<br />
| +--ro ssh-key<br />
| +--ro public-key? string<br />
| +--ro private-key-file? string<br />
+--ro internal-vlr* [vlr-ref]<br />
| +--ro vlr-ref -> ../../../../vlr:vlr-catalog/vlr/id<br />
| +--ro internal-connection-point-ref* -> ../../vdur/internal-connection-point/id<br />
+--ro connection-point* [name]<br />
| +--ro name string<br />
| +--ro id? string<br />
| +--ro short-name? string<br />
| +--ro type? manotypes:connection-point-type<br />
| +--ro port-security-enabled? boolean<br />
| +--ro vlr-ref? -> ../../../../vlr:vlr-catalog/vlr/id<br />
| +--ro ip-address? inet:ip-address<br />
| +--ro mac-address? string<br />
| +--ro connection-point-id? string<br />
| +--ro virtual-cps* [name]<br />
| +--ro name string<br />
| +--ro id? string<br />
| +--ro short-name? string<br />
| +--ro type? manotypes:connection-point-type<br />
| +--ro port-security-enabled? boolean<br />
| +--ro ip-address? inet:ip-address<br />
| +--ro mac-address? string<br />
| +--ro connection-point-id? string<br />
+--ro vdur* [id]<br />
| +--ro id yang:uuid<br />
| +--ro name? string<br />
| +--ro unique-short-name? string<br />
| +--ro vdu-id-ref? -> ../../vnfd/vdu/id<br />
| +--ro vim-id? string<br />
| +--ro flavor-id? string<br />
| +--ro image-id? string<br />
| +--ro management-ip? inet:ip-address<br />
| +--ro vm-management-ip? inet:ip-address<br />
| +--ro console-url? inet:uri<br />
| +--ro vm-flavor<br />
| | +--ro vcpu-count? uint16<br />
| | +--ro memory-mb? uint64<br />
| | +--ro storage-gb? uint64<br />
| +--ro guest-epa<br />
| | +--ro trusted-execution? boolean<br />
| | +--ro mempage-size? enumeration<br />
| | +--ro (cpu-policy)?<br />
| | | +--:(cpu-pinning)<br />
| | | | +--ro cpu-pinning-policy? enumeration<br />
| | | | +--ro cpu-thread-pinning-policy? enumeration<br />
| | | +--:(cpu-quota)<br />
| | | +--ro cpu-quota<br />
| | | +--ro limit? uint64<br />
| | | +--ro reserve? uint64<br />
| | | +--ro shares? uint64<br />
| | +--ro mem-quota<br />
| | | +--ro limit? uint64<br />
| | | +--ro reserve? uint64<br />
| | | +--ro shares? uint64<br />
| | +--ro disk-io-quota<br />
| | | +--ro limit? uint64<br />
| | | +--ro reserve? uint64<br />
| | | +--ro shares? uint64<br />
| | +--ro vif-quota<br />
| | | +--ro limit? uint64<br />
| | | +--ro reserve? uint64<br />
| | | +--ro shares? uint64<br />
| | +--ro pcie-device* [device-id]<br />
| | | +--ro device-id string<br />
| | | +--ro count? uint64<br />
| | +--ro (numa-policy)?<br />
| | +--:(numa-unaware)<br />
| | | +--ro numa-unaware? empty<br />
| | +--:(numa-aware)<br />
| | +--ro numa-node-policy<br />
| | +--ro node-cnt? uint16<br />
| | +--ro mem-policy? enumeration<br />
| | +--ro node* [id]<br />
| | +--ro id uint64<br />
| | +--ro vcpu* [id]<br />
| | | +--ro id uint64<br />
| | +--ro memory-mb? uint64<br />
| | +--ro (om-numa-type)?<br />
| | +--:(cores)<br />
| | | +--ro num-cores? uint8<br />
| | +--:(paired-threads)<br />
| | | +--ro paired-threads<br />
| | | +--ro num-paired-threads? uint8<br />
| | | +--ro paired-thread-ids* [thread-a]<br />
| | | +--ro thread-a uint8<br />
| | | +--ro thread-b? uint8<br />
| | +--:(threads)<br />
| | +--ro num-threads? uint8<br />
| +--ro vswitch-epa<br />
| | +--ro ovs-acceleration? enumeration<br />
| | +--ro ovs-offload? enumeration<br />
| +--ro hypervisor-epa<br />
| | +--ro type? enumeration<br />
| | +--ro version? string<br />
| +--ro host-epa<br />
| | +--ro cpu-model? enumeration<br />
| | +--ro cpu-arch? enumeration<br />
| | +--ro cpu-vendor? enumeration<br />
| | +--ro cpu-socket-count? uint64<br />
| | +--ro cpu-core-count? uint64<br />
| | +--ro cpu-core-thread-count? uint64<br />
| | +--ro cpu-feature* [feature]<br />
| | | +--ro feature cpu-feature-type<br />
| | +--ro om-cpu-model-string? string<br />
| | +--ro om-cpu-feature* [feature]<br />
| | +--ro feature string<br />
| +--ro supplemental-boot-data<br />
| | +--ro boot-data-drive? boolean<br />
| +--ro vdu-configuration<br />
| | +--ro (config-method)?<br />
| | | +--:(script)<br />
| | | | +--ro script<br />
| | | | +--ro script-type? enumeration<br />
| | | +--:(juju)<br />
| | | +--ro juju<br />
| | | +--ro charm? string<br />
| | | +--ro proxy? boolean<br />
| | | +--ro vca-relationships<br />
| | | +--ro relation* [requires provides]<br />
| | | +--ro requires string<br />
| | | +--ro provides string<br />
| | +--ro config-primitive* [name]<br />
| | | +--ro name string<br />
| | | +--ro parameter* [name]<br />
| | | | +--ro name string<br />
| | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | +--ro mandatory? boolean<br />
| | | | +--ro default-value? string<br />
| | | | +--ro parameter-pool? string<br />
| | | | +--ro read-only? boolean<br />
| | | | +--ro hidden? boolean<br />
| | | +--ro user-defined-script? string<br />
| | +--ro initial-config-primitive* [seq]<br />
| | | +--ro seq uint64<br />
| | | +--ro (primitive-type)?<br />
| | | +--:(primitive-definition)<br />
| | | +--ro name? string<br />
| | | +--ro parameter* [name]<br />
| | | | +--ro name string<br />
| | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | +--ro value? string<br />
| | | +--ro user-defined-script? string<br />
| | +--ro terminate-config-primitive* [seq]<br />
| | | +--ro seq uint64<br />
| | | +--ro name? string<br />
| | | +--ro parameter* [name]<br />
| | | | +--ro name string<br />
| | | | +--ro data-type? manotypes:parameter-data-type<br />
| | | | +--ro value? string<br />
| | | +--ro user-defined-script? string<br />
| | +--ro metrics* [name]<br />
| | +--ro name string<br />
| +--ro monitoring-param* [id]<br />
| | +--ro id string<br />
| | +--ro nfvi-metric? manotypes:nfvi-metric-type<br />
| | +--ro interface-name-ref? -> ../../interface/name<br />
| +--ro volumes* [name]<br />
| | +--ro name string<br />
| | +--ro volume-id? string<br />
| | +--ro description? string<br />
| | +--ro size? uint64<br />
| | +--ro (volume-source)?<br />
| | | +--:(ephemeral)<br />
| | | | +--ro ephemeral? empty<br />
| | | +--:(image)<br />
| | | +--ro image? string<br />
| | | +--ro image-checksum? string<br />
| | +--ro device-bus? enumeration<br />
| | +--ro device-type? enumeration<br />
| +--ro internal-connection-point* [id]<br />
| | +--ro name? string<br />
| | +--ro id string<br />
| | +--ro short-name? string<br />
| | +--ro type? manotypes:connection-point-type<br />
| | +--ro port-security-enabled? boolean<br />
| | +--ro ip-address? inet:ip-address<br />
| | +--ro mac-address? string<br />
| | +--ro connection-point-id? string<br />
| | +--ro virtual-cps* [name]<br />
| | +--ro name string<br />
| | +--ro id? string<br />
| | +--ro short-name? string<br />
| | +--ro type? manotypes:connection-point-type<br />
| | +--ro port-security-enabled? boolean<br />
| | +--ro ip-address? inet:ip-address<br />
| | +--ro mac-address? string<br />
| | +--ro connection-point-id? string<br />
| +--ro interface* [name]<br />
| | +--ro name string<br />
| | +--ro position? uint32<br />
| | +--ro type? vnfd-base:interface-type<br />
| | +--ro (connection-point-type)?<br />
| | | +--:(internal)<br />
| | | | +--ro internal-connection-point-ref? -> ../../internal-connection-point/id<br />
| | | +--:(external)<br />
| | | +--ro external-connection-point-ref? -> ../../../connection-point/name<br />
| | +--ro virtual-interface<br />
| | +--ro type? enumeration<br />
| | +--ro bandwidth? uint64<br />
| | +--ro ovs-offload? enumeration<br />
| | +--ro vendor-id? string<br />
| | +--ro datapath-library? string<br />
| | +--ro provider-network-name? string<br />
| +--ro operational-status? vdu-operational-status<br />
| +--ro placement-groups-info* [name]<br />
| +--ro name string<br />
| +--ro requirement? string<br />
| +--ro strategy? enumeration<br />
| +--ro cloud-type? manotypes:cloud-account-type<br />
| +--ro (cloud-provider)?<br />
| +--:(openstack)<br />
| | +--ro availability-zone<br />
| | | +--ro name? string<br />
| | +--ro server-group<br />
| | | +--ro name? string<br />
| | +--ro host-aggregate* [metadata-key]<br />
| | +--ro metadata-key string<br />
| | +--ro metadata-value? string<br />
| +--:(aws)<br />
| | +--ro aws-construct? empty<br />
| +--:(openmano)<br />
| | +--ro openmano-construct? empty<br />
| +--:(vsphere)<br />
| | +--ro vsphere-construct? empty<br />
| +--:(mock)<br />
| | +--ro mock-construct? empty<br />
| +--:(cloudsim)<br />
| +--ro cloudsim-construct? empty<br />
+--ro monitoring-param* [id]<br />
| +--ro id string<br />
| +--ro name? string<br />
| +--ro aggregation-type? aggregation-type<br />
| +--ro (monitoring-type)?<br />
| +--:(vdu-monitoring-param)<br />
| | +--ro vdu-monitoring-param<br />
| | +--ro vdu-ref? -> ../../../vdur/id<br />
| | +--ro vdu-monitoring-param-ref? -> ../../../vdur[id = current()/../vdu-ref]/monitoring-param/id<br />
| +--:(vnf-metric)<br />
| | +--ro vnf-metric<br />
| | +--ro vnf-metric-name-ref? -> ../../../vnf-configuration/metrics/name<br />
| +--:(vdu-metric)<br />
| +--ro vdu-metric<br />
| +--ro vdu-ref? -> ../../../vdur/id<br />
| +--ro vdu-metric-name-ref? -> ../../../vdur[id = current()/../vdu-ref]/vdu-configuration/metrics/name<br />
+--ro operational-status? vnf-operational-status<br />
+--ro config-status? enumeration<br />
+--ro placement-groups-info* [name]<br />
| +--ro name string<br />
| +--ro requirement? string<br />
| +--ro strategy? enumeration<br />
| +--ro cloud-type? manotypes:cloud-account-type<br />
| +--ro (cloud-provider)?<br />
| +--:(openstack)<br />
| | +--ro availability-zone<br />
| | | +--ro name? string<br />
| | +--ro server-group<br />
| | | +--ro name? string<br />
| | +--ro host-aggregate* [metadata-key]<br />
| | +--ro metadata-key string<br />
| | +--ro metadata-value? string<br />
| +--:(aws)<br />
| | +--ro aws-construct? empty<br />
| +--:(openmano)<br />
| | +--ro openmano-construct? empty<br />
| +--:(vsphere)<br />
| | +--ro vsphere-construct? empty<br />
| +--:(mock)<br />
| | +--ro mock-construct? empty<br />
| +--:(cloudsim)<br />
| +--ro cloudsim-construct? empty<br />
+--ro cloud-config<br />
+--ro key-pair* [name]<br />
| +--ro name string<br />
| +--ro key? string<br />
+--ro user* [name]<br />
+--ro name string<br />
+--ro user-info? string<br />
+--ro key-pair* [name]<br />
+--ro name string<br />
+--ro key? string<br />
</pre><br />
<br />
===NSR tree===<br />
<br />
'''Navigable version:'''<br />
<br />
'''http://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/docs/osm-im/osm_im_trees/nsr.html'''<br />
<br />
'''Plain text version:'''<br />
<pre><br />
module: nsr<br />
augment /osm-project:project:<br />
+--rw key-pair* [name]<br />
+--rw name string<br />
+--rw key? string<br />
augment /osm-project:project:<br />
+--rw ns-instance-config<br />
+--rw nsr* [id]<br />
+--rw schema-version? string<br />
+--rw id yang:uuid<br />
+--rw name? string<br />
+--rw short-name? string<br />
+--rw description? string<br />
+--rw admin-status? enumeration<br />
+--rw nsd<br />
| +--rw id? string<br />
| +--rw name string<br />
| +--rw short-name? string<br />
| +--rw vendor? string<br />
| +--rw logo? string<br />
| +--rw description? string<br />
| +--rw version? string<br />
| +--rw connection-point* [name]<br />
| | +--rw name string<br />
| | +--rw floating-ip-required? boolean<br />
| | +--rw type? manotypes:connection-point-type<br />
| | +--rw (connection)?<br />
| | +--:(vld-ref)<br />
| | | +--rw vld-id-ref? -> ../../vld/id<br />
| | +--:(vnfd-connection-point-ref)<br />
| | +--rw member-vnf-index-ref? -> ../../constituent-vnfd/member-vnf-index<br />
| | +--rw vnfd-id-ref? -> ../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
| | +--rw vnfd-connection-point-ref? -> /vnfd:vnfd-catalog/vnfd[vnfd:id = current()/../vnfd-id-ref]/connection-point/name<br />
| +--rw scaling-group-descriptor* [name]<br />
| | +--rw name string<br />
| | +--rw scaling-policy* [name]<br />
| | | +--rw name string<br />
| | | +--rw scaling-type? manotypes:scaling-policy-type<br />
| | | +--rw enabled? boolean<br />
| | | +--rw scale-in-operation-type? manotypes:scaling-criteria-operation<br />
| | | +--rw scale-out-operation-type? manotypes:scaling-criteria-operation<br />
| | | +--rw threshold-time uint32<br />
| | | +--rw cooldown-time uint32<br />
| | | +--rw scaling-criteria* [name]<br />
| | | +--rw name string<br />
| | | +--rw scale-in-threshold? uint64<br />
| | | +--rw scale-in-relational-operation? manotypes:relational-operation-type<br />
| | | +--rw scale-out-threshold? uint64<br />
| | | +--rw scale-out-relational-operation? manotypes:relational-operation-type<br />
| | | +--rw ns-monitoring-param-ref? -> ../../../../monitoring-param/id<br />
| | +--rw vnfd-member* [member-vnf-index-ref]<br />
| | | +--rw member-vnf-index-ref -> ../../../constituent-vnfd/member-vnf-index<br />
| | | +--rw count? uint32<br />
| | +--rw min-instance-count? uint32<br />
| | +--rw max-instance-count? uint32<br />
| | +--rw scaling-config-action* [trigger]<br />
| | +--rw trigger manotypes:scaling-trigger<br />
| | +--rw ns-config-primitive-name-ref? -> ../../../ns-configuration/config-primitive/name<br />
| +--rw vnffgd* [id]<br />
| | +--rw id string<br />
| | +--rw name? string<br />
| | +--rw short-name? string<br />
| | +--rw vendor? string<br />
| | +--rw description? string<br />
| | +--rw version? string<br />
| | +--rw rsp* [id]<br />
| | | +--rw id string<br />
| | | +--rw name? string<br />
| | | +--rw vnfd-connection-point-ref* [member-vnf-index-ref]<br />
| | | +--rw member-vnf-index-ref -> ../../../../constituent-vnfd/member-vnf-index<br />
| | | +--rw order? uint8<br />
| | | +--rw vnfd-id-ref? -> ../../../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
| | | +--rw vnfd-ingress-connection-point-ref? string<br />
| | | +--rw vnfd-egress-connection-point-ref? string<br />
| | +--rw classifier* [id]<br />
| | +--rw id string<br />
| | +--rw name? string<br />
| | +--rw rsp-id-ref? -> ../../rsp/id<br />
| | +--rw match-attributes* [id]<br />
| | | +--rw id string<br />
| | | +--rw ip-proto? uint8<br />
| | | +--rw source-ip-address? inet:ip-address<br />
| | | +--rw destination-ip-address? inet:ip-address<br />
| | | +--rw source-port? inet:port-number<br />
| | | +--rw destination-port? inet:port-number<br />
| | +--rw member-vnf-index-ref? -> ../../../constituent-vnfd/member-vnf-index<br />
| | +--rw vnfd-id-ref? -> ../../../constituent-vnfd[member-vnf-index = current()/../member-vnf-index-ref]/vnfd-id-ref<br />
| | +--rw vnfd-connection-point-ref? string<br />
| +--rw ip-profiles* [name]<br />
| | +--rw name string<br />
| | +--rw description? string<br />
| | +--rw ip-profile-params<br />
| | +--rw ip-version? inet:ip-version<br />
| | +--rw subnet-address? inet:ip-prefix<br />
| | +--rw gateway-address? inet:ip-address<br />
| | +--rw security-group? string<br />
| | +--rw dns-server* [address]<br />
| | | +--rw address inet:ip-address<br />
| | +--rw dhcp-params<br />
| | | +--rw enabled? boolean<br />
| | | +--rw start-address? inet:ip-address<br />
| | | +--rw count? uint32<br />
| | +--rw subnet-prefix-pool? string<br />
| +--rw ns-configuration<br />
| | +--rw (config-method)?<br />
| | | +--:(script)<br />
| | | | +--rw script<br />
| | | | +--rw script-type? enumeration<br />
| | | +--:(juju)<br />
| | | +--rw juju<br />
| | | +--rw charm? string<br />
| | | +--rw proxy? boolean<br />
| | | +--rw vca-relationships<br />
| | | +--rw relation* [requires provides]<br />
| | | +--rw requires string<br />
| | | +--rw provides string<br />
| | +--rw config-primitive* [name]<br />
| | | +--rw name string<br />
| | | +--rw parameter* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw data-type? manotypes:parameter-data-type<br />
| | | | +--rw mandatory? boolean<br />
| | | | +--rw default-value? string<br />
| | | | +--rw parameter-pool? string<br />
| | | | +--rw read-only? boolean<br />
| | | | +--rw hidden? boolean<br />
| | | +--rw user-defined-script? string<br />
| | +--rw initial-config-primitive* [seq]<br />
| | | +--rw seq uint64<br />
| | | +--rw (primitive-type)?<br />
| | | +--:(primitive-definition)<br />
| | | +--rw name? string<br />
| | | +--rw parameter* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw data-type? manotypes:parameter-data-type<br />
| | | | +--rw value? string<br />
| | | +--rw user-defined-script? string<br />
| | +--rw terminate-config-primitive* [seq]<br />
| | | +--rw seq uint64<br />
| | | +--rw name? string<br />
| | | +--rw parameter* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw data-type? manotypes:parameter-data-type<br />
| | | | +--rw value? string<br />
| | | +--rw user-defined-script? string<br />
| | +--rw metrics* [name]<br />
| | +--rw name string<br />
| +--rw input-parameter-xpath* [xpath]<br />
| | +--rw xpath string<br />
| | +--rw label? string<br />
| | +--rw default-value? string<br />
| +--rw parameter-pool* [name]<br />
| | +--rw name string<br />
| | +--rw range<br />
| | +--rw start-value uint32<br />
| | +--rw end-value uint32<br />
| +--rw key-pair* [name]<br />
| | +--rw name string<br />
| | +--rw key? string<br />
| +--rw user* [name]<br />
| | +--rw name string<br />
| | +--rw user-info? string<br />
| | +--rw key-pair* [name]<br />
| | +--rw name string<br />
| | +--rw key? string<br />
| +--rw vld* [id]<br />
| | +--rw id string<br />
| | +--rw name? string<br />
| | +--rw short-name? string<br />
| | +--rw vendor? string<br />
| | +--rw description? string<br />
| | +--rw version? string<br />
| | +--rw type? manotypes:virtual-link-type<br />
| | +--rw root-bandwidth? uint64<br />
| | +--rw leaf-bandwidth? uint64<br />
| | +--rw provider-network<br />
| | | +--rw physical-network? string<br />
| | | +--rw segmentation_id? uint32<br />
| | +--rw mgmt-network? boolean<br />
| | +--rw (init-params)?<br />
| | | +--:(vim-network-ref)<br />
| | | | +--rw vim-network-name? string<br />
| | | +--:(vim-network-profile)<br />
| | | +--rw ip-profile-ref? -> ../../ip-profiles/name<br />
| | +--rw vnfd-connection-point-ref* [member-vnf-index-ref vnfd-connection-point-ref]<br />
| | +--rw member-vnf-index-ref -> ../../../constituent-vnfd/member-vnf-index<br />
| | +--rw vnfd-id-ref? string<br />
| | +--rw vnfd-connection-point-ref -> ../../../../../../project-vnfd:vnfd-catalog/vnfd[project-vnfd:id = current()/../vnfd-id-ref]/connection-point/name<br />
| +--rw constituent-vnfd* [member-vnf-index]<br />
| | +--rw member-vnf-index string<br />
| | +--rw vnfd-id-ref? -> /osm-project:project[osm-project:name = current()/../../../../../name]/project-vnfd:vnfd-catalog/vnfd/id<br />
| | +--rw start-by-default? boolean<br />
| +--rw placement-groups* [name]<br />
| | +--rw name string<br />
| | +--rw requirement? string<br />
| | +--rw strategy? enumeration<br />
| | +--rw member-vnfd* [member-vnf-index-ref]<br />
| | +--rw member-vnf-index-ref -> ../../../constituent-vnfd/member-vnf-index<br />
| | +--rw vnfd-id-ref? -> ../../../../../../project-vnfd:vnfd-catalog/vnfd/id<br />
| +--rw vnf-dependency* [vnf-source-ref]<br />
| | +--rw vnf-source-ref -> ../../../../../project-vnfd:vnfd-catalog/vnfd/id<br />
| | +--rw vnf-depends-on-ref? -> ../../../../../project-vnfd:vnfd-catalog/vnfd/id<br />
| +--rw monitoring-param* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw value-type? param-value-type<br />
| +--rw numeric-constraints<br />
| | +--rw min-value? uint64<br />
| | +--rw max-value? uint64<br />
| +--rw text-constraints<br />
| | +--rw min-length? uint8<br />
| | +--rw max-length? uint8<br />
| +--rw value-integer? int64<br />
| +--rw value-decimal? decimal64<br />
| +--rw value-string? string<br />
| +--rw description? string<br />
| +--rw group-tag? string<br />
| +--rw widget-type? manotypes:widget-type<br />
| +--rw units? string<br />
| +--rw aggregation-type? aggregation-type<br />
| +--rw vnfd-monitoring-param* [member-vnf-index-ref vnfd-monitoring-param-ref]<br />
| +--rw vnfd-id-ref? string<br />
| +--rw vnfd-monitoring-param-ref -> ../../../../../../project-vnfd:vnfd-catalog/vnfd[project-vnfd:id = current()/../vnfd-id-ref]/monitoring-param/id<br />
| +--rw member-vnf-index-ref -> ../../../constituent-vnfd/member-vnf-index<br />
+--rw input-parameter* [xpath]<br />
| +--rw xpath string<br />
| +--rw value? string<br />
+--rw scaling-group* [scaling-group-name-ref]<br />
| +--rw scaling-group-name-ref string<br />
| +--rw instance* [id]<br />
| +--rw id uint16<br />
+--rw nsd-placement-group-maps* [placement-group-ref]<br />
| +--rw placement-group-ref string<br />
| +--rw cloud-type? manotypes:cloud-account-type<br />
| +--rw (cloud-provider)?<br />
| +--:(openstack)<br />
| | +--rw availability-zone<br />
| | | +--rw name? string<br />
| | +--rw server-group<br />
| | | +--rw name? string<br />
| | +--rw host-aggregate* [metadata-key]<br />
| | +--rw metadata-key string<br />
| | +--rw metadata-value? string<br />
| +--:(aws)<br />
| | +--rw aws-construct? empty<br />
| +--:(openmano)<br />
| | +--rw openmano-construct? empty<br />
| +--:(vsphere)<br />
| | +--rw vsphere-construct? empty<br />
| +--:(mock)<br />
| | +--rw mock-construct? empty<br />
| +--:(cloudsim)<br />
| +--rw cloudsim-construct? empty<br />
+--rw vnfd-placement-group-maps* [placement-group-ref vnfd-id-ref]<br />
| +--rw vnfd-id-ref yang:uuid<br />
| +--rw placement-group-ref -> ../../../../project-vnfd:vnfd-catalog/vnfd[project-vnfd:id = current()/../vnfd-id-ref]/placement-groups/name<br />
| +--rw cloud-type? manotypes:cloud-account-type<br />
| +--rw (cloud-provider)?<br />
| +--:(openstack)<br />
| | +--rw availability-zone<br />
| | | +--rw name? string<br />
| | +--rw server-group<br />
| | | +--rw name? string<br />
| | +--rw host-aggregate* [metadata-key]<br />
| | +--rw metadata-key string<br />
| | +--rw metadata-value? string<br />
| +--:(aws)<br />
| | +--rw aws-construct? empty<br />
| +--:(openmano)<br />
| | +--rw openmano-construct? empty<br />
| +--:(vsphere)<br />
| | +--rw vsphere-construct? empty<br />
| +--:(mock)<br />
| | +--rw mock-construct? empty<br />
| +--:(cloudsim)<br />
| +--rw cloudsim-construct? empty<br />
+--rw ssh-authorized-key* [key-pair-ref]<br />
| +--rw key-pair-ref -> ../../../../key-pair/name<br />
+--rw user* [name]<br />
+--rw name string<br />
+--rw user-info? string<br />
+--rw ssh-authorized-key* [key-pair-ref]<br />
+--rw key-pair-ref -> ../../../../../key-pair/name<br />
augment /osm-project:project:<br />
+--ro ns-instance-opdata<br />
+--ro nsr* [ns-instance-config-ref]<br />
+--ro ns-instance-config-ref -> ../../../ns-instance-config/nsr/id<br />
+--ro name-ref? -> ../../../ns-instance-config/nsr[id=current()/../ns-instance-config-ref]/name<br />
+--ro nsd-ref? -> ../../../ns-instance-config/nsr[id=current()/../ns-instance-config-ref]/nsd/id<br />
+--ro nsd-name-ref? -> ../../../ns-instance-config/nsr[id=current()/../ns-instance-config-ref]/nsd/name<br />
+--ro create-time? uint32<br />
+--ro uptime? uint32<br />
+--ro connection-point* [name]<br />
| +--ro name string<br />
| +--ro type? manotypes:connection-point-type<br />
+--ro vlr* [vlr-ref]<br />
| +--ro vlr-ref -> ../../../../vlr:vlr-catalog/vlr/id<br />
| +--ro vnfr-connection-point-ref* [vnfr-id]<br />
| +--ro vnfr-id -> ../../../../../vnfr:vnfr-catalog/vnfr/id<br />
| +--ro connection-point? -> ../../../../../vnfr:vnfr-catalog/vnfr[vnfr:id = current()/../vnfr-id]/connection-point/name<br />
+--ro constituent-vnfr-ref* [vnfr-id]<br />
| +--ro vnfr-id string<br />
+--ro scaling-group-record* [scaling-group-name-ref]<br />
| +--ro scaling-group-name-ref -> ../../../../ns-instance-config/nsr[id=current()/../../ns-instance-config-ref]/nsd/scaling-group-descriptor/name<br />
| +--ro instance* [instance-id]<br />
| +--ro instance-id uint16<br />
| +--ro is-default? boolean<br />
| +--ro op-status? enumeration<br />
| +--ro config-status? config-states<br />
| +--ro error-msg? string<br />
| +--ro create-time? uint32<br />
| +--ro vnfrs* -> ../../../constituent-vnfr-ref/vnfr-id<br />
+--ro vnffgr* [id]<br />
| +--ro id yang:uuid<br />
| +--ro vnffgd-id-ref? -> ../../../../ns-instance-config/nsr[id=current()/../../ns-instance-config-ref]/nsd/vnffgd/id<br />
| +--ro vnffgd-name-ref? -> ../../../../ns-instance-config/nsr[id=current()/../../ns-instance-config-ref]/nsd/vnffgd[id=current()/../vnffgd-id-ref]/name<br />
| +--ro sdn-account? string<br />
| +--ro cloud-account? string<br />
| +--ro operational-status? vnffgr-operational-status<br />
| +--ro rsp* [id]<br />
| | +--ro id yang:uuid<br />
| | +--ro name? string<br />
| | +--ro rsp-id? yang:uuid<br />
| | +--ro vnffgd-rsp-id-ref? -> ../../../../../ns-instance-config/nsr[id=current()/../../../ns-instance-config-ref]/nsd/vnffgd[id=current()/../../vnffgd-id-ref]/rsp/id<br />
| | +--ro vnffgd-rsp-name-ref? -> ../../../../../ns-instance-config/nsr[id=current()/../../../ns-instance-config-ref]/nsd/vnffgd[id=current()/../../vnffgd-id-ref]/rsp[id=current()/../vnffgd-rsp-id-ref]/name<br />
| | +--ro classifier-name? string<br />
| | +--ro path-id? uint32<br />
| | +--ro vnfr-connection-point-ref* [hop-number]<br />
| | +--ro hop-number uint8<br />
| | +--ro service-function-type? string<br />
| | +--ro member-vnf-index-ref? string<br />
| | +--ro vnfd-id-ref? string<br />
| | +--ro vnfr-id-ref? -> ../../../../../../vnfr:vnfr-catalog/vnfr/id<br />
| | +--ro vnfr-name-ref? -> ../../../../../../vnfr:vnfr-catalog/vnfr/name<br />
| | +--ro vnfr-ingress-connection-point-ref? -> ../../../../../../vnfr:vnfr-catalog/vnfr[vnfr:id = current()/../vnfr-id-ref]/connection-point/name<br />
| | +--ro vnfr-egress-connection-point-ref? -> ../../../../../../vnfr:vnfr-catalog/vnfr[vnfr:id = current()/../vnfr-id-ref]/connection-point/name<br />
| | +--ro service-index? uint8<br />
| | +--ro connection-point-params<br />
| | | +--ro mgmt-address? inet:ip-address<br />
| | | +--ro name? string<br />
| | | +--ro port-id? string<br />
| | | +--ro vm-id? string<br />
| | | +--ro address? inet:ip-address<br />
| | | +--ro port? inet:port-number<br />
| | +--ro service-function-forwarder<br />
| | +--ro name? string<br />
| | +--ro ip-address? inet:ip-address<br />
| | +--ro port? inet:port-number<br />
| +--ro classifier* [id]<br />
| +--ro id yang:uuid<br />
| +--ro name? string<br />
| +--ro classifier-id* yang:uuid<br />
| +--ro rsp-id-ref? -> ../../rsp/id<br />
| +--ro rsp-name? string<br />
| +--ro vnfr-id-ref? -> ../../../../../vnfr:vnfr-catalog/vnfr/id<br />
| +--ro vnfr-name-ref? -> ../../../../../vnfr:vnfr-catalog/vnfr/name<br />
| +--ro vnfr-connection-point-ref? -> ../../../../../vnfr:vnfr-catalog/vnfr[vnfr:id = current()/../vnfr-id-ref]/connection-point/name<br />
| +--ro port-id? string<br />
| +--ro vm-id? string<br />
| +--ro ip-address? string<br />
| +--ro sff-name? string<br />
+--ro operational-status? ns-operational-status<br />
+--ro ns-configuration<br />
| +--ro (config-method)?<br />
| | +--:(script)<br />
| | | +--ro script<br />
| | | +--ro script-type? enumeration<br />
| | +--:(juju)<br />
| | +--ro juju<br />
| | +--ro charm? string<br />
| | +--ro proxy? boolean<br />
| | +--ro vca-relationships<br />
| | +--ro relation* [requires provides]<br />
| | +--ro requires string<br />
| | +--ro provides string<br />
| +--ro config-primitive* [name]<br />
| | +--ro name string<br />
| | +--ro parameter* [name]<br />
| | | +--ro name string<br />
| | | +--ro data-type? manotypes:parameter-data-type<br />
| | | +--ro mandatory? boolean<br />
| | | +--ro default-value? string<br />
| | | +--ro parameter-pool? string<br />
| | | +--ro read-only? boolean<br />
| | | +--ro hidden? boolean<br />
| | +--ro user-defined-script? string<br />
| +--ro initial-config-primitive* [seq]<br />
| | +--ro seq uint64<br />
| | +--ro (primitive-type)?<br />
| | +--:(primitive-definition)<br />
| | +--ro name? string<br />
| | +--ro parameter* [name]<br />
| | | +--ro name string<br />
| | | +--ro data-type? manotypes:parameter-data-type<br />
| | | +--ro value? string<br />
| | +--ro user-defined-script? string<br />
| +--ro terminate-config-primitive* [seq]<br />
| | +--ro seq uint64<br />
| | +--ro name? string<br />
| | +--ro parameter* [name]<br />
| | | +--ro name string<br />
| | | +--ro data-type? manotypes:parameter-data-type<br />
| | | +--ro value? string<br />
| | +--ro user-defined-script? string<br />
| +--ro metrics* [name]<br />
| +--ro name string<br />
+--ro config-status? config-states<br />
+--ro monitoring-param* [id]<br />
| +--ro value-type? param-value-type<br />
| +--ro numeric-constraints<br />
| | +--ro min-value? uint64<br />
| | +--ro max-value? uint64<br />
| +--ro text-constraints<br />
| | +--ro min-length? uint8<br />
| | +--ro max-length? uint8<br />
| +--ro value-integer? int64<br />
| +--ro value-decimal? decimal64<br />
| +--ro value-string? string<br />
| +--ro description? string<br />
| +--ro group-tag? string<br />
| +--ro widget-type? manotypes:widget-type<br />
| +--ro units? string<br />
| +--ro aggregation-type? aggregation-type<br />
| +--ro id string<br />
| +--ro name? string<br />
| +--ro nsd-mon-param-ref? -> ../../../../project-nsd:nsd-catalog/nsd[project-nsd:id = current()/../../nsd-ref]/monitoring-param/id<br />
| +--ro vnfr-mon-param-ref* [vnfr-id-ref vnfr-mon-param-ref]<br />
| +--ro vnfr-id-ref yang:uuid<br />
| +--ro vnfr-mon-param-ref -> ../../../../../vnfr:vnfr-catalog/vnfr[vnfr:id = current()/../vnfr-id-ref]/monitoring-param/id<br />
+--ro config-agent-job* [job-id]<br />
+--ro job-id uint64<br />
+--ro job-name? string<br />
+--ro job-status? enumeration<br />
+--ro triggered-by? trigger-type<br />
+--ro create-time? uint32<br />
+--ro job-status-details? string<br />
+--ro parameter* [name]<br />
| +--ro name string<br />
| +--ro data-type? manotypes:parameter-data-type<br />
| +--ro value? string<br />
+--ro parameter-group* [name]<br />
| +--ro name string<br />
| +--ro parameter* [name]<br />
| +--ro name string<br />
| +--ro data-type? manotypes:parameter-data-type<br />
| +--ro value? string<br />
+--ro vnfr* [id]<br />
+--ro id yang:uuid<br />
+--ro vnf-job-status? enumeration<br />
+--ro primitive* [name]<br />
+--ro name string<br />
+--ro parameter* [name]<br />
| +--ro name string<br />
| +--ro data-type? manotypes:parameter-data-type<br />
| +--ro value? string<br />
+--ro execution-id? string<br />
+--ro execution-status? enumeration<br />
+--ro execution-error-details? string<br />
<br />
rpcs:<br />
+---x get-ns-config-primitive-values<br />
| +---w input<br />
| | +---w name string<br />
| | +---w project-name? -> /osm-project:project/name<br />
| | +---w nsr_id_ref -> /osm-project:project[osm-project:name=current()/../nsr:project-name]/ns-instance-config/nsr/id<br />
| +--ro output<br />
| +--ro ns-parameter* [name]<br />
| | +--ro name string<br />
| | +--ro value? string<br />
| +--ro ns-parameter-group* [name]<br />
| | +--ro name string<br />
| | +--ro parameter* [name]<br />
| | +--ro name string<br />
| | +--ro value? string<br />
| +--ro vnf-primitive-group* [member-vnf-index-ref]<br />
| +--ro member-vnf-index-ref string<br />
| +--ro vnfd-id-ref? string<br />
| +--ro primitive* [index]<br />
| +--ro index uint32<br />
| +--ro name? string<br />
| +--ro parameter* [name]<br />
| +--ro name string<br />
| +--ro value? string<br />
+---x exec-ns-config-primitive<br />
| +---w input<br />
| | +---w name? string<br />
| | +---w project-name? -> /osm-project:project/name<br />
| | +---w nsr_id_ref -> /osm-project:project[osm-project:name=current()/../nsr:project-name]/ns-instance-config/nsr/id<br />
| | +---w triggered-by? trigger-type<br />
| | +---w parameter* [name]<br />
| | | +---w name string<br />
| | | +---w data-type? manotypes:parameter-data-type<br />
| | | +---w value? string<br />
| | +---w parameter-group* [name]<br />
| | | +---w name string<br />
| | | +---w parameter* [name]<br />
| | | +---w name string<br />
| | | +---w data-type? manotypes:parameter-data-type<br />
| | | +---w value? string<br />
| | +---w vnf-list* [member_vnf_index_ref]<br />
| | | +---w member_vnf_index_ref uint64<br />
| | | +---w vnfr-id-ref? yang:uuid<br />
| | | +---w vnf-primitive* [index]<br />
| | | +---w index uint32<br />
| | | +---w name? string<br />
| | | +---w parameter* [name]<br />
| | | +---w name string<br />
| | | +---w data-type? manotypes:parameter-data-type<br />
| | | +---w value? string<br />
| | +---w user-defined-script? string<br />
| +--ro output<br />
| +--ro job-id? uint64<br />
| +--ro name? string<br />
| +--ro project-name? -> /osm-project:project/name<br />
| +--ro nsr_id_ref -> /osm-project:project[osm-project:name=current()/../nsr:project-name]/ns-instance-config/nsr/id<br />
| +--ro triggered-by? trigger-type<br />
| +--ro create-time? uint32<br />
| +--ro job-status-details? string<br />
| +--ro parameter* [name]<br />
| | +--ro name string<br />
| | +--ro data-type? manotypes:parameter-data-type<br />
| | +--ro value? string<br />
| +--ro parameter-group* [name]<br />
| | +--ro name string<br />
| | +--ro parameter* [name]<br />
| | +--ro name string<br />
| | +--ro data-type? manotypes:parameter-data-type<br />
| | +--ro value? string<br />
| +--ro vnf-out-list* [member_vnf_index_ref]<br />
| +--ro member_vnf_index_ref uint64<br />
| +--ro vnfr-id-ref? yang:uuid<br />
| +--ro vnf-out-primitive* [index]<br />
| +--ro index uint32<br />
| +--ro name? string<br />
| +--ro parameter* [name]<br />
| | +--ro name string<br />
| | +--ro data-type? manotypes:parameter-data-type<br />
| | +--ro value? string<br />
| +--ro execution-id? string<br />
| +--ro execution-status? string<br />
| +--ro execution-error-details? string<br />
+---x exec-scale-in<br />
| +---w input<br />
| | +---w project-name? -> /osm-project:project/name<br />
| | +---w nsr_id_ref -> /osm-project:project[osm-project:name=current()/../nsr:project-name]/ns-instance-config/nsr/id<br />
| | +---w scaling-group-name-ref -> /osm-project:project[osm-project:name=current()/../nsr:project-name]/ns-instance-config/nsr[nsr:id=current()/../nsr_id_ref]/nsd/scaling-group-descriptor/name<br />
| | +---w instance-id -> /osm-project:project[osm-project:name=current()/../nsr:project-name]/ns-instance-config/nsr[nsr:id=current()/../nsr_id_ref]/scaling-group[nsr:scaling-group-name-ref=current()/../scaling-group-name-ref]/instance/id<br />
| +--ro output<br />
| +--ro instance-id? uint64<br />
+---x exec-scale-out<br />
| +---w input<br />
| | +---w project-name? -> /osm-project:project/name<br />
| | +---w nsr_id_ref -> /osm-project:project[osm-project:name=current()/../nsr:project-name]/ns-instance-config/nsr/id<br />
| | +---w scaling-group-name-ref -> /osm-project:project[osm-project:name=current()/../nsr:project-name]/ns-instance-config/nsr[nsr:id=current()/../nsr_id_ref]/nsd/scaling-group-descriptor/name<br />
| | +---w instance-id? uint64<br />
| +--ro output<br />
| +--ro instance-id? uint64<br />
+---x start-network-service<br />
+---w input<br />
| +---w name string<br />
| +---w project-name? -> /osm-project:project/name<br />
| +---w nsd_id_ref? -> /osm-project:project[osm-project:name=current()/../project-name]/project-nsd:nsd-catalog/nsd/id<br />
| +---w input-parameter* [xpath]<br />
| | +---w xpath string<br />
| | +---w value? string<br />
| +---w scaling-group* [scaling-group-name-ref]<br />
| | +---w scaling-group-name-ref string<br />
| | +---w instance* [id]<br />
| | +---w id uint16<br />
| +---w nsd-placement-group-maps* [placement-group-ref]<br />
| | +---w placement-group-ref string<br />
| | +---w cloud-type? manotypes:cloud-account-type<br />
| | +---w (cloud-provider)?<br />
| | +--:(openstack)<br />
| | | +---w availability-zone<br />
| | | | +---w name? string<br />
| | | +---w server-group<br />
| | | | +---w name? string<br />
| | | +---w host-aggregate* [metadata-key]<br />
| | | +---w metadata-key string<br />
| | | +---w metadata-value? string<br />
| | +--:(aws)<br />
| | | +---w aws-construct? empty<br />
| | +--:(openmano)<br />
| | | +---w openmano-construct? empty<br />
| | +--:(vsphere)<br />
| | | +---w vsphere-construct? empty<br />
| | +--:(mock)<br />
| | | +---w mock-construct? empty<br />
| | +--:(cloudsim)<br />
| | +---w cloudsim-construct? empty<br />
| +---w vnfd-placement-group-maps* [placement-group-ref vnfd-id-ref]<br />
| +---w vnfd-id-ref yang:uuid<br />
| +---w placement-group-ref -> /osm-project:project[osm-project:name=current()/../../project-name]/project-vnfd:vnfd-catalog/vnfd[project-vnfd:id = current()/../vnfd-id-ref]/placement-groups/name<br />
| +---w cloud-type? manotypes:cloud-account-type<br />
| +---w (cloud-provider)?<br />
| | +--:(openstack)<br />
| | | +---w availability-zone<br />
| | | | +---w name? string<br />
| | | +---w server-group<br />
| | | | +---w name? string<br />
| | | +---w host-aggregate* [metadata-key]<br />
| | | +---w metadata-key string<br />
| | | +---w metadata-value? string<br />
| | +--:(aws)<br />
| | | +---w aws-construct? empty<br />
| | +--:(openmano)<br />
| | | +---w openmano-construct? empty<br />
| | +--:(vsphere)<br />
| | | +---w vsphere-construct? empty<br />
| | +--:(mock)<br />
| | | +---w mock-construct? empty<br />
| | +--:(cloudsim)<br />
| | +---w cloudsim-construct? empty<br />
| +---w ssh-authorized-key* [key-pair-ref]<br />
| | +---w key-pair-ref -> /osm-project:project[osm-project:name=current()/../../../project-name]/key-pair/name<br />
| +---w user* [name]<br />
| +---w name string<br />
| +---w user-info? string<br />
| +---w ssh-authorized-key* [key-pair-ref]<br />
| +---w key-pair-ref -> /osm-project:project[osm-project:name=current()/../../../../project-name]/key-pair/name<br />
+--ro output<br />
+--ro nsr-id? yang:uuid<br />
</pre><br />
<br />
===NSI tree===<br />
<br />
'''Navigable version:'''<br />
<br />
'''http://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/docs/osm-im/osm_im_trees/nsi.html'''<br />
<br />
'''Plain text version:'''<br />
<pre><br />
module: nsi<br />
+--rw nsi* [id]<br />
+--rw id yang:uuid<br />
+--rw name string<br />
+--rw short-name? string<br />
+--rw description? string<br />
+--rw nst-ref -> /nst:nst/id<br />
+--rw instantiation-parameters<br />
| +--rw vimAccountId string<br />
| +--rw ssh_keys? string<br />
| +--rw netslice-subnet* [id]<br />
| | +--rw id string<br />
| | +--rw vimAccountId string<br />
| | +--rw ssh_keys? string<br />
| | +--rw vnf* [member-vnf-index]<br />
| | | +--rw member-vnf-index string<br />
| | | +--rw vimAccountId? string<br />
| | | +--rw vdu* [id]<br />
| | | | +--rw id string<br />
| | | | +--rw volume* [name]<br />
| | | | | +--rw name string<br />
| | | | | +--rw vim-volume-id string<br />
| | | | +--rw interface* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw ip-address? inet:ip-address<br />
| | | | +--rw mac-address? ietf-yang:mac-address<br />
| | | | +--rw floating-ip-required? boolean<br />
| | | +--rw internal-vld* [name]<br />
| | | +--rw name string<br />
| | | +--rw vim-network-name? string<br />
| | | +--rw ip-profile<br />
| | | | +--rw ip-version? inet:ip-version<br />
| | | | +--rw subnet-address? inet:ip-prefix<br />
| | | | +--rw gateway-address? inet:ip-prefix<br />
| | | | +--rw dns-server* [address]<br />
| | | | | +--rw address inet:ip-address<br />
| | | | +--rw dhcp-params<br />
| | | | +--rw enabled? boolean<br />
| | | | +--rw count? uint8<br />
| | | | +--rw start-address? inet:ip-address<br />
| | | +--rw internal-connection-point* [id-ref]<br />
| | | +--rw id-ref string<br />
| | | +--rw ip-address? inet:ip-address<br />
| | +--rw vld* [name]<br />
| | +--rw name string<br />
| | +--rw vim-network-name? string<br />
| | +--rw ip-profile<br />
| | | +--rw ip-version? inet:ip-version<br />
| | | +--rw subnet-address? inet:ip-prefix<br />
| | | +--rw gateway-address? inet:ip-prefix<br />
| | | +--rw dns-server* [address]<br />
| | | | +--rw address inet:ip-address<br />
| | | +--rw dhcp-params<br />
| | | +--rw enabled? boolean<br />
| | | +--rw count? uint8<br />
| | | +--rw start-address? inet:ip-address<br />
| | +--rw vnfd-connection-point-ref* [member-vnf-index-ref vnfd-connection-point-ref]<br />
| | +--rw member-vnf-index-ref -> /nsd:nsd-catalog/nsd/constituent-vnfd/member-vnf-index<br />
| | +--rw vnfd-connection-point-ref -> /vnfd:vnfd-catalog/vnfd/connection-point/name<br />
| | +--rw ip-address? inet:ip-address<br />
| +--rw netslice-vld* [name]<br />
| +--rw name string<br />
| +--rw vim-network-name? string<br />
| +--rw ip-profile<br />
| | +--rw ip-version? inet:ip-version<br />
| | +--rw subnet-address? inet:ip-prefix<br />
| | +--rw gateway-address? inet:ip-prefix<br />
| | +--rw dns-server* [address]<br />
| | | +--rw address inet:ip-address<br />
| | +--rw dhcp-params<br />
| | +--rw enabled? boolean<br />
| | +--rw count? uint8<br />
| | +--rw start-address? inet:ip-address<br />
| +--rw nss-connection-point-ref* [nss-ref nsd-connection-point-ref]<br />
| +--rw nss-ref -> /nst:nst/netslice-subnet/id<br />
| +--rw nsd-connection-point-ref -> /nsd:nsd-catalog/nsd/connection-point/name<br />
| +--rw ip-address? inet:ip-address<br />
+--rw network-slice-template<br />
| +--rw id string<br />
| +--rw name string<br />
| +--rw SNSSAI-identifier<br />
| | +--rw slice-service-type network-slice-type<br />
| | +--rw slice-differentiator? string<br />
| +--rw quality-of-service<br />
| | +--rw id uint16<br />
| | +--rw resource-type? resource-type<br />
| | +--rw priority-level? uint16<br />
| | +--rw packet-delay-budget? uint16<br />
| | +--rw packet-error-rate? uint16<br />
| | +--rw default-max-data-burst? uint16<br />
| +--rw netslice-subnet* [id]<br />
| | +--rw id string<br />
| | +--rw description? string<br />
| | +--rw is-shared-nss? boolean<br />
| | +--rw nsd-ref -> /nsd:nsd-catalog/nsd/id<br />
| | +--rw instantiation-parameters<br />
| | +--rw vimAccountId string<br />
| | +--rw ssh_keys? string<br />
| | +--rw vnf* [member-vnf-index]<br />
| | | +--rw member-vnf-index string<br />
| | | +--rw vimAccountId? string<br />
| | | +--rw vdu* [id]<br />
| | | | +--rw id string<br />
| | | | +--rw volume* [name]<br />
| | | | | +--rw name string<br />
| | | | | +--rw vim-volume-id string<br />
| | | | +--rw interface* [name]<br />
| | | | +--rw name string<br />
| | | | +--rw ip-address? inet:ip-address<br />
| | | | +--rw mac-address? ietf-yang:mac-address<br />
| | | | +--rw floating-ip-required? boolean<br />
| | | +--rw internal-vld* [name]<br />
| | | +--rw name string<br />
| | | +--rw vim-network-name? string<br />
| | | +--rw ip-profile<br />
| | | | +--rw ip-version? inet:ip-version<br />
| | | | +--rw subnet-address? inet:ip-prefix<br />
| | | | +--rw gateway-address? inet:ip-prefix<br />
| | | | +--rw dns-server* [address]<br />
| | | | | +--rw address inet:ip-address<br />
| | | | +--rw dhcp-params<br />
| | | | +--rw enabled? boolean<br />
| | | | +--rw count? uint8<br />
| | | | +--rw start-address? inet:ip-address<br />
| | | +--rw internal-connection-point* [id-ref]<br />
| | | +--rw id-ref string<br />
| | | +--rw ip-address? inet:ip-address<br />
| | +--rw vld* [name]<br />
| | +--rw name string<br />
| | +--rw vim-network-name? string<br />
| | +--rw ip-profile<br />
| | | +--rw ip-version? inet:ip-version<br />
| | | +--rw subnet-address? inet:ip-prefix<br />
| | | +--rw gateway-address? inet:ip-prefix<br />
| | | +--rw dns-server* [address]<br />
| | | | +--rw address inet:ip-address<br />
| | | +--rw dhcp-params<br />
| | | +--rw enabled? boolean<br />
| | | +--rw count? uint8<br />
| | | +--rw start-address? inet:ip-address<br />
| | +--rw vnfd-connection-point-ref* [member-vnf-index-ref vnfd-connection-point-ref]<br />
| | +--rw member-vnf-index-ref -> /nsd:nsd-catalog/nsd/constituent-vnfd/member-vnf-index<br />
| | +--rw vnfd-connection-point-ref -> /vnfd:vnfd-catalog/vnfd/connection-point/name<br />
| | +--rw ip-address? inet:ip-address<br />
| +--rw netslice-connection-point* [name]<br />
| | +--rw name string<br />
| | +--rw floating-ip-required? boolean<br />
| | +--rw (connection)?<br />
| | +--:(netslice-vld-ref)<br />
| | | +--rw netslice-vld-id-ref? -> ../../netslice-vld/id<br />
| | +--:(nsd-connection-point-ref)<br />
| | +--rw nsd-id-ref? -> /nsd:nsd-catalog/nsd/id<br />
| | +--rw nsd-connection-point-ref? -> /nsd:nsd-catalog/nsd/connection-point/name<br />
| +--rw netslice-vld* [id]<br />
| | +--rw id string<br />
| | +--rw name? string<br />
| | +--rw short-name? string<br />
| | +--rw vendor? string<br />
| | +--rw description? string<br />
| | +--rw version? string<br />
| | +--rw type? manotypes:virtual-link-type<br />
| | +--rw root-bandwidth? uint64<br />
| | +--rw leaf-bandwidth? uint64<br />
| | +--rw provider-network<br />
| | | +--rw physical-network? string<br />
| | | +--rw segmentation_id? uint32<br />
| | +--rw mgmt-network? boolean<br />
| | +--rw nss-connection-point-ref* [nss-ref nsd-connection-point-ref]<br />
| | +--rw nss-ref -> /nst:nst/netslice-subnet/id<br />
| | +--rw nsd-connection-point-ref -> /nsd:nsd-catalog/nsd/connection-point/name<br />
| | +--rw ip-address? inet:ip-address<br />
| +--rw netslicefgd* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw short-name? string<br />
| +--rw vendor? string<br />
| +--rw description? string<br />
| +--rw version? string<br />
| +--rw rsp* [id]<br />
| | +--rw id string<br />
| | +--rw name? string<br />
| | +--rw nsd-connection-point-ref* [nsd-ref]<br />
| | +--rw nsd-ref -> /nsd:nsd-catalog/nsd/id<br />
| | +--rw order? uint8<br />
| | +--rw nsd-connection-point-ref? -> /nsd:nsd-catalog/nsd/connection-point/name<br />
| +--rw classifier* [id]<br />
| +--rw id string<br />
| +--rw name? string<br />
| +--rw rsp-id-ref? -> ../../rsp/id<br />
| +--rw match-attributes* [id]<br />
| | +--rw id string<br />
| | +--rw ip-proto? uint8<br />
| | +--rw source-ip-address? inet:ip-address<br />
| | +--rw destination-ip-address? inet:ip-address<br />
| | +--rw source-port? inet:port-number<br />
| | +--rw destination-port? inet:port-number<br />
| +--rw nsd-ref? -> /nsd:nsd-catalog/nsd/id<br />
| +--rw nsd-connection-point-ref? -> /nsd:nsd-catalog/nsd/connection-point/name<br />
+--ro nsr-ref-list* [nsr-ref]<br />
| +--ro nsr-ref -> /osm-project:project/nsr:ns-instance-opdata/nsr/ns-instance-config-ref<br />
+--ro vlr-list* [id]<br />
+--ro id yang:uuid<br />
</pre><br />
<br />
==Release TWO Descriptor Documentation (OLD)==<br />
<br />
'''<br />
The document below contains a detailed description of the OSM Release TWO Models. Although a bit outdated, it can still be used as a reference to understand some of the fields in the VNFD and NSD.<br />
<br />
[[Media:OSM R2 Information Model.pdf]]</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=VNF_Primitives&diff=6079VNF Primitives2021-02-17T16:54:13Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
The following is a list of the default VNF primitives supported by OSM. These primitives, executed at Day 1 and Day 2, are the encapsulation of your operational logic.<br />
<br />
{| class="wikitable"<br />
! style="text-align:left;"| Primitive<br />
! Description<br />
! Required<br />
! Example<br />
|-<br />
| Config || Change the configuration of a VNF || No || [[VNF_Primitive_Config]]<br />
|-<br />
| Upgrade || Perform a VNF Software Upgrade || No || [[VNF_Primitive_Upgrade]]<br />
|-<br />
| Start || Start the VNF service || No || [[VNF_Primitive_Start]]<br />
|-<br />
| Stop || Stop the VNF service || No || [[VNF_Primitive_Stop]]<br />
|-<br />
| Restart || Stop the VNF service || No || [[VNF_Primitive_Restart]]<br />
|-<br />
| Reboot || Reboot the VNF || No || [[VNF_Primitive_Reboot]]<br />
|}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Example_VNF_Charms&diff=6078Example VNF Charms2021-02-17T16:54:03Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
==Example VNF Charms==<br />
<br />
This page is intended to be an index to VNF charms written by members of the OSM community. Please feel free to add links to your own examples below.<br />
<br />
=== Ansible ===<br />
<br />
Under the scope of a H2020 project, [https://5ginfire.eu/ 5GinFIRE] has developed a [https://github.com/5GinFIRE/mano/tree/master/charms/ansible-charm charm that enables the configuration of a VNF, instantiated through OSM, using an Ansible playbook]. The charm builds off of the base vnfproxy and ansible-base layers, and provides a template ready for customization that supports the execution of an Ansible playbook within the Juju framework used by OSM.<br />
<br />
=== UbuntuVNF 'Say Hello' Proxy Charm ===<br />
<br />
A single VDU VNF containing a simple proxy charm that takes a parameter (name) and sends a greeting to all the VM's terminals using the 'wall' command. It serves like an example that can be extended to send any command with parameters to VNFs. Download it from <span class="newwin">[https://github.com/gianpietro1/osmproxycharms here]</span><br />
<br />
=== Video Transcoder VNFs ===<br />
<br />
Under the scope of a H2020 project, [https://5ginfire.eu/ 5GinFIRE] has developed two Video Transcoding VNFs. The first uses [https://github.com/5GinFIRE/opencv_transcoder_vnf OpenCV] and the other uses [https://github.com/5GinFIRE/ffmpeg_transcoder_vnf FFMpeg]. Both VNFs use systemd to run the transcoding service. The systemd services are configured using Juju charms.<br />
There is also a small script that builds the VNF and NS packages that might be useful.</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Creating_your_own_VNF_charm_(Release_THREE)&diff=6077Creating your own VNF charm (Release THREE)2021-02-17T16:52:29Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
==Creating a VNF proxy charm==<br />
<br />
===What is a charm===<br />
<br />
A [https://jujucharms.com/docs/stable/charms charm] is a collection of scripts and metadata that encapsulate the distilled DevOps knowledge of experts in a particular product. These charms make it easy to reliably and repeatedly deploy applications, then scale them as required with minimal effort.<br />
<br />
Driven by [https://jujucharms.com/docs/stable/about-juju Juju], these charms manage the complete lifecycle of the application, including installation, configuration, clustering, and scaling.<br />
<br />
===What is a proxy charm===<br />
<br />
OSM Release THREE supports a limited version of charms that we call "proxy charms". These charms is responsible for doing Day 1 configuration. Configurations are mapped to [https://jujucharms.com/docs/stable/actions Juju Actions] which manage configuration within the VNFD qcow2 image (over SSH, via RESTful API, etc).<br />
<br />
The diagram below illustrates the OSM workflow:<br />
<br />
<nowiki><br />
+---------------------+ +---------------------+<br />
| <----+ |<br />
| Resource | | Service |<br />
| Orchestrator (RO) +----> Orchestrator (SO) |<br />
| | | |<br />
+------------------+--+ +-------+----^--------+<br />
| | |<br />
| | |<br />
| | |<br />
+-----v-----+ +-v----+--+<br />
| <-------+ |<br />
| Virtual | | Proxy |<br />
| Machine | | Charm |<br />
| +-------> |<br />
+-----------+ +---------+<br />
</nowiki><br />
<br />
The SO directs the RO to create a virtual machine using the selected VNF image. When that has successfully completed, the SO will instantiate a LXD container, managed by Juju, with the proxy charm. The proxy charm will then communicate with the VNF virtual machine to do Day 1 configuration.<br />
<br />
===Creating a proxy charm===<br />
<br />
====Setup====<br />
<br />
We recommend that you are running Ubuntu 16.04 or newer, or [https://docs.snapcraft.io/core/install install snapd] on the Linux distribution of your choice.<br />
<br />
Install the ''charm'' snap, which provides the charm command and libraries necessary to compile your charm:<br />
<br />
<nowiki><br />
snap install charm<br />
</nowiki><br />
<br />
Setup your workspace for writing layers and building charms:<br />
<br />
<nowiki><br />
mkdir -p ~/charms/layers<br />
export JUJU_REPOSITORY=~/charms<br />
export LAYER_PATH=$JUJU_REPOSITORY/layers<br />
cd $LAYER_PATH<br />
</nowiki><br />
<br />
====Layers====<br />
<br />
Layers are individual components that, when combined, result in a finished product. The diagram below describes what our example ''pingpong'' charm looks like, followed by a walkthrough of how it is built. The completed charm is available in the [https://osm.etsi.org/gitweb/?p=osm/juju-charms.git;a=summary juju-charms] repository.<br />
<br />
<nowiki><br />
+------------------+<br />
| |<br />
| Layers |<br />
| |<br />
| +------------+ |<br />
| | | |<br />
| | Base | |<br />
| | | |<br />
| +------+-----+ |<br />
| | |<br />
| +------v-----+ |<br />
| | | |<br />
| | sshproxy | | +-----------------+<br />
| | | | | |<br />
| +------+-----+ | | pingpong |<br />
| | +------------> |<br />
| +------v-----+ | | charm |<br />
| | | | | |<br />
| | vnfproxy | | +-----------------+<br />
| | | |<br />
| +------+-----+ |<br />
| | |<br />
| +------v-----+ |<br />
| | | |<br />
| | pingpong | |<br />
| | | |<br />
| +------------+ |<br />
| |<br />
+------------------+<br />
</nowiki><br />
<br />
Create the layer for your proxy charm:<br />
<br />
<nowiki><br />
charm create pingpong<br />
cd pingpong<br />
</nowiki><br />
<br />
This will create a charm layer ready for customization:<br />
<nowiki><br />
.<br />
├── config.yaml<br />
├── icon.svg<br />
├── layer.yaml<br />
├── metadata.yaml<br />
├── reactive<br />
│ └── pingpong.py<br />
├── README.ex<br />
└── tests<br />
├── 00-setup<br />
└── 10-deploy<br />
</nowiki><br />
<br />
Next, modify ''layers.yaml'' to the following:<br />
<br />
<nowiki><br />
includes:<br />
- layer:basic<br />
- layer:vnfproxy<br />
</nowiki><br />
<br />
The ''[https://jujucharms.com/docs/stable/authors-charm-metadata metadata.yaml]'' file describes what your charm is and sets certain properties used by Juju.<br />
<br />
<nowiki><br />
name: pingpong<br />
summary: A service to test latency between machines.<br />
maintainer: Adam Israel <adam.israel@canonical.com><br />
description: |<br />
The pingpong charm manages the pingpong vnfd deployed by Open Source Mano.<br />
tags:<br />
- nfv<br />
subordinate: false<br />
series:<br />
- trusty<br />
- xenial<br />
</nowiki><br />
<br />
<br />
This means that your charm will include the basic layer, required for all charms, and the vnfproxy layer, which has been designed to aid in the development in proxy charms by implementing common functionality.<br />
<br />
====Actions====<br />
<br />
There are three pieces that make up an action: ''actions.yaml'', which define an action, the ''actions/'' directory where we'll place a small script that invokes the reactive framework, and the python code in ''reactive/pingpong.py'' that performs said action.<br />
<br />
In ''actions.yaml'', we define the actions we wish to support:<br />
<br />
<nowiki><br />
set-server:<br />
description: "Set the target IP address and port"<br />
params:<br />
server-ip:<br />
description: "IP on which the target service is listening."<br />
type: string<br />
default: ""<br />
server-port:<br />
description: "Port on which the target service is listening."<br />
type: integer<br />
default: 5555<br />
required:<br />
- server-ip<br />
set-rate:<br />
description: "Set the rate of packet generation."<br />
params:<br />
rate:<br />
description: "Packet rate."<br />
type: integer<br />
default: 5<br />
get-stats:<br />
description: "Get the stats."<br />
get-state:<br />
description: "Get the admin state of the target service."<br />
get-rate:<br />
description: "Get the rate set on the target service."<br />
get-server:<br />
description: "Get the target server and IP set"<br />
</nowiki><br />
<br />
<br />
<nowiki><br />
mkdir actions/<br />
</nowiki><br />
<br />
For each action, we need to create a script to invoke the reactive framework. This is a boilerplate script that will be used for every action. The first step is to create the first action script.<br />
<br />
<nowiki><br />
<br />
cat <<'EOF' >> actions/set-server<br />
#!/usr/bin/env python3<br />
import sys<br />
sys.path.append('lib')<br />
<br />
from charms.reactive import main<br />
from charms.reactive import set_state<br />
from charmhelpers.core.hookenv import action_fail, action_name<br />
<br />
"""<br />
`set_state` only works here because it's flushed to disk inside the `main()`<br />
loop. remove_state will need to be called inside the action method.<br />
"""<br />
set_state('actions.{}'.format(action_name()))<br />
<br />
try:<br />
main()<br />
except Exception as e:<br />
action_fail(repr(e))<br />
EOF<br />
</nowiki><br />
<br />
After this, make the file executable.<br />
<br />
<nowiki><br />
chmod +x actions/set-server<br />
</nowiki><br />
<br />
Next, copy this script for the remaining actions:<br />
<nowiki><br />
cp actions/set-server actions/set-rate<br />
cp actions/set-server actions/get-stats<br />
cp actions/set-server actions/set-state<br />
cp actions/set-server actions/get-rate<br />
cp actions/set-server actions/get-server<br />
</nowiki><br />
<br />
The last step is to map the action to the command(s) to be run. To do this, open up reactive/pingpong.py and add this code.<br />
<nowiki><br />
@when('actions.set-server')<br />
def set_server():<br />
err = ''<br />
try:<br />
cmd = ""<br />
result, err = charms.sshproxy._run(cmd)<br />
except:<br />
action_fail('command failed:' + err)<br />
else:<br />
action_set({'outout': result})<br />
finally:<br />
remove_flag('actions.set-server')<br />
</nowiki><br />
<br />
The reactive framework, coupled with the script in the ''actions/'' directory, maps the SO's invocation of the action to the block of code with the matching ''@when'' decorator. As demonstrated in the above code, it will execute a command via the ssh (configured automatically by the SO). You could replace with with calls to a REST API or any other RPC method. You can also run code against the LXD container running the charm.<br />
<br />
====Building====<br />
<br />
When you're ready, you can create your charm via the ''charm build'' command:<br />
<br />
<nowiki><br />
$ charm build<br />
build: Composing into /home/stone/charms<br />
build: Destination charm directory: /home/stone/charms/builds/pingpong<br />
build: Please add a `repo` key to your layer.yaml, with a url from which your layer can be cloned.<br />
build: Processing layer: layer:basic<br />
build: Processing layer: layer:sshproxy<br />
build: Processing layer: layer:vnfproxy<br />
build: Processing layer: pingpong<br />
</nowiki><br />
<br />
This combines all layers that you included, and those that they include, into a charm called ''pingpong'', located in the ''~/charms/builds'' directory.<br />
<br />
====VNF Descriptor====<br />
<br />
In your Virtual Network Function Descriptor (VNFD), you specify the name of the charm as demonstrated below:<br />
<nowiki><br />
vnfd:vnfd-catalog:<br />
vnfd:vnfd:<br />
- vnfd:id: rift_pong_vnf<br />
vnfd:name: pong_vnf<br />
vnfd:vnf-configuration:<br />
vnfd:juju:<br />
vnfd:charm: pingpong<br />
</nowiki><br />
<br />
Then the compiled charm (from the builds directory) has to be packaged with the descriptor package under the charm directory. So the ping VNF with the charm would be:<br />
<br />
<nowiki><br />
ping_vnf<br />
├── charms<br />
│ └── pingpong<br />
├── checksums.txt<br />
├── icons<br />
├── images<br />
├── ping_vnfd.yaml<br />
├── README<br />
└── scripts<br />
</nowiki></div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=Creating_your_own_VNF_package&diff=6076Creating your own VNF package2021-02-17T16:52:12Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
This page illustrates how to create your own VNF package. As a previous step, it is highly convenient that you collect the internal structure of your VNF: its VDUs, the VDU information (flavor, interfaces, image, etc.), the VNF internal networks, and the external connection points. The presentation in this [https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/presentations/20180117%20OSM%20Hackfest%20-%20Guidelines%20for%20VNF%20builders.pptx link] might help you collecting all the information.<br />
<br />
==VNF without primitives==<br />
<br />
===Using the CLI tool===<br />
*Clone the devops repo:<br />
git clone https://osm.etsi.org/gerrit/osm/devops<br />
*Run the following command to create a folder with all the files required for a single-VM VNF package:<br />
./devops/descriptor-packages/tools/generate_descriptor_pkg.sh -t vnfd --image <IMAGE_PATH> -c <VNF_NAME><br />
*A folder called <VNF_NAME>_vnfd will be created with all the files required for a VNF package.<br />
*Edit the descriptor file <VNF_NAME>_vnfd.yaml.<br />
**By default, the descriptor is prepared for a single-VM VNF.<br />
**Add as many VMs as required.<br />
**Add also Internal VLDs as required.<br />
*Add any artifacts needed by the VNF (eg, charm, icons, images etc ...) to the appropriate folder and make sure it is referenced in the descriptor.<br />
*Once done, you can generate the tar.gz VNF package with the command:<br />
./devops/descriptor-packages/tools/generate_descriptor_pkg.sh -t vnfd -N <VNF_NAME>_vnfd<br />
#Note: the argument -N is optional and is intended to keep the package files after creating the package<br />
<br />
==VNF with primitives==<br />
You will have to create a proxy charm for the VNF. You can follow the general instructions below:<br />
*Clone the devops repo:<br />
git clone https://osm.etsi.org/gerrit/osm/devops<br />
* Enter the juju-charms folder under devops and follow the instructions to create your own charm: [[Creating your own VNF charm (Release THREE)|Creating your own VNF charm]]<br />
You can then follow the ping-pong example in OSM descriptor packages to integrate the charm into VNF primitives<br />
<br />
==Migrating old descriptors to current release==<br />
Only file containing the VNFD or NSD descriptor need to be migrated. Clone the devops repo, run the utility for that and generate the package:<br />
git clone https://osm.etsi.org/gerrit/osm/devops<br />
./devops/descriptor-packages/tools/upgrade_descriptor_version.py -i <old-descriptor-file> -o <new-descriptor-file><br />
# generate package following the instructions of previous sections<br />
<br />
This command fails if package python-osm-im is not installed. Follow these guidelines to install it: [[#Installing_Python_OSM_IM_package | Installing_Python_OSM_IM_package]]<br />
<br />
==Validate descriptors==<br />
This utility is under the 'devops' repository. Clone it using the above steps. <br />
Can be invoked with:<br />
./devops/descriptor-packages/tools/validate_descriptor.py <DESCRIPTOR_FILE><br />
<br />
It is also integrated in the devops/descriptor-packages makefile system<br />
make test<br />
<br />
This command fails if package python-osm-im is not installed. Follow these guidelines to install it: [[#Installing_Python_OSM_IM_package | Installing_Python_OSM_IM_package]]<br />
<br />
==Installing Python OSM IM package==<br />
Follow these steps to install it if needed:<br />
# Check that the current OSM debian repository is the current stable repo for the release:<br />
grep -h ^deb /etc/apt/sources.list /etc/apt/sources.list.d/* |grep osm-download<br />
# should be similar to this, and should include IM component:<br />
# deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX stable IM osmclient devops<br />
<br />
# If missing, add repository with:<br />
curl "https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX/OSM%20ETSI%20Release%20Key.gpg" | apt-key add -<br />
apt-get update && add-apt-repository -y "deb [arch=amd64] https://osm-download.etsi.org/repository/osm/debian/ReleaseSIX stable IM osmclient devops"<br />
<br />
# Install/update python-osm-im and its dependencies<br />
apt-get update<br />
apt-get install python-osm-im<br />
sudo -H pip install pyangbind</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Release_SIX_Documentation&diff=6075OSM Release SIX Documentation2021-02-17T16:51:16Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
[[File:8th_OSM_Hack.png|320px|right|top|link=https://osm.etsi.org/wikipub/index.php/8th_OSM_Hackfest]] <br />
<br />
== Release SIX Quickstart ==<br />
* In order to get started quickly and get familiar with the most common operations, you can refer to the [[OSM_Release_SIX | Release SIX Quickstart page]].<br />
<br />
== VNF and NS examples ==<br />
* [[Examples from OSM Hackfests]]<br />
<br />
== Onboarding your own VNF and NS ==<br />
* '''[http://osm-download.etsi.org/ftp/Documentation/vnf-onboarding-guidelines VNF Onboarding Guidelines]'''<br />
* [[Creating_your_own_VNF_package | Create your own VNF package]] <br />
* [[Creating_your_own_VNF_charm_(Release_THREE) | Creating your own VNF charm]]<br />
** Some [[Example_VNF_Charms | examples of VNF Charms]] <br />
** [[VNF_Primitives | Default VNF Primitives]] <br />
* [[OSM_Information_Model | OSM Information Model]]<br />
* [[Reference_VNF_and_NS_Descriptors | Information to create VNF and NS Descriptors]]<br />
* [[OSM_Release_FOUR#Using_old_descriptors_from_Release_TWO | How to onboard old Release TWO descriptors]]<br />
<br />
== Specific installation methods ==<br />
* [[How_to_run_OSM_on_Vagrant | How to run OSM on Vagrant]]<br />
* [[How to upgrade the OSM Platform]]<br />
* [[OSM_client#Installation | How to install OSM client separately]]<br />
* [[Advanced OSM installation procedures]]<br />
* [[How to install OSM in Amazon EC2 | How to install OSM in Amazon EC2]]<br />
<br />
== EPA and SDN Assist ==<br />
* [[EPA_and_SDN_assist | How-to guide]]<br />
* [[Openstack_configuration_(Release_FOUR)#Configure_Openstack_for_full_EPA_support_in_OSM | OpenStack configuration for EPA and SDN Assist]]<br />
<br />
== Reference material and self training ==<br />
* [[OSM client]]:<br />
** [[OSM_client#Installation | Installation]]<br />
** [[OSM_client#Usage_(client_commands) | OSM client commands]]<br />
** [[OSM_client#Enable_autocompletion | Enable autocompletion in OSM Client]]<br />
* [[OSM instantiation parameters]]<br />
* Using Monitoring and Autoscaling capabilities:<br />
** [[OSM_Performance_Management | OSM Performance Management]]<br />
** [[OSM_Fault_Management | OSM Fault Management]]<br />
** [[OSM_Autoscaling | OSM Autoscaling]]<br />
* 6th OSM Hackfest - full training material:<br />
** [[5th_OSM_Hackfest#Agenda | Table of contents]]<br />
** [https://osm-download.etsi.org/ftp/osm-5.0-five/6th-hackfest/presentations/ Documentation]<br />
** [https://osm-download.etsi.org/ftp/osm-5.0-five/6th-hackfest/packages/ NS and VNF Packages] and [https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/ VM images]<br />
* [[NBI_API_Description| Description of the OSM North Bound Interface REST API]]<br />
* [[VIM_emulator | How to use the VIM emulator]]<br />
* [[OSM_E2E_tests | Tests to validate VIM capabilities]]<br />
* [[OSM_workshops_and_events | OSM Workshops videos]]<br />
* [[OSM_Technical_Videos | Other technical videos and demos]]<br />
* [[OSM URN Namespace]]<br />
<br />
== Troubleshooting ==<br />
* [[How to know the version of your current OSM installation]]<br />
* [[Common issues and troubleshooting]]<br />
* Have you detected any bug? Check [[How_to_report_issues | this guide]] to see how to report issues.<br />
<br />
== OSM Scope, Features and Integration Guidelines ==<br />
<br />
* [[OSM Scope, Functionality, Operation and Integration Guidelines]]<br />
* [[Release notes and whitepapers]]<br />
<br />
== How to contribute ==<br />
* [https://osm.etsi.org/about/how-to-join Joining the OSM community]<br />
* Developer guides:<br />
** [[Workflow_with_OSM_tools | Workflow with OSM tools (git, gerrit, bugzilla, etc.) (MUST READ for developers)]]<br />
** [[Developer HowTo | Developer how-to (MUST READ for developers)]]<br />
** [[Developer_HowTo_for_RO_Module | Developer how-to for RO]]<br />
**[[How_to_upgrade_the_OSM_Platform#Upgrading_a_specific_component_to_use_your_own_cloned_repo_.28e.g._for_developing_purposes.29 | How to work with your own cloned repo for a specific component]]<br />
* [https://opensourcemano.slack.com/ OSM Slack Workplace]<br />
* Upcoming Hackfests and events:<br />
** [[OSM workshops and events]] <br />
<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Release_SIX&diff=6074OSM Release SIX2021-02-17T16:51:05Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
[[File:8th_OSM_Hack.png|350px|right|top|link=https://osm.etsi.org/wikipub/index.php/8th_OSM_Hackfest]] <br />
<br />
Open Source MANO (OSM) is an ETSI-hosted open source community delivering a production-quality MANO stack for NFV, capable of consuming openly published information models, available to everyone, suitable for all VNFs, operationally significant and VIM-independent. OSM is aligned to NFV ISG information models while providing first-hand feedback based on its implementation experience.<br />
<br />
Release SIX brings a number of improvements over previous releases. For the full list of new features, please refer to the Rel SIX White Paper or the [[OSM Release SIX Documentation]]. For a comprehensive overview of OSM functionalities, you can also refer to the [https://osm.etsi.org/images/OSM_EUAG_White_Paper_OSM_Scope_and_Functionality.pdf OSM Scope and Functionality White Paper] or to the release notes of previous OSM releases ([https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseONE-FINAL.pdf ONE], [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTWO-FINAL.pdf TWO], [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTHREE-FINAL.pdf THREE],<br />
[https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFOUR-FINAL.pdf FOUR], [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFIVE-FINAL.pdf FIVE]).<br />
<br />
'''OSM in Practice'''<br />
{{#evu:https://www.youtube.com/watch?v=kCFxPV67Adw<br />
|alignment=left<br />
}}<br />
<br />
<br />
__TOC__<br />
<br />
=Assumptions about interaction with VIMs and VNFs=<br />
The following figure illustrates OSM interaction with VIMs and VNFs:<br />
* OSM talks to the VIM for the deployment of VNFs and VLs connecting them<br />
* OSM talks to the VNFs deployed in a VIM to run day-0, day-1 and day-2 configuration primitives.<br />
<br />
[[File:Osmtopology.png|600px|OSM Release SIX]]<br />
<br />
In order for OSM to work, it is assumed that:<br />
* Each VIM has an API endpoint reachable from OSM<br />
* Each VIM has a so called management network which provides IP address to VNFs<br />
* That management network is reachable from OSM<br />
<br />
=Install OSM Release SIX=<br />
<br />
This release expands the cloud-native, ''dockerized'' OSM installation with the kafka bus for asynchronous communications, a lighter orchestrator with Network Services and Slicing capabilities, performance/fault/policy management features, a SOL005-aligned NBI, an enhanced GUI with a service composer, and OSM client leveraging the unified and improved REST API that the NBI exposes.<br />
<br />
== Default installation procedure ==<br />
<br />
All you need to run OSM Release SIX is a single server or VM with the following requirements:<br />
* MINIMUM: 2 CPUs, 4 GB RAM, 20GB disk and a single interface with Internet access<br />
* RECOMMENDED: 2 CPUs, 8 GB RAM, 40GB disk and a single interface with Internet access<br />
* Base image:<br />
** Ubuntu18.04 (64-bit variant required) (http://releases.ubuntu.com/18.04/), or<br />
** Ubuntu16.04 (64-bit variant required) (http://releases.ubuntu.com/16.04/)<br />
<br />
Once you have prepared the host with the previous requirements, all you need to do is:<br />
wget https://osm-download.etsi.org/ftp/osm-6.0-six/install_osm.sh<br />
chmod +x install_osm.sh<br />
./install_osm.sh<br />
<br />
'''TIP:''' In order to facilitate potential trobleshooting later, it is recommended to save the full log of your installation process:<br />
wget https://osm-download.etsi.org/ftp/osm-6.0-six/install_osm.sh<br />
chmod +x install_osm.sh<br />
./install_osm.sh 2>&1 | tee osm_install_log.txt<br />
<br />
You will be asked if you want to proceed with the installation and configuration of LXD, juju, docker CE and the initialization of a local docker swarm, as pre-requirements. Please answer "y".<br />
<br />
Then, some dialog messages related to LXD configuration will be shown. This is what you have to answer:<br />
* Do you want to configure the LXD bridge? '''Yes'''<br />
* Do you want to setup an IPv4 subnet? '''Yes'''<br />
* ''<< '''Default values''' apply for next questions >>''<br />
* Do you want to setup an IPv6 subnet? '''No'''<br />
<br />
If you want to run docker commands, you will also need to either reload the shell or run the following command to add your user to the 'docker' group:<br />
newgrp docker<br />
<br />
===Installation including optional components===<br />
<br />
You can include optional components in your installation by adding the following flags:<br />
* '''VIM Emulator:''' --vimemu (more information [[VIM emulator|here]])<br />
* '''Performance Management additional stack (Grafana only):''' --pm_stack (more information [[OSM Performance Management|here]])<br />
* '''Fault Management features with ELK:''' --elk_stack (more information [[OSM Fault Management|here]])<br />
<br />
Example:<br />
./install_osm.sh --elk_stack --pm_stack --vimemu<br />
<br />
===Other installation options===<br />
* You can also run OSM using a pre-built [https://app.vagrantup.com/osm/boxes/releasesix vagrant] image: [[How_to_run_OSM_on_Vagrant]]<br />
* For other special installation options, please refer to the [[OSM_Release_SIX_Documentation#Alternative_installation_methods | release documentation]].<br />
<br />
==Checking your installation==<br />
<br />
After some time, you will get a fresh OSM Release SIX installation with its latest, pre-built docker images which are built daily. You can access to the UI in the following URL (user:admin, password: admin): http://1.2.3.4, replacing 1.2.3.4 with the IP address of your host. <br />
<br />
[[File:Osm_lwb_ui_login.png|600px|OSM home]]<br />
<br />
[[File:Osm_lwb_ui.png|600px|OSM Release SIX installation result]]<br />
<br />
As a result of the installation, thirteen docker containers are created in the host (without considering optional stacks). You can check they are running by issuing the following commands:<br />
docker stack ps osm |grep -i running<br />
docker service ls<br />
<br />
[[File:Osm_containers_rel5.png|600px|OSM Docker containers]]<br />
<br />
At any time, you can quickly relaunch your deployment by using the pre-built docker images, like this:<br />
docker stack rm osm && sleep 60 # The sleep is for making sure the stack removal finishes before redeploying<br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
To check the logs of any container:<br />
docker service logs osm_lcm # shows the logs of all containers (included dead containers) associated with LCM component.<br />
docker logs $(docker ps -aqf "name=osm_lcm" -n 1) # shows the logs of the last existant LCM container<br />
<br />
OSM client, a python-based CLI for OSM, will be available as well in the host machine.<br />
Via the OSM client, you can manage descriptors, NS and VIM complete lifecycle.<br />
<br />
=Adding VIM accounts=<br />
Before proceeding, make sure that you have a site with a VIM configured to run with OSM. Different kinds of VIMs are currently supported by OSM:<br />
*'''OpenVIM.''' Check the following link to know how to install and use openvim for OSM: [[OpenVIM installation | OpenVIM installation]]. Openvim must run in 'normal' mode (not test or fake) to have real virtual machines reachable from OSM.<br />
*'''OpenStack.''' Check the following link to learn how to configure OpenStack to be used by OSM: [[Openstack_configuration | Openstack configuration]]<br />
*'''VMware vCloud Director.''' Check the following link to learn how to configure VMware VCD to be used by OSM: [[Configuring_VMware_vCloud_Director | Configuring VMware vCloud Director]]<br />
*'''Amazon Web Services (AWS).''' Check the following link to learn how to configure AWS (EC2 and Virtual Private Cloud) to be used by OSM: [[Configuring_AWS | Configuring AWS for OSM]]<br />
*'''Eclipse fog05 ''' Check the following link to learn how to configure Eclipse fog05 to be used by OSM: [[Eclipse_fog05 | Configuring Eclipse fog05 for OSM]]<br />
<br />
OSM can manage external SDN controllers to perform the dataplane underlay network connectivity on behalf of the VIM. See [[EPA and SDN assist]]<br />
<br />
==Adding VIMs through OSM client==<br />
===OpenVIM site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openvim-site", IP address: 10.10.10.10, VIM tenant: "osm")<br />
osm vim-create --name openvim-site --auth_url http://10.10.10.10:9080/openvim --account_type openvim \<br />
--description "Openvim site" --tenant osm --user dummy --password dummy<br />
<br />
===Openstack site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openstack-site", IP address: 10.10.10.11, VIM tenant: "admin", user: "admin", password: "userpwd")<br />
osm vim-create --name openstack-site --user admin --password userpwd \<br />
--auth_url http://10.10.10.11:5000/v2.0 --tenant admin --account_type openstack<br />
<br />
For advanced options, please refer to the [[Openstack_configuration#Add_openstack_to_OSM | OpenStack Setup Guide]].<br />
<br />
===VMware vCloud Director site===<br />
*Execute the following command, using the appropriate parameters (e.g. site name: "vmware-site", IP address: 10.10.10.12, VIM tenant: "vmware-tenant", user: "osm", password: "osm4u", admin user: "admin", admin password: "adminpwd", organization: "orgVDC")<br />
osm vim-create --name vmware-site --user osm --password osm4u --auth_url https://10.10.10.12 \<br />
--tenant vmware-tenant --account_type vmware \<br />
--config '{admin_username: user, admin_password: passwd, orgname: organization, nsx_manager: "http://10.10.10.12",<br />
nsx_user: user, nsx_password: userpwd,"vcenter_port": port, "vcenter_user":user, "vcenter_password":password,<br />
"vcenter_ip": 10.10.10.14}'<br />
<br />
For advanced options, please refer to the [[Configuring_VMware_vCloud_Director#Add_vCloud_using_OSM_Client | vCloud Director Setup Guide]].<br />
<br />
===VMware Integrated Openstack (VIO) site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openstack-site-vio4", IP address: 10.10.10.12, VIM tenant: "admin", user: "admin", password: "passwd")<br />
osm vim-create --name VIO --user admin --password passwd --auth_url https://10.10.10.12:5000/v3 --tenant admin \<br />
--account_type openstack --config '{use_floating_ip: True, insecure: true, vim_type: VIO, APIversion: v3.3,<br />
dataplane_physical_net: dvs-46, "use_internal_endpoint":true,"dataplane_net_vlan_range":["31-35","37-39"]}'<br />
<br />
With respect to Openstack, the additional configuration for VIO is the following:<br />
* '''vim_type''': Set to "VIO" to use VMware Integrated openstack as VIM <br />
* '''use_internal_endpoint''': When true it allows use of private API endpoints<br />
* '''dataplane_physical_net''': The configured network_vlan_ranges at neutron for the SRIOV (binding direct) and passthrough (binding direct-physical) networks, e.g. 'physnet_sriov' in the above configuration. In case of VMware Integrated Openstack (VIO) provide moref ID of distributed virtual switch, e.g 'dvs-46' in above configuration.<br />
* '''dataplane_net_vlan_range''': In case of VMware Integrated Openstack (VIO) provide vlan ranges for the SRIOV (binding direct) networks in format ['start_ID - end_ID']<br />
<br />
For common options, you may refer to the general [[Openstack_configuration#Add_openstack_to_OSM | OpenStack Setup Guide]].<br />
<br />
===Amazon Web Services (AWS) site===<br />
*Execute the following command, using the appropriate parameters (e.g. site name: "aws-site", VIM tenant: "admin", user: "XXX", password: "YYY")<br />
osm vim-create --name aws-site --user XXX --password YYY --auth_url https://aws.amazon.com --tenant admin \<br />
--account_type aws --config '{region_name: eu-central-1, flavor_info: {t2.nano: {cpus: 1, disk: 100, ram: 512},<br />
t2.micro: {cpus: 1, disk: 100, ram: 1024}, t2.small: {cpus: 1, disk: 100, ram: 2048},<br />
m1.small: {cpus: 1, disk: 160, ram: 1741}}}'<br />
For advanced options, please refer to the [[Configuring_AWS#Add_AWS_to_OSM | AWS Setup Guide]].<br />
<br />
=== Eclipse fog05 site===<br />
*Execute the following command, using the appropriate parameters (e.g. runtime supported: "hypervisor", cpu architecture: "arch", user: "XXX", password: "YYY")<br />
osm vim-create --name fos --auth_url <rest proxy ip>:8080 --account_type fos --tenant osm --user dummy --password dummy --config '{hypervisor: LXD}'<br />
<br />
For advanced options, please refer to the [[Eclipse_fog05#Add_Eclipse_fog05_to_OSM | Eclipse fog05 setup guide]].<br />
<br />
==Adding VIMs through GUI==<br />
Just access the ''VIM Accounts'' tab, click the ''New VIM'' button and fill the parameters accordingly.<br />
<br />
[[File:Osmvim.png|600px|AddingVIMUI]]<br />
<br />
=Deploying your first Network Service=<br />
In this example we will deploy the following Network Service, consisting of two simple VNFs based on CirrOS connected by a simple VLD.<br />
<br />
[[File:cirros_2vnf_ns.png|500px|NS with 2 CirrOS VNF]]<br />
<br />
Before going on, download the required VNF and NS packages from this URL: https://osm-download.etsi.org/ftp/osm-3.0-three/examples/cirros_2vnf_ns/<br />
<br />
==Onboarding a VNF==<br />
<br />
The onboarding of a VNF in OSM involves adding the corresponding VNF package to the system. This process also assumes, as a pre-condition, that the corresponding VM images are available in the VIM(s) where it will be instantiated.<br />
<br />
===Uploading VM image(s) to the VIM(s)===<br />
In this example, only a vanilla CirrOS 0.3.4 image is need. It can be obtained from the following link: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img<br />
<br />
If not available, it would be required to upload the image into the VIM. Instructions differ from one VIM to another:<br />
*In Openstack:<br />
openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 cirros034<br />
*In OpenVIM:<br />
#copy your image to the NFS shared folder (e.g. /mnt/openvim-nfs)<br />
cp ./cirros-0.3.4-x86_64-disk.img /mnt/openvim-nfs/<br />
openvim image-create --name cirros034 --path /mnt/openvim-nfs/cirros-0.3.4-x86_64-disk.img<br />
<br />
===VNF package onboarding===<br />
<br />
*From the UI:<br />
**Go to Projects --> Admin --> VNF Packages (''Open List'')<br />
**Click on the Onboard VNFD button<br />
**Drag and drop the VNF package file cirros_vnf.tar.gz in the importing area.<br />
[[File:vnfd_onboard_r4.png|600px|Onboarding a VNF]]<br />
*From OSM client:<br />
osm vnfd-create cirros_vnf.tar.gz<br />
osm vnfd-list<br />
<br />
==Onboarding a NS==<br />
*From the UI:<br />
**Go to Projects --> Admin --> NS Packages (''Open List'')<br />
**Click on the Onboard NSD button<br />
**Drag and drop the NS package file cirros_2vnf_ns.tar.gz in the importing area.<br />
[[File:nsd_onboard_r4.png|600px|Onboarding a NS]]<br />
*From OSM client:<br />
osm nsd-create cirros_2vnf_ns.tar.gz<br />
osm nsd-list<br />
<br />
==Instantiating the NS==<br />
*From the UI:<br />
**Go to Projects --> Admin --> NS Packages (''Open List'')<br />
**Next the NS descriptor to be instantiated, click on Launch<br />
[[File:nsd_list.png|600px|Instantiating a NS (step 1)]] <br />
**Fill the form, adding at least a name and selecting the VIM<br />
[[File:new_ns.png|600px|Instantiating a NS (step 2)]] <br />
* From OSM client:<br />
osm ns-create --nsd_name cirros_2vnf_ns --ns_name <ns-instance-name> --vim_account <data-center-name><br />
osm ns-list<br />
<br />
'''Instantiation parameters can be specified using both CLI and UI. There are some examples collected in this wiki page: [[OSM instantiation parameters]].'''<br />
<br />
==Using old descriptors from Release TWO==<br />
<br />
Beware that old Release TWO descriptors cannot be directly used by OSM Release SIX.<br />
<br />
You should use this '''[[Creating your own VNF package#Migrating old descriptors to release SIX|conversion tool]]''' to convert them to Release SIX format and '''[[Creating your own VNF package|create the corresponding package]]'''.<br />
<br />
=What's next?=<br />
<br />
If you want to learn more, you can refer to the rest of '''[[OSM_Release_SIX_Documentation | OSM documentation]]'''.<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Autoscaling&diff=6073OSM Autoscaling2021-02-17T16:50:54Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
This is a new feature available since Release FIVE, which allows to automatically scale VNFs with a VDU granularity and based on any available metric.<br />
<br />
=== Reference diagram ===<br />
<br />
The following diagram summarizes the feature:<br />
<br />
[[File:osm_pol_as.png|800px|Diagram explaining auto-scaling support]]<br />
<br />
* Scaling descriptors can be included and be tied to automatic reaction to VIM/VNF metric thresholds.<br />
* Supported metrics are both VIM and VNF metrics. More information about metrics collection can be found at the [[OSM_Performance_Management|Performance Management documentation]]<br />
* An internal alarm manager has been added to MON through the 'mon-evaluator' module, so that both VIM and VNF metrics can also trigger threshold-violation alarms and scaling actions. More information about this module can be found at the [[OSM_Fault_Management|Fault Management documentation]]<br />
<br />
=== Scaling Descriptor ===<br />
<br />
The scaling descriptor is part of a VNFD. Like the example below shows, it mainly specifies:<br />
* An existing metric to be monitored, which should be pre-defined in the monitoring-param list (vnf-monitoring-param-ref).<br />
* The VDU to be scaled (vdu-id-ref) and the amount of instances to scale per event (count)<br />
* The thresholds to monitor (scale-in/out-threshold)<br />
* The minimum and maximum amount of '''scaled instances''' to produce.<br />
* The minimum time it should pass between scaling operations (cooldown-time)<br />
<br />
scaling-group-descriptor:<br />
- name: "cpu_autoscaling_descriptor"<br />
min-instance-count: 0<br />
max-instance-count: 10<br />
scaling-policy:<br />
- name: "cpu_scaling_policy"<br />
scaling-type: "automatic"<br />
cooldown-time: 120<br />
scaling-criteria:<br />
- name: "cpu_autoscaling_criteria"<br />
scale-in-threshold: 20<br />
scale-in-relational-operation: "LT"<br />
scale-out-threshold: 80<br />
scale-out-relational-operation: "GT"<br />
vnf-monitoring-param-ref: "vnf01_cpu_util"<br />
vdu:<br />
- count: 1<br />
vdu-id-ref: vdu01<br />
<br />
=== Example ===<br />
This will launch a Network Service formed by an HAProxy load balancer and an (autoscalable) Apache web server<br />
Make sure:<br />
# Your VIM has an accesible 'public' network and a management network (in this case called "PUBLIC" and "vnf-mgmt")<br />
# Your VIM has the 'haproxy_ubuntu' and 'apache_ubuntu' images located [https://osm-download.etsi.org/ftp/osm-4.0-four/4th-hackfest/images/ here]<br />
# You run the following command to match your VIM metrics telemetry system's granularity, if different than 300s (recommended for this example is 60s or Gnocchi's "medium archive-policy"): <br />
docker service update --env-add OS_DEFAULT_GRANULARITY=60 osm_mon<br />
Get the descriptors:<br />
wget https://osm-download.etsi.org/ftp/osm-4.0-four/4th-hackfest/packages/webserver_vimmetric_autoscale_nsd.tar.gz<br />
wget https://osm-download.etsi.org/ftp/osm-4.0-four/4th-hackfest/packages/webserver_vimmetric_autoscale_vnfd.tar.gz<br />
Onboard them<br />
osm vnfd-create webserver_vimmetric_autoscale_vnfd.tar.gz<br />
osm nsd-create webserver_vimmetric_autoscale_nsd.tar.gz<br />
Launch the NS<br />
osm ns-create --ns_name web01 --nsd_name webserver_vimmetric_autoscale_ns --vim_account <VIM_ACCOUNT_NAME>|<VIM_ACCOUNT_ID><br />
osm ns-list<br />
osm ns-show web01<br />
Testing<br />
# To ensure the NS is working, visit the Load balancer's IP at the public network using a browser, the page should show an OSM logo and active VDUs<br />
# To check metrics at Prometheus, visit http://[OSM_IP]:9091 and look for osm_cpu_utilization and osm_average_memory_utilization (initial values could take some some minutes depending on your Telemetry system's granularity)<br />
# To check metrics at Grafana, just install the OSM preconfigured version (./install_osm.sh -o pm_stack) and visit http://[OSM_IP]:3000 (admin / admin), you will find a sample dashboard (the two top charts correspond to this example)<br />
# To increase CPU in this example to autoscale the web server, install Apache Bench in a client within reach (could be the OSM Host) and run it towards test.php<br />
<br />
sudo apt install apache2-utils<br />
ab -n 5000000 -c 2 http://[load-balancer-ip]/test.php<br />
# This will stress CPU to 100% and trigger a scale-out operation in POL.<br />
# In this test, scaling will usually go up to 3 web servers before HAProxy spreads to load to reach a normal CPU level (w/ 60s granularity, 180s cooldown)<br />
<br />
Any of the VMs can be accessed through SSH to further monitor (with htop, for example), and there is an HAProxy UI at port http://[HAProxy_IP]:32700 (all credentials are osm / osm2018)<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Release_FIVE&diff=6072OSM Release FIVE2021-02-17T16:50:39Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
[[File:7th_OSM_Hack.png|350px|right|top|link=https://osm.etsi.org/wikipub/index.php/7th_OSM_Hackfest]] <br />
<br />
Open Source MANO (OSM) is an ETSI-hosted open source community delivering a production-quality MANO stack for NFV, capable of consuming openly published information models, available to everyone, suitable for all VNFs, operationally significant and VIM-independent. OSM is aligned to NFV ISG information models while providing first-hand feedback based on its implementation experience.<br />
<br />
Release FIVE brings a number of improvements over previous releases. For the full list of new features, please refer to the Rel FIVE White Paper or the [[OSM Release FIVE Documentation]]. For a comprehensive overview of OSM functionalities, you can also refer to the release notes of former releases ([https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseONE-FINAL.pdf ONE], [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTWO-FINAL.pdf TWO], [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseTHREE-FINAL.pdf THREE],<br />
[https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFOUR-FINAL.pdf FOUR]).<br />
<br />
'''OSM in Practice'''<br />
{{#evu:https://www.youtube.com/watch?v=kCFxPV67Adw<br />
|alignment=left<br />
}}<br />
<br />
<br />
__TOC__<br />
<br />
=Assumptions about interaction with VIMs and VNFs=<br />
The following figure illustrates OSM interaction with VIMs and VNFs:<br />
* OSM talks to the VIM for the deployment of VNFs and VLs connecting them<br />
* OSM talks to the VNFs deployed in a VIM to run day-0, day-1 and day-2 configuration primitives.<br />
<br />
[[File:Osmtopology.png|600px|OSM Release 4]]<br />
<br />
In order for OSM to work, it is assumed that:<br />
* Each VIM has an API endpoint reachable from OSM<br />
* Each VIM has a so called management network which provides IP address to VNFs<br />
* That management network is reachable from OSM<br />
<br />
=Install OSM Release FIVE=<br />
<br />
This release expands the cloud-native, ''dockerized'' OSM installation with the kafka bus for asynchronous communications, a lighter orchestrator with Network Services and Slicing capabilities, performance/fault/policy management features, a SOL005-aligned NBI, an enhanced GUI with a service composer, and OSM client leveraging the unified and improved REST API that the NBI exposes.<br />
<br />
== Default installation procedure ==<br />
<br />
All you need to run OSM Release FIVE is a single server or VM with the following requirements:<br />
* MINIMUM: 2 CPUs, 4 GB RAM, 20GB disk and a single interface with Internet access<br />
* RECOMMENDED: 2 CPUs, 8 GB RAM, 40GB disk and a single interface with Internet access<br />
* Ubuntu16.04 (64-bit variant required) as base image (http://releases.ubuntu.com/16.04/)<br />
<br />
Once you have prepared the host with the previous requirements, all you need to do is:<br />
wget https://osm-download.etsi.org/ftp/osm-5.0-five/install_osm.sh<br />
chmod +x install_osm.sh<br />
./install_osm.sh -t v5.0.5<br />
<br />
'''TIP:''' In order to facilitate potential trobleshooting later, it is recommended to save the full log of your installation process:<br />
wget https://osm-download.etsi.org/ftp/osm-5.0-five/install_osm.sh<br />
chmod +x install_osm.sh<br />
./install_osm.sh -t v5.0.5 2>&1 | tee osm_install_log.txt<br />
<br />
You will be asked if you want to proceed with the installation and configuration of LXD, juju, docker CE and the initialization of a local docker swarm, as pre-requirements. Please answer "y".<br />
<br />
Then, some dialog messages related to LXD configuration will be shown. This is what you have to answer:<br />
* Do you want to configure the LXD bridge? '''Yes'''<br />
* Do you want to setup an IPv4 subnet? '''Yes'''<br />
* ''<< '''Default values''' apply for next questions >>''<br />
* Do you want to setup an IPv6 subnet? '''No'''<br />
<br />
If you want to run docker commands, you will also need to either reload the shell or run the following command to add your user to the 'docker' group:<br />
newgrp docker<br />
<br />
===Installation including optional components===<br />
<br />
You can include optional components in your installation by adding the following flags:<br />
* '''VIM Emulator:''' --vimemu (more information [[VIM emulator|here]])<br />
* '''Performance Management additional stack (Grafana only):''' --pm_stack (more information [[OSM Performance Management|here]])<br />
* '''Fault Management features with ELK:''' --elk_stack (more information [[OSM Fault Management|here]])<br />
<br />
Example:<br />
./install_osm.sh --elk_stack --pm_stack --vimemu<br />
<br />
===Other installation options===<br />
* You can also run OSM using a pre-built [https://app.vagrantup.com/osm/boxes/releasefive vagrant] image: [[How_to_run_OSM_on_Vagrant]]<br />
* For other special installation options, please refer to the [[OSM_Release_FIVE_Documentation#Alternative_installation_methods | release documentation]].<br />
<br />
==Checking your installation==<br />
<br />
After some time, you will get a fresh OSM Release FIVE installation with its latest, pre-built docker images which are built daily. You can access to the UI in the following URL (user:admin, password: admin): http://1.2.3.4, replacing 1.2.3.4 with the IP address of your host. <br />
<br />
[[File:Osm_lwb_ui_login.png|600px|OSM home]]<br />
<br />
[[File:Osm_lwb_ui.png|600px|OSM Release FIVE installation result]]<br />
<br />
As a result of the installation, thirteen docker containers are created in the host (without considering optional stacks). You can check they are running by issuing the following commands:<br />
docker stack ps osm |grep -i running<br />
docker service ls<br />
<br />
[[File:Osm_containers_rel5.png|600px|OSM Docker containers]]<br />
<br />
At any time, you can quickly relaunch your deployment by using the pre-built docker images, like this:<br />
docker stack rm osm && sleep 60 # The sleep is for making sure the stack removal finishes before redeploying<br />
docker stack deploy -c /etc/osm/docker/docker-compose.yaml osm<br />
<br />
To check the logs of any container:<br />
docker service logs osm_lcm # shows the logs of all containers (included dead containers) associated with LCM component.<br />
docker logs $(docker ps -aqf "name=osm_lcm" -n 1) # shows the logs of the last existant LCM container<br />
<br />
OSM client, a python-based CLI for OSM, will be available as well in the host machine.<br />
Via the OSM client, you can manage descriptors, NS and VIM complete lifecycle.<br />
<br />
=Adding VIM accounts=<br />
Before proceeding, make sure that you have a site with a VIM configured to run with OSM. Different kinds of VIMs are currently supported by OSM:<br />
*'''OpenVIM.''' Check the following link to know how to install and use openvim for OSM: [[OpenVIM installation | OpenVIM installation]]. Openvim must run in 'normal' mode (not test or fake) to have real virtual machines reachable from OSM.<br />
*'''OpenStack.''' Check the following link to learn how to configure OpenStack to be used by OSM: [[Openstack_configuration | Openstack configuration]]<br />
*'''VMware vCloud Director.''' Check the following link to learn how to configure VMware VCD to be used by OSM: [[Configuring_VMware_vCloud_Director | Configuring VMware vCloud Director]]<br />
*'''Amazon Web Services (AWS).''' Check the following link to learn how to configure AWS (EC2 and Virtual Private Cloud) to be used by OSM: [[Configuring_AWS | Configuring AWS for OSM]]<br />
OSM can manage external SDN controllers to perform the dataplane underlay network connectivity on behalf of the VIM. See [[EPA and SDN assist]]<br />
<br />
==Adding VIMs through OSM client==<br />
===OpenVIM site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openvim-site", IP address: 10.10.10.10, VIM tenant: "osm")<br />
osm vim-create --name openvim-site --auth_url http://10.10.10.10:9080/openvim --account_type openvim \<br />
--description "Openvim site" --tenant osm --user dummy --password dummy<br />
<br />
===Openstack site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openstack-site", IP address: 10.10.10.11, VIM tenant: "admin", user: "admin", password: "userpwd")<br />
osm vim-create --name openstack-site --user admin --password userpwd \<br />
--auth_url http://10.10.10.11:5000/v2.0 --tenant admin --account_type openstack<br />
<br />
For advanced options, please refer to the [[Openstack_configuration#Add_openstack_to_OSM | OpenStack Setup Guide]].<br />
<br />
===VMware vCloud Director site===<br />
*Execute the following command, using the appropriate parameters (e.g. site name: "vmware-site", IP address: 10.10.10.12, VIM tenant: "vmware-tenant", user: "osm", password: "osm4u", admin user: "admin", admin password: "adminpwd", organization: "orgVDC")<br />
osm vim-create --name vmware-site --user osm --password osm4u --auth_url https://10.10.10.12 \<br />
--tenant vmware-tenant --account_type vmware \<br />
--config '{admin_username: user, admin_password: passwd, orgname: organization, nsx_manager: "http://10.10.10.12",<br />
nsx_user: user, nsx_password: userpwd,"vcenter_port": port, "vcenter_user":user, "vcenter_password":password,<br />
"vcenter_ip": 10.10.10.14}'<br />
<br />
For advanced options, please refer to the [[Configuring_VMware_vCloud_Director#Add_vCloud_using_OSM_Client | vCloud Director Setup Guide]].<br />
<br />
===VMware Integrated Openstack (VIO) site===<br />
Execute the following command, using the appropriate parameters (e.g. site name: "openstack-site-vio4", IP address: 10.10.10.12, VIM tenant: "admin", user: "admin", password: "passwd")<br />
osm vim-create --name VIO --user admin --password passwd --auth_url https://10.10.10.12:5000/v3 --tenant admin \<br />
--account_type openstack --config '{use_floating_ip: True, insecure: true, vim_type: VIO, APIversion: v3.3,<br />
dataplane_physical_net: dvs-46, "use_internal_endpoint":true,"dataplane_net_vlan_range":["31-35","37-39"]}'<br />
<br />
With respect to Openstack, the additional configuration for VIO is the following:<br />
* '''vim_type''': Set to "VIO" to use VMware Integrated openstack as VIM <br />
* '''use_internal_endpoint''': When true it allows use of private API endpoints<br />
* '''dataplane_physical_net''': The configured network_vlan_ranges at neutron for the SRIOV (binding direct) and passthrough (binding direct-physical) networks, e.g. 'physnet_sriov' in the above configuration. In case of VMware Integrated Openstack (VIO) provide moref ID of distributed virtual switch, e.g 'dvs-46' in above configuration.<br />
* '''dataplane_net_vlan_range''': In case of VMware Integrated Openstack (VIO) provide vlan ranges for the SRIOV (binding direct) networks in format ['start_ID - end_ID']<br />
<br />
For common options, you may refer to the general [[Openstack_configuration#Add_openstack_to_OSM | OpenStack Setup Guide]].<br />
<br />
===Amazon Web Services (AWS) site===<br />
*Execute the following command, using the appropriate parameters (e.g. site name: "aws-site", VIM tenant: "admin", user: "XXX", password: "YYY")<br />
osm vim-create --name aws-site --user XXX --password YYY --auth_url https://aws.amazon.com --tenant admin \<br />
--account_type aws --config '{region_name: eu-central-1, flavor_info: {t2.nano: {cpus: 1, disk: 100, ram: 512},<br />
t2.micro: {cpus: 1, disk: 100, ram: 1024}, t2.small: {cpus: 1, disk: 100, ram: 2048},<br />
m1.small: {cpus: 1, disk: 160, ram: 1741}}}'<br />
<br />
For advanced options, please refer to the [[Configuring_AWS#Add_AWS_to_OSM | AWS Setup Guide]].<br />
<br />
==Adding VIMs through GUI==<br />
Just access the ''VIM Accounts'' tab, click the ''New VIM'' button and fill the parameters accordingly.<br />
<br />
[[File:Osmvim.png|600px|AddingVIMUI]]<br />
<br />
=Deploying your first Network Service=<br />
In this example we will deploy the following Network Service, consisting of two simple VNFs based on CirrOS connected by a simple VLD.<br />
<br />
[[File:cirros_2vnf_ns.png|500px|NS with 2 CirrOS VNF]]<br />
<br />
Before going on, download the required VNF and NS packages from this URL: https://osm-download.etsi.org/ftp/osm-3.0-three/examples/cirros_2vnf_ns/<br />
<br />
==Onboarding a VNF==<br />
<br />
The onboarding of a VNF in OSM involves adding the corresponding VNF package to the system. This process also assumes, as a pre-condition, that the corresponding VM images are available in the VIM(s) where it will be instantiated.<br />
<br />
===Uploading VM image(s) to the VIM(s)===<br />
In this example, only a vanilla CirrOS 0.3.4 image is need. It can be obtained from the following link: http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img<br />
<br />
If not available, it would be required to upload the image into the VIM. Instructions differ from one VIM to another:<br />
*In Openstack:<br />
openstack image create --file="./cirros-0.3.4-x86_64-disk.img" --container-format=bare --disk-format=qcow2 cirros034<br />
*In OpenVIM:<br />
#copy your image to the NFS shared folder (e.g. /mnt/openvim-nfs)<br />
cp ./cirros-0.3.4-x86_64-disk.img /mnt/openvim-nfs/<br />
openvim image-create --name cirros034 --path /mnt/openvim-nfs/cirros-0.3.4-x86_64-disk.img<br />
<br />
===VNF package onboarding===<br />
<br />
*From the UI:<br />
**Go to Projects --> Admin --> VNF Packages (''Open List'')<br />
**Click on the Onboard VNFD button<br />
**Drag and drop the VNF package file cirros_vnf.tar.gz in the importing area.<br />
[[File:vnfd_onboard_r4.png|600px|Onboarding a VNF]]<br />
*From OSM client:<br />
osm vnfd-create cirros_vnf.tar.gz<br />
osm vnfd-list<br />
<br />
==Onboarding a NS==<br />
*From the UI:<br />
**Go to Projects --> Admin --> NS Packages (''Open List'')<br />
**Click on the Onboard NSD button<br />
**Drag and drop the NS package file cirros_2vnf_ns.tar.gz in the importing area.<br />
[[File:nsd_onboard_r4.png|600px|Onboarding a NS]]<br />
*From OSM client:<br />
osm nsd-create cirros_2vnf_ns.tar.gz<br />
osm nsd-list<br />
<br />
==Instantiating the NS==<br />
*From the UI:<br />
**Go to Projects --> Admin --> NS Packages (''Open List'')<br />
**Next the NS descriptor to be instantiated, click on Launch<br />
[[File:nsd_list.png|600px|Instantiating a NS (step 1)]] <br />
**Fill the form, adding at least a name and selecting the VIM<br />
[[File:new_ns.png|600px|Instantiating a NS (step 2)]] <br />
* From OSM client:<br />
osm ns-create --nsd_name cirros_2vnf_ns --ns_name <ns-instance-name> --vim_account <data-center-name><br />
osm ns-list<br />
<br />
'''Instantiation parameters can be specified using both CLI and UI. There are some examples collected in this wiki page: [[OSM instantiation parameters]].'''<br />
<br />
==Using old descriptors from Release TWO==<br />
<br />
Beware that old Release TWO descriptors cannot be directly used by OSM Release FIVE.<br />
<br />
You should use this '''[[Creating your own VNF package#Migrating old descriptors to release FIVE|conversion tool]]''' to convert them to Release FIVE format and '''[[Creating your own VNF package|create the corresponding package]]'''.<br />
<br />
=What's next?=<br />
<br />
If you want to learn more, you can refer to the rest of '''[[OSM_Release_FIVE_Documentation | OSM documentation]]'''.<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Release_FOUR_Documentation&diff=6071OSM Release FOUR Documentation2021-02-17T16:50:05Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
== Release FOUR Quickstart ==<br />
<br />
* In order to get started quickly and get familiar with the most common operations, you can refer to the [[OSM_Release_FOUR | Release FOUR Quickstart page]].<br />
<br />
== VNF and NS examples ==<br />
* [[Examples from OSM Hackfests]]<br />
<br />
== Onboarding your own VNF and NS ==<br />
* [[Creating_your_own_VNF_package | Create your own VNF package]] <br />
* [[Creating_your_own_VNF_charm_(Release_THREE) | Creating your own VNF charm]]<br />
** Some [[Example_VNF_Charms | examples of VNF Charms]] <br />
** [[VNF_Primitives | Default VNF Primitives]] <br />
* [[OSM_Information_Model | OSM Information Model]]<br />
* [[Reference_VNF_and_NS_Descriptors | Information to create VNF and NS Descriptors]]<br />
* [[OSM_Release_FOUR#Using_old_descriptors_from_Release_TWO | How to onboard old Release TWO descriptors]]<br />
<br />
== Specific installation methods ==<br />
* [[How_to_run_OSM_on_Vagrant | How to run OSM on Vagrant]]<br />
* [[How to upgrade the OSM Platform]]<br />
* [[How to install OSM client | How to install OSM client separately]]<br />
* [[Advanced OSM installation procedures]]<br />
* [[How to install OSM in Amazon EC2 | How to install OSM in Amazon EC2]]<br />
* How to install the [[Classic OSM Build]] (OSM Release THREE 3.1)<br />
* [[How_to_install_OSM_on_VirtualBox | How to install OSM on VirtualBox (Release THREE)]] (and access UI from the host without SSH tunnelling)<br />
<br />
== EPA and SDN Assist ==<br />
* [[EPA_and_SDN_assist | How-to guide]]<br />
* [[Openstack_configuration_(Release_FOUR)#Configure_Openstack_for_full_EPA_support_in_OSM | OpenStack configuration for EPA and SDN Assist]]<br />
<br />
== Reference material and self training ==<br />
* [[OSM client]]:<br />
** [[OSM_client#Installation | Installation]]<br />
** [[OSM Client commands]]<br />
** [[Enable autocompletion in OSM Client]]<br />
* [[OSM instantiation parameters]]<br />
* Using Monitoring capabilities:<br />
** [[OSM_Performance_Management | Performance Management]]<br />
** [[OSM_Fault_Management | OSM Fault Management]]<br />
* 3rd OSM Hackfest - full training material:<br />
** [[3rd_OSM_Hackfest#Agenda | Table of contents]]<br />
** [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/presentations/ Documentation]<br />
** [https://osm-download.etsi.org/ftp/osm-4.0-four/3rd-hackfest/packages/ NS and VNF Packages] and [https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/ VM images]<br />
* [[VIM_emulator | How to use the VIM emulator]]<br />
* [[OSM_E2E_tests | Tests to validate VIM capabilities]]<br />
* [[OSM_workshops_and_events | OSM Workshops videos]]<br />
* [[OSM_Technical_Videos | Other technical videos and demos]]<br />
* [https://osm.etsi.org/images/OSM-Whitepaper-TechContent-ReleaseFOUR-FINAL.pdf Release FOUR White Paper]<br />
* [https://osm.etsi.org/images/OSM_White_Paper_Experience_implementing_NFV_specs_final.pdf OSM's End User Advisory Group White Paper]<br />
<br />
== Troubleshooting ==<br />
* [[How to know the version of your current OSM installation]]<br />
* [[Common issues and troubleshooting]]<br />
* Have you detected any bug? Check [[How_to_report_issues_(Release_THREE) | this guide]] to see how to report issues.<br />
<br />
== How to contribute ==<br />
* [https://osm.etsi.org/about/how-to-join Joining the OSM community]<br />
* Developer guides:<br />
** [[Workflow_with_OSM_tools | Workflow with OSM tools (git, gerrit, bugzilla, etc.) (MUST READ for developers)]]<br />
** [[Developer HowTo | Developer how-to (MUST READ for developers)]]<br />
** [[Developer_HowTo_for_RO_Module | Developer how-to for RO]]<br />
**[[How_to_upgrade_the_OSM_Platform#Upgrading_a_specific_component_to_use_your_own_cloned_repo_.28e.g._for_developing_purposes.29 | How to work with your own cloned repo for a specific component]]<br />
** [https://docs.google.com/document/d/1qL8_GRI81-2s4fFR_CnicUIhIbOeVQ-5H1TknGG-uAQ/edit MON Module Design Description (live document)]<br />
* [https://opensourcemano.slack.com/ OSM Slack Workplace]<br />
* Upcoming Hackfests and events:<br />
** [[5th_OSM_Hackfest|5th OSM Hackfest - Barcelona]]<br />
<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Performance_Management&diff=6064OSM Performance Management2021-02-17T10:39:13Z<p>Ramonsalguer: </p>
<hr />
<div>'''THIS PAGE IS DEPRECATED'''. OSM User Guide has been moved to a new location: '''https://osm.etsi.org/docs/user-guide/'''<br />
<br />
---<br />
<br />
This documentation corresponds to Release SIX 6.0.0, previous documentation related to Performance Management has been deprecated.<br />
<br />
==Activating VNF Metrics Collection==<br />
OSM MON features a "mon-collector" module which will collect metrics whenever specified at the descriptor level.<br />
For metrics to be collected, they have to exist first at any of these two levels:<br />
* NFVI - made available by VIM's Telemetry System<br />
* VNF - made available by OSM VCA (Juju Metrics)<br />
<br />
Reference diagram:<br />
<br />
[[File:osm_pm_rel5.png|800px|OSM Performance Management Reference Diagram]]<br />
<br />
=== VIM Metrics ===<br />
<br />
For VIM metrics to be collected, your VIM should support a Telemetry system. As of Release 5.0.5, metric collection has been tested with: <br />
* OpenStack VIM with Keystone v3 authentication and legacy or Gnocchi-based telemetry services. <br />
* VMware vCloud Director with vRealizeOperations.<br />
Other VIM types will soon be added during the Release FIVE cycle.<br />
<br />
Next step is to activate metrics collection at your VNFDs. Every metric to be collected from the VIM for each VDU has to be described both at the VDU level, and then at the VNF level. For example:<br />
<br />
vdu:<br />
id: vdu1<br />
... <br />
monitoring-param:<br />
- id: metric_vdu1_cpu<br />
nfvi-metric: cpu_utilization<br />
- id: metric_vdu1_memory<br />
nfvi-metric: average_memory_utilization<br />
...<br />
monitoring-param:<br />
- id: metric_vim_vnf1_cpu<br />
name: metric_vim_vnf1_cpu<br />
aggregation-type: AVERAGE<br />
vdu-monitoring-param:<br />
vdu-ref: vdu1<br />
vdu-monitoring-param-ref: metric_vdu1_cpu<br />
- id: metric_vim_vnf1_memory<br />
name: metric_vim_vnf1_memory<br />
aggregation-type: AVERAGE<br />
vdu-monitoring-param:<br />
vdu-ref: vdu1<br />
vdu-monitoring-param-ref: metric_vdu1_memory<br />
<br />
As you can see, a list of "NFVI metrics" is defined first at the VDU level, which contains an ID and the corresponding normalized metric name (in this case, "cpu_utilization" and "average_memory_utilization")<br />
Then, at the VNF level, a list of monitoring-params is referred, with an ID, name, aggregation-type and their source ('vdu-monitoring-param' in this case)<br />
<br />
<br />
====Additional notes====<br />
<br />
* Available attributes and values can be directly explored at the [https://osm.etsi.org/wikipub/index.php/OSM_Information_Model OSM Information Model]<br />
* A complete VNFD example can be downloaded from [https://osm-download.etsi.org/ftp/osm-4.0-four/4th-hackfest/packages/webserver_vimmetric_autoscale_vnfd.tar.gz here].<br />
* Normalized metric names are: cpu_utilization, average_memory_utilization, disk_read_ops, disk_write_ops, disk_read_bytes, disk_write_bytes, packets_received, packets_sent, packets_out_dropped, packets_in_dropped<br />
<br />
<br />
====OpenStack specific notes====<br />
<br />
Since REL6 onwards, MON collects the last measure for the corresponding metric, so no further configuration is needed.<br />
<br />
====VMware vCD specific notes====<br />
<br />
Since REL6 onwards, MON collects all the normalized metrics, with the following exceptions:<br />
<br />
* packets_in_dropped is not available and will always return 0.<br />
* packets_received cannot be measured. Instead the number of bytes received for all interfaces is returned.<br />
* packets_sent cannot be measured. Instead the number of bytes sent for all interfaces is returned.<br />
<br />
The rolling average for vROPS metrics is always 5 minutes. The collection interval is also 5 minutes, and can be changed, however, it will still report the rolling average for the past 5 minutes, just updated according to the collection interval. See https://kb.vmware.com/s/article/67792 for more information.<br />
<br />
Although it is not receommended, if a more frequent interval is desired, the following procedure can be used to change the collection interval:<br />
<br />
* Log into vROPS as an admin.<br />
* Navigate to Administration and expand Configuration.<br />
* Select Inventory Explorer.<br />
* Expand the Adapter Instances and select vCenter Server.<br />
* Edit the vCenter Server instance and expand the Advanced Settings.<br />
* Edit the Collection Interval (Minutes) value and set to the desired value.<br />
* Click OK to save the change.<br />
<br />
=== VNF Metrics ===<br />
<br />
Metrics can also be collected directly from VNFs using VCA, through the [https://docs.jujucharms.com/2.4/en/developer-metrics Juju Metrics] framework. A simple charm containing a metrics.yaml file at its root folder specifies the metrics to be collected and the associated command. <br />
<br />
For example, the following metrics.yaml file collects three metrics from the VNF, called 'users', 'load' and 'load_pct'<br />
<br />
metrics:<br />
users:<br />
type: gauge<br />
description: "# of users"<br />
command: who|wc -l<br />
load:<br />
type: gauge<br />
description: "5 minute load average"<br />
command: cat /proc/loadavg |awk '{print $1}'<br />
load_pct:<br />
type: gauge<br />
description: "1 minute load average percent"<br />
command: cat /proc/loadavg | awk '{load_pct=$1*100.00} END {print load_pct}' <br />
<br />
Please note that the granularity of this metric collection method is fixed to 5 minutes and cannot be changed at this point.<br />
<br />
After metrics.yaml is available, there are two options for describing the metric collection in the VNFD:<br />
<br />
==== 1) VNF-level VNF metrics ====<br />
<br />
mgmt-interface:<br />
cp: vdu_mgmt # is important to set the mgmt VDU or CP for metrics collection<br />
vnf-configuration:<br />
initial-config-primitive:<br />
...<br />
juju:<br />
charm: testmetrics<br />
metrics:<br />
- name: load <br />
- name: load_pct<br />
- name: users <br />
... <br />
monitoring-param:<br />
- id: metric_vim_vnf1_load<br />
name: metric_vim_vnf1_load<br />
aggregation-type: AVERAGE<br />
vnf-metric:<br />
vnf-metric-name-ref: load<br />
- id: metric_vim_vnf1_loadpct<br />
name: metric_vim_vnf1_loadpct<br />
aggregation-type: AVERAGE<br />
vnf-metric:<br />
vnf-metric-name-ref: load_pct<br />
<br />
Additional notes:<br />
* Available attributes and values can be directly explored at the [https://osm.etsi.org/wikipub/index.php/OSM_Information_Model OSM Information Model]<br />
* A complete VNFD example with VNF metrics collection (VNF-level) can be downloaded from [https://osm-download.etsi.org/ftp/osm-4.0-four/4th-hackfest/packages/ubuntuvm_vnfmetric_autoscale_vnfd.tar.gz here].<br />
<br />
==== 2) VDU-level VNF metrics ====<br />
<br />
vdu:<br />
- id: vdu1<br />
...<br />
interface:<br />
- ...<br />
mgmt-interface: true ! is important to set the mgmt interface for metrics collection<br />
...<br />
vdu-configuration:<br />
initial-config-primitive:<br />
...<br />
juju:<br />
charm: testmetrics<br />
metrics:<br />
- name: load <br />
- name: load_pct<br />
- name: users <br />
... <br />
monitoring-param:<br />
- id: metric_vim_vnf1_load<br />
name: metric_vim_vnf1_load<br />
aggregation-type: AVERAGE<br />
vdu-metric:<br />
vdu-ref: vdu1<br />
vdu-metric-name-ref: load<br />
- id: metric_vim_vnf1_loadpct<br />
name: metric_vim_vnf1_loadpct<br />
aggregation-type: AVERAGE<br />
vdu-metric:<br />
vdu-ref: vdu1<br />
vdu-metric-name-ref: load_pct<br />
<br />
Additional notes:<br />
* Available attributes and values can be directly explored at the [https://osm.etsi.org/wikipub/index.php/OSM_Information_Model OSM Information Model]<br />
* A complete VNFD example with VNF metrics collection (VDU-level) can be downloaded from [https://osm-download.etsi.org/ftp/osm-4.0-four/4th-hackfest/packages/ubuntuvm_vnfvdumetric_autoscale_vnfd.tar.gz here]. <br />
<br />
As in VIM metrics, a list of "metrics" is defined first either at the VNF or VDU "configuration" level, which contain a name that comes from the metrics.yaml file. Then, at the VNF level, a list of monitoring-params is referred, with an ID, name, aggregation-type and their source, which can be a "vdu-metric" or a "vnf-metric" in this case.<br />
<br />
==Retrieving metrics from Prometheus TSDB==<br />
<br />
Once the metrics are being collected, they are stored in the Prometheus Time-Series DB '''with an 'osm_' prefix''', and there are a number of ways in which you can retrieve them.<br />
<br />
=== 1) Visualizing metrics in Prometheus UI ===<br />
<br />
Prometheus TSDB includes its own UI, which you can visit at http://[OSM_IP]:9091<br />
<br />
From there, you can:<br />
* Type any metric name (i.e. osm_cpu_utilization) in the 'expression' field and see its current value or a histogram.<br />
* Visit the Status --> Target menu, to monitor the connection status between Prometheus and MON (through 'mon-exporter')<br />
<br />
[[File:osm_prometheus_rel5.png|800px|Screenshot of OSM Prometheus UI]]<br />
<br />
=== 2) Integrating Prometheus with Grafana ===<br />
<br />
There is a well-known integration between these two components that allows Grafana to easily show interactive graphs for any metric. You can use any existing Grafana installation or the one that comes in OSM as the experimental "pm_stack".<br />
<br />
To install the 'pm_stack' (which today includes only Grafana), in an existing OSM installation, run the installer in the following way:<br />
./install_osm.sh -o pm_stack<br />
Otherwise, if you are installing from scratch, you can simply run the installer with the pm_stack option.<br />
./install.sh --pm_stack<br />
<br />
Once installed, access Grafana with its default credentials (admin / admin) at http://[OSM_IP_address]:3000 and by clicking the 'Manage' option at the 'Dashboards' menu (to the left), you will find a sample dashboard containing two graphs for VIM metrics, and two graphs for VNF metrics. You can easily change them or add more, as desired.<br />
<br />
[[File:osm_grafana_rel5.png|800px|Screenshot of OSM Grafana UI]]<br />
<br />
=== 3) Interacting with Prometheus directly through its API ===<br />
<br />
Even though many analytics applications, like Grafana, include their own integration for Prometheus, some other applications do not include it out of the box or there is a need to build a custom integration. <br />
<br />
In such cases, the [https://prometheus.io/docs/prometheus/latest/querying/api/ Prometheus HTTP API] can be used to gather any metrics. A couple of examples are shown below:<br />
<br />
Example with Date range query<br />
curl 'http://localhost:9091/api/v1/query_range?query=osm_cpu_utilization&start=2018-12-03T14:10:00.000Z&end=2018-12-03T14:20:00.000Z&step=15s'<br />
<br />
Example with Instant query<br />
curl 'http://localhost:9091/api/v1/query?query=osm_cpu_utilization&time=2018-12-03T14:14:00.000Z'<br />
<br />
Further examples and API calls can be found at the [https://prometheus.io/docs/prometheus/latest/querying/api/ Prometheus HTTP API documentation].<br />
<br />
=== 4) Interacting directly with MON Collector ===<br />
<br />
The way Prometheus TSDB stores metrics is by querying Prometheus 'exporters' periodically, which are set as 'targets'. Exporters expose current metrics in a specific format that Prometheus can understand, more information can be found [https://prometheus.io/docs/instrumenting/exporters/ here]<br />
<br />
OSM MON features a "mon-exporter" module that exports '''current metrics''' through port 8000. Please note that this port is by default not being exposed outside the OSM docker's network.<br />
<br />
A tool that understands Prometheus 'exporters' (for example, Elastic Metricbeat) can be plugged-in to integrate directly with "mon-exporter". To get an idea on how metrics look alike in this particular format, you could:<br />
<br />
1. Get into MON console<br />
docker exec -ti osm_mon.1.[id] bash<br />
2. Install curl<br />
apt -y install curl<br />
3. Use curl to get the current metrics list<br />
curl localhost:8000<br />
<br />
Please note that as long as the Prometheus container is up, it will continue retrieving and storing metrics in addition to any other tool/DB you connect to "mon-exporter"<br />
<br />
=== 5) Using your own TSDB ===<br />
<br />
OSM MON integrates Prometheus through a plugin/backend model, so if desired, other backends can be developed. If interested in contributing with such option, you can ask for details at our Slack #mon channel or through the OSM Tech mailing list.<br />
<br />
==Default Infrastructure Status Collection==<br />
OSM MON collects, automatically, "status metrics" for:<br />
* VIMs - each VIM that OSM establishes contact with, the metric will be reflected with the name 'osm_vim_status' in the TSDB.<br />
* VMs - VMs for each VDU that OSM has instantiated, the metric will be reflected with the name 'osm_vm_status' in the TSDB.<br />
<br />
Metrics will be "1" or "0" depending on the element availability.<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=File:Madrid3.jpg&diff=5192File:Madrid3.jpg2020-01-09T11:07:17Z<p>Ramonsalguer: </p>
<hr />
<div></div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM-MR8_Hackfest&diff=5191OSM-MR8 Hackfest2020-01-09T11:06:06Z<p>Ramonsalguer: </p>
<hr />
<div>[[File:madrid3.jpg|750px|center|top]]<br />
= Overview = <br />
[[File:OSM-MR8_Hack.png|350px|right|top|link=https://portal.etsi.org/Meetings.aspx#/meeting?MtgId=37071]] <br />
<br />
ETSI's Centre for Testing and Interoperability and the OSM community are organizing the 9th OSM Hackfest on 9-13 March 2020. <br />
<br />
The event will be hosted by '''[https://www.telefonica.com/en/home Telefonica]''' in Madrid, Spain, co-located with the '''[https://portal.etsi.org/Meetings.aspx#/meeting?MtgId=37070 OSM-MR#8]''' meeting, offering a great opportunity to share and learn with OSM developers and module leaders, and explore opportunities for synergies and collaboration.<br />
<br />
Participation to OSM Hackfests is free and open to all upon '''[https://portal.etsi.org/Meetings.aspx#/meeting?MtgId=37071 Registration]'''<br />
<br />
== Venue ==<br />
Distrito Telefónica - <br />
<br />
Edificio Central “A” - Auditorium "Sala de los Ciria".<br />
<br />
Ronda de la Comunicación, s/n<br />
<br />
28050 Madrid<br />
<br />
SPAIN<br />
<br />
* ''[https://osm.etsi.org/wikipub/images/a/a1/Meeting_Invitation_OSM_Mid-Release_8_Madrid.docx Download OSM-MR#8 invitation, hotel recommendations and Visa Invitation Letter]''<br />
<br />
<br />
[[File:OSM_community_lucca.jpg|800px|center]]<br />
<br />
= Scope =<br />
This OSM Hackfest will allow new users to get familiar with '''OSM Release SEVEN''' and exercise all the new functionalities, from basic operations (installation, setup, common operations, etc.) to most advanced capabilities, such as 5G network slicing, orchestration of containerized network functions and hybrid network services, with a big focus on VNF on-boarding activities covering Day 0/1/2 operations.<br />
<br />
In addition, experienced users and developers will have the opportunity to hack into OSM, build complex examples, fine-tune, test and demonstrate experimental features on the OSM Remote Labs network.<br />
<br />
= Objectives =<br />
OSM Hackfest participants will learn to :<br />
* Install OSM and run some examples<br />
* Get familiar with OSM's GUI and CLI<br />
* Create basic VNF and NS Descriptors and build own packages<br />
* Model and deploy Advanced Network Services with:<br />
** Multi-VDU VNFs <br />
** EPA capabilities<br />
** Physical and Hybrid Network Functions<br />
** Containerized Network Functions<br />
* Model dynamic Life Cycle Management operations with Day-1 and Day-2 actions<br />
* Configure Fault and Performance Management and close-loop operations<br />
** Collecting, visualizing and reacting to metrics and events<br />
* Model and Deploy 5G Network Slices <br />
* Configure and Deploy Service Function Chaining<br />
* Contribute, modify and experiment with OSM source code<br />
** Perform basic troubleshooting<br />
* Understand OSM CI/CD and Robot Framework<br />
** Build complex examples and run own experimental testing<br />
<br />
= Who should attend =<br />
* VNF vendors, who want to onboard their VNF in OSM following best practices<br />
* System Integrators, who want to get started with OSM<br />
* Service providers, who want to get first hand operational experience with OSM<br />
* Academia and Universities, who are using or considering OSM as platform for their research activities in networking<br />
* Experimented developers and users that want to share and test with the community<br />
<br />
[[File:OSM_hack_lucca2.png|800px|center]]<br />
<br />
= Prerequisites =<br />
* Seats are limited, [https://portal.etsi.org/Meetings.aspx#/meeting?MtgId=36290 registration] is mandatory<br />
* Participants are expected to have user-level knowledge of Linux and be familiar with NFV and SDN concepts<br />
* Laptop <br />
* A remote environment will be made available for participants, if you prefer to install in your own laptop, please follow [https://osm.etsi.org/wikipub/index.php/OSM_Release_SIX#Default_installation_procedure the default installation procedure]. Main requirements: <br />
** MINIMUM: 2 CPUs, 4 GB RAM, 20GB disk and a single interface with Internet access<br />
** RECOMMENDED: 2 CPUs, 8 GB RAM, 40GB disk and a single interface with Internet access<br />
<!--<br />
<br />
= Agenda =<br />
* ''Tentative: Please note the sessions' times and contents may be subject to change''<br />
<br />
<googlespreadsheet style="width:850px; height:400px">1oo4mlOkz4e3J3zw68FPhqVQTlD-EZ5mHVfreeNrNASY</googlespreadsheet><br />
<br />
== OSM Hackfest Sessions ==<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%205GCity%20-%20Welcome.pdf Opening, Welcome & Logistics for the week]''' (ETSI, 5Gcity)<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%200%20-%20Introduction%20to%20NFV%20and%20OSM.pdf Session 0: Introduction to NFV and OSM]''' (Jose Miguel Guzman - Whitestack)<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Demo%200%20-%20OSM%20in%20action.pdf Demo 0: OSM in Action]''' (Piotr Zuraniewski - TNO)<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%201%20-%20Installation%20and%20first%20use.pdf Session 1: OSM Installation and first use (Release SIX)]''' Adrian Candel, Guillermo Calvino - Altran)<br />
* '''Session 2: Basic Descriptors'''<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%202.1%20-%20Creating%20a%20basic%20VNF%20and%20NS.pdf Session 2.1 VNFDs and NSDs] (Abubakr Magzoub - Uni Lancaster)<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%202.2%20-%20Guidelines%20for%20VNF%20builders.pdf Session 2.2 Instructions to VNF Providers] (Adrian Candel, Guillermo Calvino - Altran)<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%203%20-%20Modeling%20multi-VDU%20VNF.pdf Session 3: Modeling multi-VDU VNFs]''' (Adrian Candel, Guillermo Calvino - Altran)<br />
* '''Session 4: Advanced Descriptors'''<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%204.1%20-%20Modeling%20EPA%20capabilities%20in%20VNF.pdf Session 4.1: Modeling EPA capabilities in VNF] (Tomas Villaseca - Whitestack)<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%204.2%20-%20Modeling%20EPA%20capabilities_%20SR-IOV.pdf Session 4.2: Modeling EPA capabilities: SR-IOV] (Gianpietro Lavado - Whitestack)<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%204.3%20-%20Physical%20Network%20Functions.pdf Session 4.3: Modeling Physical and Hybrid Network Functions] (Tomas Villaseca - Whitestack)<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%205%20-%20Adding%20day-0%20configuration%20to%20VNFs.pdf Session 5: Adding Day-0 configuration to your VNF]''' (Adrian Candel, Guillermo Calvino - Altran)<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%206%20-%205G%20Network%20Slicing%20with%20OSM.pdf Session 6: 5G Network Slicing with OSM]''' (Felipe Vicens - Atos)<br />
* '''Session 7: Adding day-1/day-2 configuration to your VNF'''<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%207.1%20-%20Introduction%20to%20Proxy%20Charms.pdf Session 7.1: Proxy Charms and Primitives] (Gianpietro Lavado - Whitestack)<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%207.2%20-%20Building%20a%20Proxy%20Charm.pdf Session 7.2: Building a Proxy Charm] (Mark Beierl - VMware)<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%207.3%20-%20New%20Native%20Charms.pdf Session 7.3: Native Charms] (Dominik Fleischmann, David Garcia - Canonical)<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%208%20-%20OSM%20Service%20Assurance.pptx.pdf Session 8: Fault & Performance Management with OSM]''' (Gianpietro Lavado - Whitestack)<br />
* '''Session 9: VNF On-boarding'''<br />
** [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%209.1%20-%20VNF%20Onboarding%20Walkthrough.pdf Session 9.1: VNF On-boarding Walkthrough] (Gianpietro Lavado - Whitestack)<br />
** Session 9.2: VNF On-boarding to VCD (Mark Beierl - VMware)<br />
* '''[http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/8th%20OSM%20Hackfest%20-%20Session%2010%20-%20Service%20Function%20Chaining.pdf Session 10: Service Function Chaining]''' (Davide Borsatti - Uni Bologna)<br />
* '''Session 11: CI/CD overview & Robot Framework''' (Javier Garcia Lloreda - TechMahindra)<br />
* '''Session 12: How to Contribute to OSM''' (Javier Garcia Lloreda - TechMahindra)<br />
<br />
== 5G Day: "From Data-centers to the Edge with OSM" ==<br />
As in previous editions, Wednesday afternoon will be dedicated to 5G experiences, pilots and research projects, this time focusing on Edge deployments. The agenda is as follows:<br />
<br />
* '''Keynote 5G day: [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/5Gday/OSM-5GDay_keynote.pdf An operator's view on the importance of OSM to realize the 5G vision.]''' (Pål Gronsund - Telenor): ''The presentation will highlight a set of 5G use cases implemented and problems to be solved with OSM as the orchestrator for end-to-end orchestration and automation.''<br />
<br />
* '''5G Day Session 1: [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/5Gday/Unified_5G_Edge_Operations.pdf Unified 5G Edge Operations Platform]''' (Joe Issaac - Wipro): ''Wipro's Universal Edge Networks Platform is delivered from our state-of-the-art Digital Operations Center. This is built on a set of best-of-breed products, tightly pre-integrated, with predefined rules and intelligence for a wide range of devices. With a high level of automation and cognitive capability, templatized processes, ready for roll-out, highly self-service-driven, data export facilities to clouds & advanced visualizations, the plaform is scalable to millions of nodes with ability to external integration to data lifecycle tools through a self service interface. This solution is ready to deploy edge-based on Wipro Blueprint available. It can host multiple vertical use cases that will be adopted to leverage 5G edges Use Smart-iConnect, Fan engagement, AirEnF, Analytics, etc.''<br />
<br />
* '''5G Day Session 2: [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/5Gday/5GaaS_presentation_for_OSM_v3a.pdf 5G as a Service (5GaaS) – easy access for 3rd parties to 5G technology]''' (Piotr Zuraniewski - TNO): ''Presentation of initial ideas about TNO 5G-as-a-Service (5GaaS) PoC platform. The aim of the platform is to provide engineers from the field of Information Technology (IT) with access to specific features of 5G cellular network technology, without requiring them to have an expert level understanding of the mobile technology involved. At the same time, the PoC platform also adds value to experts in 5G in terms of support for carrying out research on 5G services and technology.''<br />
<br />
* '''5G Day Session 3: [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/5Gday/5GEVE_OMS_hackfest_CNIT%20v2.pdf Orchestration of 5GCity edge computing with OSM: pilot trials and lessons learnt]''' (Shuaib Siddiqui - i2CAT): ''The 5GCity project is developing a distributed cloud and radio platform for municipalities and infrastructure owners acting as 5G Neutral Hosts. We orchestrate a completely decentralised 3-tier architecture where compute, storage and networking are allocated between core and edge segments of the 5G network infrastructure. Our unified orchestration platform includes ETSI OSM at its core to deliver 5G Network Services in sliced city infrastructures in Barcelona (ES), Bristol (UK) and Lucca (IT). We primarily run trials of Media Verticals use cases to assess how a Neutral Host operator can offer mobile connectivity solutions on demand. Through our platform and with ETSI OSM Release 6 we implement dedicated network slices for different media services in areas with a high concentration of users. The network edge is very critical for our project in terms of design and orchestration of multiple tiers. We have developed a multi-tier orchestrator to control OSM and fog05 MEAO, in addition to using fog05 as VIM in OSM. In this talk we will present experiences with OSM from or pilot trials and we will share some lessons learnt.''<br />
<br />
* '''5G Day Session 4: [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/5Gday/OSM_5G_Session_netOps.ai.pdf NetworkDevOps (netOps.ai 2.0) with Continuous Orchestration]''' (Manish Singh - Tech Mahindra): ''A complete automated Telco grade PAAS solution for 4G/5G functions with continuous release management, functional & performance validation, monitoring & continuous orchestration using OSM. The entire scope of the PAAS solution is targeted to run multi-VNF LCM functionalities & provisioning 4G/5G network services orchestrated using OSM followed by certification procedures. Smooth rollout of the Production Sites & multi-vendor VNF deployments with any underneath Infra & Edge components. Providing CSP a clear idea about their 4G/5G Telco Cloud solution performance & OPEx. Using netops.ai CSP can evaluate any combination of multi-vendor composition & choose the best blended Telco cloud Infra & VNF to create the required network service.''<br />
<br />
* '''5G Day Session 5: [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/5Gday/OSM%20Hackfest8_Matilda_Project.pdf 5G-ready applications in Matilda - Demo]''' (Roberto Bruschi, Chiara Lombardo - CNIT): ''Part of the scope of the Matilda project is to design and develop a radically new prototypic framework of the Telecom Layer Platform able to support functional and performance requirements, as well as the effective lifecycle management of 5G-ready Vertical Applications. For that, we built a highly modular architecture aimed to dynamically control, abstract, and suitably expose the 5G network infrastructure resources and services to vertical applications in terms of network and computing slices, taking advantage of in OSM for managing the lifecycle and configuration of the network functions.''<br />
<br />
* '''5G Day Session 6: [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/5Gday/OSM_5G_DAY-NXW-5G-MEDIA-UHD_over_vCDN-v03.pdf Cognitive-driven Orchestration and Optimization of Cloud to Edge virtualized Content Delivery Networks]''' (Francesca Moscatelli - Nextworks): ''The “Ultra High Definition over virtualized Content Delivery Network” Pilot developed in the context of the EU funded 5G-MEDIA project (H2020 5GPPP phase 2 Innovation Action) shows how Media Service Providers can build flexible, adaptable and distributed core-to-edge vCDN services. Relying on the capabilities offered by the 5G-MEDIA Service Virtualization Platform, built around ETSI OSM, the adaptation and optimization of the service is performed at the edge of the network upon monitored application metrics and detected anomalies in traffic flows; the service chain is then re-adapted and re-configured automatically and dynamically for offering to the end-user a better QoE.''<br />
<br />
* '''5G Day Session 7: [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/5Gday/5GEVE_OMS_hackfest_CNIT%20v2.pdf Multi-site orchestration of end-to-end 5G networks: the 5G EVE approach for the inter-working of multiple 5G experiment facilities.]''' (Francesco Lombardo, Matteo Pergolesi - CNIT): ''The goal of 5G EVE is to provide a 5G platform for extensive trials of network services hosted on various European trial sites (Greece, Spain, France, and Italy). The interconnection and inter-operation between remote sites in different network domains is a big challenge. We introduce the concept of the Inter-Working Layer (IWL), a middle-ware to provide a common catalog of Network Service Descriptors, a common Life-Cycle Manager, and a Multi-Site top-level Orchestrator able to deploy and manage network services hosted on a single site or split on multiple sites. The OSM orchestrator is used in the trial sites of Turin (Italy) and Madrid (Spain). The usage of the platform is made user-friendly by the definition of high-level, intent-based blueprints to describe vertical services.''<br />
<br />
* '''5G Day Wrap-up: Mini-panel to resume, compare and sum up the findings from the previous presentations'''<br />
<br />
== Hackfest Material ==<br />
* [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/presentations/ Presentations]<br />
* [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/packages/ Packages]<br />
* [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/images/ Images]<br />
* [http://osm-download.etsi.org/ftp/osm-6.0-six/8th-hackfest/other/ Other]<br />
--><br />
= Remote Labs = <br />
During OSM Hackfests participants build and try real examples of OSM interaction with different VIMs and NFV Infrastructures that are kindly made available by our community members through the OSM Remote Labs network. <br />
[[File:OSM_RemoteLabs.png|800px|center]]<br />
<br />
= Previous Hackfests =<br />
* [[8th OSM Hackfest | 8th OSM Hackfest - Lucca (Italy)]]<br />
* [[7th OSM Hackfest | 7th OSM Hackfest - Patras (Greece)]]<br />
* [[6th OSM Hackfest | 6th OSM Hackfest - Santa Clara (CA, USA)]]<br />
* [[5th OSM Hackfest | 5th OSM Hackfest - Barcelona (Spain)]]<br />
* [[4th OSM Hackfest | 4th OSM Hackfest - Palo Alto (CA, USA)]]<br />
* [[3rd OSM Hackfest | 3rd OSM Hackfest - Oslo (Norway)]]<br />
* [[2nd OSM Hackfest | 2nd OSM Hackfest - Madrid (Spain)]]<br />
* [[1st OSM Hackfest | 1st OSM Hackfest - Sophia Antipolis (France)]]<br />
<br />
= Get involved in OpenSourceMANO =<br />
* Join the [https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk OSM Community Slack Workspace]<br />
* If your organisation is already an [https://portal.etsi.org/TBSiteMap/OSM/ListofOSMMembers.aspx OSM member], you can also:<br />
** [https://webapp.etsi.org/createaccount/ Request an EOL account] (if you don’t have one yet)<br />
** Subscribe [https://list.etsi.org/scripts/wa.exe?SUBED1=OSG_OSM&A=1 OSM general] and [https://list.etsi.org/scripts/wa.exe?SUBED1=OSM_TECH&A=1 OSM TECH] mailing lists<br />
* If your organisation is not yet an OSM member:<br />
** Learn [https://osm.etsi.org/about/how-to-join how to join], it is free and open to all<br />
* Join the [https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem OSM Ecosystem]<br />
<br />
= Contact =<br />
Please send your technical questions to [mailto:OSM_TECH@list.etsi.org OSM_TECH@list.etsi.org] or join the [https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk OSM Community Slack Workspace]<br />
<br />
Questions about ETSI, joining OSM, this hackfest and future events can be sent to: [mailto:OSMSupport@etsi.org OSMSupport@etsi.org]</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=New_Index&diff=5148New Index2019-12-12T07:56:44Z<p>Ramonsalguer: </p>
<hr />
<div>{|<br />
|[[File:books.jpg|100px|left|top|link=https://osm.etsi.org/docs/osm-user-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big>Check out the '''[https://osm.etsi.org/docs/user-guide/ OSM User Documentation]''' </big><br />
<br />
If you are new to OSM, you might want to start by the '''[https://osm.etsi.org/docs/user-guide/01-quickstart.html Quick Start Guide]''' <br />
|}<br />
<br />
{|<br />
|[[File:engine.jpg|100px|left|top|link=https://osm.etsi.org/docs/vnf-onboarding-guidelines]] <br />
||[[File:Space.png|20px]] <br />
| <big> Discover the '''[https://osm.etsi.org/docs/vnf-onboarding-guidelines VNF On-boarding Guidelines]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:code.png|100px|left|top|link=https://osm.etsi.org/docs/osm-developer-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big> Access the '''[https://osm.etsi.org/docs/developer-guide Documentation for Developers]'''</big><br />
|}<br />
<br />
{|<br />
|[[File:Upcoming_Hack.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Hackfests]] <br />
||[[File:Space.png|20px]] <br />
| <big> Register to an upcoming '''[[OSM Hackfests|OSM Hackfest]]'''. It is free and open to all. </big><br />
|} <br />
<br />
{|<br />
|[[File:Lego.jpg|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_PoCs]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[[OSM PoCs]]''', or '''[https://osm.etsi.org/wikipub/index.php/OSM_PoC_Framework submit a PoC Proposal]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:Ecosystem.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem]] <br />
||[[File:Space.png|20px]] <br />
|<big> Discover the '''[[OSM Ecosystem]]''' and get your organisation listed! </big><br />
|}<br />
<br />
{|<br />
|[[File:Outreach.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers OSM Release Notes, White Papers]''', '''[https://osm.etsi.org/wikipub/index.php/OSM_workshops_and_events Workshops, Events]''' and '''[http://www.youtube.com/c/OpenSourceMANO YouTube Channel]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:open-bw.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Engage]] <br />
||[[File:Space.png|20px]] <br />
|<big> '''[[Engage]]''' with the OSM Community. We are '''OPEN'''! </big><br />
|}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=New_Index&diff=5147New Index2019-12-12T07:48:43Z<p>Ramonsalguer: </p>
<hr />
<div>{|<br />
|[[File:books.jpg|100px|left|top|link=https://osm.etsi.org/docs/osm-user-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big>Check out the '''[https://osm.etsi.org/docs/user-guide/ OSM User Documentation]''' </big><br />
<br />
If you are new to OSM, you might want to start by the '''[https://osm.etsi.org/docs/user-guide/01-quickstart.html Quick Start Guide]''' <br />
|}<br />
<br />
{|<br />
|[[File:engine.jpg|100px|left|top|link=https://osm.etsi.org/docs/vnf-onboarding-guidelines]] <br />
||[[File:Space.png|20px]] <br />
| <big> Discover the '''[https://osm.etsi.org/docs/vnf-onboarding-guidelines VNF On-boarding Guidelines]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:code.png|100px|left|top|link=https://osm.etsi.org/docs/osm-developer-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big> Access the '''[https://osm.etsi.org/docs/developer-guide Developer Documentation]'''</big><br />
|}<br />
<br />
{|<br />
|[[File:Upcoming_Hack.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Hackfests]] <br />
||[[File:Space.png|20px]] <br />
| <big> Register to an upcoming '''[[OSM Hackfests|OSM Hackfest]]'''. It is free and open to all. </big><br />
|} <br />
<br />
{|<br />
|[[File:Lego.jpg|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_PoCs]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[[OSM PoCs]]''', or '''[https://osm.etsi.org/wikipub/index.php/OSM_PoC_Framework submit a PoC Proposal]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:Ecosystem.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem]] <br />
||[[File:Space.png|20px]] <br />
|<big> Discover the '''[[OSM Ecosystem]]''' and get your organisation listed! </big><br />
|}<br />
<br />
{|<br />
|[[File:Outreach.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers OSM Release Notes, White Papers]''', '''[https://osm.etsi.org/wikipub/index.php/OSM_workshops_and_events Workshops, Events]''' and '''[http://www.youtube.com/c/OpenSourceMANO YouTube Channel]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:open-bw.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Engage]] <br />
||[[File:Space.png|20px]] <br />
|<big> '''[[Engage]]''' with the OSM Community. We are '''OPEN'''! </big><br />
|}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=New_Index&diff=5146New Index2019-12-12T07:46:19Z<p>Ramonsalguer: </p>
<hr />
<div>{|<br />
|[[File:books.jpg|100px|left|top|link=https://osm.etsi.org/docs/osm-user-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big>Check out the '''[https://osm.etsi.org/docs/user-guide/ OSM User Documentation]''' </big><br />
<br />
If you are a newbie you might want to start by the '''[https://osm.etsi.org/docs/user-guide/01-quickstart.html Quick Start Guide]''' <br />
|}<br />
<br />
{|<br />
|[[File:engine.jpg|100px|left|top|link=https://osm.etsi.org/docs/vnf-onboarding-guidelines]] <br />
||[[File:Space.png|20px]] <br />
| <big> Discover the '''[https://osm.etsi.org/docs/vnf-onboarding-guidelines VNF On-boarding Guidelines]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:code.png|100px|left|top|link=https://osm.etsi.org/docs/osm-developer-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big> Access the '''[https://osm.etsi.org/docs/developer-guide Developer Documentation]'''</big><br />
|}<br />
<br />
{|<br />
|[[File:Upcoming_Hack.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Hackfests]] <br />
||[[File:Space.png|20px]] <br />
| <big> Register to an upcoming '''[[OSM Hackfests|OSM Hackfest]]'''. It is free and open to all. </big><br />
|} <br />
<br />
{|<br />
|[[File:Lego.jpg|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_PoCs]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[[OSM PoCs]]''', or '''[https://osm.etsi.org/wikipub/index.php/OSM_PoC_Framework submit a PoC Proposal]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:Ecosystem.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem]] <br />
||[[File:Space.png|20px]] <br />
|<big> Discover the '''[[OSM Ecosystem]]''' and get your organisation listed! </big><br />
|}<br />
<br />
{|<br />
|[[File:Outreach.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers OSM Release Notes, White Papers]''', '''[https://osm.etsi.org/wikipub/index.php/OSM_workshops_and_events Workshops, Events]''' and '''[http://www.youtube.com/c/OpenSourceMANO YouTube Channel]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:open-bw.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Engage]] <br />
||[[File:Space.png|20px]] <br />
|<big> '''[[Engage]]''' with the OSM Community. We are '''OPEN'''! </big><br />
|}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=New_Index&diff=5145New Index2019-12-12T07:45:00Z<p>Ramonsalguer: </p>
<hr />
<div>{|<br />
|[[File:books.jpg|100px|left|top|link=https://osm.etsi.org/docs/osm-user-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big>Check out the '''[https://osm.etsi.org/docs/user-guide/ OSM User Documentation]''' </big><br />
<br />
If you are a newbie you might want to start by the '''[https://osm.etsi.org/docs/user-guide/01-quickstart.html Quick Start Guide]''' <br />
|}<br />
<br />
{|<br />
|[[File:engine.jpg|100px|left|top|link=https://osm.etsi.org/docs/vnf-onboarding-guidelines]] <br />
||[[File:Space.png|20px]] <br />
| <big> Discover the '''[https://osm.etsi.org/docs/vnf-onboarding-guidelines VNF On-boarding Guidelines]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:code.png|100px|left|top|link=https://osm.etsi.org/docs/osm-developer-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big> Access the '''[https://osm.etsi.org/docs/developer-guide OSM Developer Documentation]'''</big><br />
|}<br />
<br />
{|<br />
|[[File:Upcoming_Hack.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Hackfests]] <br />
||[[File:Space.png|20px]] <br />
| <big> Register to an upcoming '''[[OSM Hackfests|OSM Hackfest]]'''. It is free and open to all. </big><br />
|} <br />
<br />
{|<br />
|[[File:Lego.jpg|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_PoCs]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[[OSM PoCs]]''', or '''[https://osm.etsi.org/wikipub/index.php/OSM_PoC_Framework submit a PoC Proposal]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:Ecosystem.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem]] <br />
||[[File:Space.png|20px]] <br />
|<big> Discover the '''[[OSM Ecosystem]]''' and get your organisation listed! </big><br />
|}<br />
<br />
{|<br />
|[[File:Outreach.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers OSM Release Notes, White Papers]''', '''[https://osm.etsi.org/wikipub/index.php/OSM_workshops_and_events Workshops, Events]''' and '''[http://www.youtube.com/c/OpenSourceMANO YouTube Channel]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:open-bw.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Engage]] <br />
||[[File:Space.png|20px]] <br />
|<big> '''[[Engage]]''' with the OSM Community. We are '''OPEN'''! </big><br />
|}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=New_Index&diff=5144New Index2019-12-12T01:13:14Z<p>Ramonsalguer: </p>
<hr />
<div>{|<br />
|[[File:books.jpg|100px|left|top|link=https://osm.etsi.org/docs/osm-user-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big>Check out the '''[https://osm.etsi.org/docs/user-guide/ OSM User Documentation]''' </big><br />
<br />
If you are a newbie you might want to start by the '''[https://osm.etsi.org/docs/user-guide/01-quickstart.html Quick Start Guide]''' <br />
|}<br />
<br />
{|<br />
|[[File:engine.jpg|100px|left|top|link=https://osm.etsi.org/docs/vnf-onboarding-guidelines]] <br />
||[[File:Space.png|20px]] <br />
| <big> Discover the '''[https://osm.etsi.org/docs/vnf-onboarding-guidelines VNF On-boarding Guidelines]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:code.png|100px|left|top|link=https://osm.etsi.org/docs/osm-developer-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big> Access the '''[https://osm.etsi.org/docs/osm-developer-guide OSM Developer Documentation]'''</big><br />
|}<br />
<br />
{|<br />
|[[File:Upcoming_Hack.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Hackfests]] <br />
||[[File:Space.png|20px]] <br />
| <big> Register to an upcoming '''[[OSM Hackfests|OSM Hackfest]]'''. It is free and open to all. </big><br />
|} <br />
<br />
{|<br />
|[[File:Lego.jpg|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_PoCs]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[[OSM PoCs]]''', or '''[https://osm.etsi.org/wikipub/index.php/OSM_PoC_Framework submit a PoC Proposal]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:Ecosystem.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem]] <br />
||[[File:Space.png|20px]] <br />
|<big> Discover the '''[[OSM Ecosystem]]''' and get your organisation listed! </big><br />
|}<br />
<br />
{|<br />
|[[File:Outreach.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers OSM Release Notes, White Papers]''', '''[https://osm.etsi.org/wikipub/index.php/OSM_workshops_and_events Workshops, Events]''' and '''[http://www.youtube.com/c/OpenSourceMANO YouTube Channel]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:open-bw.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Engage]] <br />
||[[File:Space.png|20px]] <br />
|<big> '''[[Engage]]''' with the OSM Community. We are '''OPEN'''! </big><br />
|}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=New_Index&diff=5143New Index2019-12-12T01:11:31Z<p>Ramonsalguer: </p>
<hr />
<div>{|<br />
|[[File:books.jpg|100px|left|top|link=https://osm.etsi.org/docs/osm-user-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big>Check out the '''[https://osm.etsi.org/docs/osm-user-guide OSM User Documentation]''' </big><br />
<br />
If you are a newbie you might want to start by the '''[https://osm.etsi.org/docs/user-guide/01-quickstart.html Quick Start Guide]''' <br />
|}<br />
<br />
{|<br />
|[[File:engine.jpg|100px|left|top|link=https://osm.etsi.org/docs/vnf-onboarding-guidelines]] <br />
||[[File:Space.png|20px]] <br />
| <big> Discover the '''[https://osm.etsi.org/docs/vnf-onboarding-guidelines VNF On-boarding Guidelines]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:code.png|100px|left|top|link=https://osm.etsi.org/docs/osm-developer-guide]] <br />
||[[File:Space.png|20px]] <br />
| <big> Access the '''[https://osm.etsi.org/docs/osm-developer-guide OSM Developer Documentation]'''</big><br />
|}<br />
<br />
{|<br />
|[[File:Upcoming_Hack.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Hackfests]] <br />
||[[File:Space.png|20px]] <br />
| <big> Register to an upcoming '''[[OSM Hackfests|OSM Hackfest]]'''. It is free and open to all. </big><br />
|} <br />
<br />
{|<br />
|[[File:Lego.jpg|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_PoCs]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[[OSM PoCs]]''', or '''[https://osm.etsi.org/wikipub/index.php/OSM_PoC_Framework submit a PoC Proposal]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:Ecosystem.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/OSM_Ecosystem]] <br />
||[[File:Space.png|20px]] <br />
|<big> Discover the '''[[OSM Ecosystem]]''' and get your organisation listed! </big><br />
|}<br />
<br />
{|<br />
|[[File:Outreach.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers]] <br />
||[[File:Space.png|20px]] <br />
| <big> Check out the '''[https://osm.etsi.org/wikipub/index.php/Release_notes_and_whitepapers OSM Release Notes, White Papers]''', '''[https://osm.etsi.org/wikipub/index.php/OSM_workshops_and_events Workshops, Events]''' and '''[http://www.youtube.com/c/OpenSourceMANO YouTube Channel]''' </big><br />
|}<br />
<br />
{|<br />
|[[File:open-bw.png|100px|left|top|link=https://osm.etsi.org/wikipub/index.php/Engage]] <br />
||[[File:Space.png|20px]] <br />
|<big> '''[[Engage]]''' with the OSM Community. We are '''OPEN'''! </big><br />
|}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Release_SIX_Documentation&diff=4776OSM Release SIX Documentation2019-09-18T11:08:20Z<p>Ramonsalguer: </p>
<hr />
<div>[[File:7th_OSM_Hack.png|320px|right|top|link=https://osm.etsi.org/wikipub/index.php/7th_OSM_Hackfest]] <br />
<br />
== Release SIX Quickstart ==<br />
* In order to get started quickly and get familiar with the most common operations, you can refer to the [[OSM_Release_SIX | Release SIX Quickstart page]].<br />
<br />
== VNF and NS examples ==<br />
* [[Examples from OSM Hackfests]]<br />
<br />
== Onboarding your own VNF and NS ==<br />
* '''[http://osm-download.etsi.org/ftp/Documentation/vnf-onboarding-guidelines VNF Onboarding Guidelines]'''<br />
* [[Creating_your_own_VNF_package | Create your own VNF package]] <br />
* [[Creating_your_own_VNF_charm_(Release_THREE) | Creating your own VNF charm]]<br />
** Some [[Example_VNF_Charms | examples of VNF Charms]] <br />
** [[VNF_Primitives | Default VNF Primitives]] <br />
* [[OSM_Information_Model | OSM Information Model]]<br />
* [[Reference_VNF_and_NS_Descriptors | Information to create VNF and NS Descriptors]]<br />
* [[OSM_Release_FOUR#Using_old_descriptors_from_Release_TWO | How to onboard old Release TWO descriptors]]<br />
<br />
== Specific installation methods ==<br />
* [[How_to_run_OSM_on_Vagrant | How to run OSM on Vagrant]]<br />
* [[How to upgrade the OSM Platform]]<br />
* [[OSM_client#Installation | How to install OSM client separately]]<br />
* [[Advanced OSM installation procedures]]<br />
* [[How to install OSM in Amazon EC2 | How to install OSM in Amazon EC2]]<br />
<br />
== EPA and SDN Assist ==<br />
* [[EPA_and_SDN_assist | How-to guide]]<br />
* [[Openstack_configuration_(Release_FOUR)#Configure_Openstack_for_full_EPA_support_in_OSM | OpenStack configuration for EPA and SDN Assist]]<br />
<br />
== Reference material and self training ==<br />
* [[OSM client]]:<br />
** [[OSM_client#Installation | Installation]]<br />
** [[OSM_client#Usage_(client_commands) | OSM client commands]]<br />
** [[OSM_client#Enable_autocompletion | Enable autocompletion in OSM Client]]<br />
* [[OSM instantiation parameters]]<br />
* Using Monitoring and Autoscaling capabilities:<br />
** [[OSM_Performance_Management | OSM Performance Management]]<br />
** [[OSM_Fault_Management | OSM Fault Management]]<br />
** [[OSM_Autoscaling | OSM Autoscaling]]<br />
* 6th OSM Hackfest - full training material:<br />
** [[5th_OSM_Hackfest#Agenda | Table of contents]]<br />
** [https://osm-download.etsi.org/ftp/osm-5.0-five/6th-hackfest/presentations/ Documentation]<br />
** [https://osm-download.etsi.org/ftp/osm-5.0-five/6th-hackfest/packages/ NS and VNF Packages] and [https://osm-download.etsi.org/ftp/osm-3.0-three/1st-hackfest/images/ VM images]<br />
* [[NBI_API_Description| Description of the OSM North Bound Interface REST API]]<br />
* [[VIM_emulator | How to use the VIM emulator]]<br />
* [[OSM_E2E_tests | Tests to validate VIM capabilities]]<br />
* [[OSM_workshops_and_events | OSM Workshops videos]]<br />
* [[OSM_Technical_Videos | Other technical videos and demos]]<br />
* [[OSM URN Namespace]]<br />
<br />
== Troubleshooting ==<br />
* [[How to know the version of your current OSM installation]]<br />
* [[Common issues and troubleshooting]]<br />
* Have you detected any bug? Check [[How_to_report_issues_(Release_THREE) | this guide]] to see how to report issues.<br />
<br />
== OSM Scope, Features and Integration Guidelines ==<br />
<br />
* [[OSM Scope, Functionality, Operation and Integration Guidelines]]<br />
* [[Release notes and whitepapers]]<br />
<br />
== How to contribute ==<br />
* [https://osm.etsi.org/about/how-to-join Joining the OSM community]<br />
* Developer guides:<br />
** [[Workflow_with_OSM_tools | Workflow with OSM tools (git, gerrit, bugzilla, etc.) (MUST READ for developers)]]<br />
** [[Developer HowTo | Developer how-to (MUST READ for developers)]]<br />
** [[Developer_HowTo_for_RO_Module | Developer how-to for RO]]<br />
**[[How_to_upgrade_the_OSM_Platform#Upgrading_a_specific_component_to_use_your_own_cloned_repo_.28e.g._for_developing_purposes.29 | How to work with your own cloned repo for a specific component]]<br />
* [https://opensourcemano.slack.com/ OSM Slack Workplace]<br />
* Upcoming Hackfests and events:<br />
** [[OSM workshops and events]] <br />
<br />
<br />
{{Feedback}}</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Scope,_Functionality,_Operation_and_Integration_Guidelines&diff=4430OSM Scope, Functionality, Operation and Integration Guidelines2019-04-06T21:44:30Z<p>Ramonsalguer: </p>
<hr />
<div><span style="background:yellow">'''''A more up-to-date version can be found in the [http://osm-download.etsi.org/ftp/Documentation/201902-osm-scope-white-paper EUAG White Paper discussion this topic]'''''</span><br />
<br />
The following guide provides a thorough review os OSM's scope and its functionality, its regular operation, and the guidelines for integration with other platforms.<br />
<br />
==== CHAPTERS ====<br />
<br />
# [[Service Platform view and Layered Service Architectures]]<br />
# [[OSM Scope and Functionality]]<br />
# [[Platform Operation view: management of OSM as Manager Platform]]<br />
# [[OSM Integration Guidelines]]</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_Scope,_Functionality,_Operation_and_Integration_Guidelines&diff=4429OSM Scope, Functionality, Operation and Integration Guidelines2019-04-06T21:43:58Z<p>Ramonsalguer: </p>
<hr />
<div><span style="background:yellow">'''''A more up-to-date version can be found in the [http://osm-download.etsi.org/ftp/Documentation/201902-osm-scope-white-paper EUAG White Paper on this topic]'''''</span><br />
<br />
The following guide provides a thorough review os OSM's scope and its functionality, its regular operation, and the guidelines for integration with other platforms.<br />
<br />
==== CHAPTERS ====<br />
<br />
# [[Service Platform view and Layered Service Architectures]]<br />
# [[OSM Scope and Functionality]]<br />
# [[Platform Operation view: management of OSM as Manager Platform]]<br />
# [[OSM Integration Guidelines]]</div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=File:Alfonso_at_ZTA_2019.jpg&diff=4427File:Alfonso at ZTA 2019.jpg2019-03-29T10:21:44Z<p>Ramonsalguer: </p>
<hr />
<div></div>Ramonsalguerhttps://osm.etsi.org/wikipub/index.php?title=OSM_workshops_and_events&diff=4426OSM workshops and events2019-03-29T10:21:21Z<p>Ramonsalguer: /* OSM Release FIVE Demos */</p>
<hr />
<div>[[File:6hackdate.png|350px|right|top|link=https://osm.etsi.org/wikipub/index.php/6th_OSM_Hackfest]] <br />
<br />
The OSM community regularly gets together to educate, exchange information and to engage with a broad range of people interested in MANO.<br />
<br />
Agendas, registration links, presentations and videos from these sessions can be found on this page.<br />
<br />
== 6th OSM Hackfest @OSM#7, Santa Clara (May 13-17, 2019) ==<br />
Register at [[6th OSM Hackfest]] <br />
<br />
== OSM Workshop @ Zero Touch Automation Congress 2019, Madrid (March 26, 2019) ==<br />
<br />
=== (Re-)introduction to OSM ===<br />
<br />
<small>'''Francisco-Javier Ramón Salguero (Chair ETSI Open Source MANO | Telefónica)'''</small><br />
<br />
[[File:FJ.jpg|600px|top]] <br />
<br />
'''[ [[media:Introduction_to_OSM_ZTA_2019-FJ.pdf|Download Presentation]] ]'''<br />
<br />
=== TSC Perspective. OSM Architecture Overview - Release FIVE and beyond===<br />
<small>'''Vanessa Little (TSC Chair, ETSI Open Source MANO | VMware)'''</small><br />
<br />
[[File:Vanessa.jpg|600px|top]] <br />
<br />
'''[ [[media:TSC_Perspective_ZTA_2019-Vanessa.pdf|Download Presentation]] ]'''<br />
<br />
===VNF Onboarding Task Force===<br />
<small>'''Gianpietro Lavado (VNFONB TF Chair, ETSI Open Source MANO | Whitestack)'''</small><br />
<br />
[[File:Gianpietro.jpg|600px|top]] <br />
<br />
'''[ [[media:VNF_Onboarding_ZTA_2019-Gianpietro.pdf|Download Presentation]] ]'''<br />
<br />
=== OSM in practice===<br />
<small>'''Gerardo Garcia de Blas (TSC, ETSI Open Source MANO | Telefonica)'''</small><br />
<br />
[[File:Gerardo.jpg|600px|top]] <br />
<br />
'''[ [[media:OSM_in_practice_ZTA_2019-Gerardo.pdf|Download Presentation]] ]'''<br />
<br />
=== OSM Release FIVE Demos ===<br />
<small>'''Alfonso Tierno (RO MDL, ETSI Open Source MANO | Telefonica)'''</small><br />
<br />
[[File:Alfonso at ZTA 2019.jpg|600px|top]] <br />
<br />
<small>'''Gianpietro Lavado (VNFONB TF Chair, ETSI Open Source MANO | Whitestack)'''</small><br />
<br />
[[File:Alfonso & Gianpietro.jpg|600px|top]] <br />
<br />
'''[ [[media:OSM_Demos_ZTA_2019-Alfonso&Gianpietro.pdf|Download Presentation]] ]'''<br />
<br />
== OSM Demos @MWC19 Barcelona (25-18 February, 2019) ==<br />
See [[OSM@MWC19]]<br />
<br />
== 5th OSM Hackfest @OSM-MR#6, Barcelona (Feb 4-8, 2019) ==<br />
See [[5th OSM Hackfest]]<br />
<br />
== 4th OSM Hackfest @OSM#6, Palo Alto (Oct 29 - Nov 2, 2018) ==<br />
See [[4th OSM Hackfest]]<br />
<br />
== OSM Workshop @ SDN & NFV World Congress 2018, The Hague (October 10, 2018) ==<br />
<br />
=== (Re-)introduction to OSM ===<br />
<br />
<small>'''Francisco-Javier Ramón Salguero (Chair ETSI Open Source MANO | Telefónica)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=51EKdEnbvHc<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:Introduction_to_OSM_SDN_NFV_WC_2018-FJ.pdf|Download Presentation]] ]'''<br />
<br />
=== TSC Perspective. OSM Architecture Overview & Look Ahead to Rel FIVE ===<br />
<small>'''Vanessa Little (TSC Chair, ETSI Open Source MANO | VMware)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=pGGgy7SYi2E<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:TSC_Perspective_SDN_NFV_WC_2018-Vanessa.pdf|Download Presentation]] ]'''<br />
<br />
=== OSM in practice===<br />
<small>'''Gerardo Garcia de Blas (TSC, ETSI Open Source MANO | Telefonica)'''</small><br />
<br />
<small>'''Gianpietro Lavado (MON MDL, ETSI Open Source MANO | Whitestack)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=kCFxPV67Adw<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:OSM_in_practice_SDN_NFV_WC_2018-Gerardo&Gianpietro.pdf|Download Presentation]] ]'''<br />
<br />
== 3rd OSM Hackfest @OSM-MR#5, Oslo (June 25-29, 2018) ==<br />
See [[3rd OSM Hackfest]]<br />
<br />
== OSM @ OpenStack Summit, Vancouver (May 22, 2018) ==<br />
<br />
=== Building end-to-end NFV with OpenStack and OpensSourceMANO ===<br />
<br />
<small>'''Gianpietro Lavado (MON MDL, ETSI Open Source MANO | Whitestack)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=njTm7T-VNcw<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [https://www.openstack.org/assets/presentation-media/Achieving-end-to-end-NFV-with-OpenStack-and-Open-Source-MANO.pdf Download Presentation] ]'''<br />
<br />
== OSM Workshop @ NFV & Zero-Touch World Congress 2018, San Jose (April 25, 2018) ==<br />
<br />
===Welcome===<br />
<br />
<small>'''Luis Jorge Romero | Director General | ETSI'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=1tvgpOdX_wg<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
<br />
=== (Re-)introduction to OSM ===<br />
<br />
<small>'''Francisco-Javier Ramón Salguero (Chair ETSI Open Source MANO | Telefónica)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=7c5vwa4YYPQ<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
=== TSC Perspective. OSM Architecture and Data Model Overview ===<br />
<small>'''Vanessa Little (TSC, ETSI Open Source MANO | VMware)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=hAdWEoF6H8Y<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
=== OSM End User Advisory Group (Operators) Perspective ===<br />
<small>'''Don Clarke (OSM EUAG | CableLabs)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=3X7AidkliLg<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
=== OSM PoC Framework and Demos===<br />
<small>'''Vanesa Little (TSC, ETSI Open Source MANO | VMware)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=Egp71oSU35M<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
=== OSM Release FOUR Ligthweight Build and Demo ===<br />
<small>'''Gianpietro Lavado (MON MDL, ETSI Open Source MANO | Whitestack)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=KgsaA-HCX40<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
=== AWS in OSM and Public/Private Cloud Use Cases===<br />
<small>'''Shoma Chakravarty (ETSI Open Source MANO | Amazon Web Services)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=-WgBa_i8ZQY<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
=== Closing Remarks ===<br />
<small>'''Francisco-Javier Ramón Salguero (Chair ETSI Open Source MANO | Telefónica)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=lQ5bVfifDFc<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
== OSM Tutorial @OSM#5 Louisville (April 9, 2018) ==<br />
See [[OSM Tutorial]]<br />
<br />
== 2nd OSM Hackfest @ Zero-Touch and Carrier Automation Congress, Madrid (March 21-23, 2018) ==<br />
See [[2nd OSM Hackfest]]<br />
<br />
== OSM Workshop @ Zero-Touch and Carrier Automation Congress, Madrid (March 20, 2018) ==<br />
<br />
=== (Re-)introduction to OSM ===<br />
<small>'''Francisco-Javier Ramón Salguero (Chair ETSI Open Source MANO | Telefónica)'''</small><br />
<br />
This session provides an overview of the OSM community foundation, project, structure. The technical scope and ambition for the project will be described and an overview of the accomplishments that have been delivered with the third OSM release will be provided. <br />
<br />
{{#evu:https://www.youtube.com/watch?v=bG2wawrOqj0<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:Introduction_to_OSM___Zero_Touch_Carrier_Automation_Congress - FJ.pdf|Download Presentation]] ]'''<br />
<br />
=== OSM End User Advisory Group (Operators) Perspective ===<br />
<small>'''Serge Manning (OSM EUAG | Sprint)'''</small><br />
<br />
This session provides a telecom operator perspective on OSM – including a view on the significance of open source and the orchestration space in the industry in general, and the OSM community in particular. The importance of the accomplishments in the latest OSM release, the role OSM can play in standards development and what success over the next six months will look like.<br />
<br />
{{#evu:https://www.youtube.com/watch?v=g-sc7PYkXRw<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:OSM_EUAG_Perspective_for_ZT_Workshop - Serge.pdf|Download Presentation]] ]'''<br />
<br />
=== TSC Perspective. OSM Architecture and Data Model Overview ===<br />
<small>'''Vanessa Little (TSC, ETSI Open Source MANO | VMware)'''</small><br />
<br />
This session provides an overview of the OSM architecture, the functional split in the modules, the mapping between OSM and the ETSI NFV MANO logical view. It also provides an overview of the OSM data models for the VNF Descriptor (VNFD) and the Network Service Descriptors (NSD) and how some of the salient attributes are handled in OSM.<br />
<br />
{{#evu:https://www.youtube.com/watch?v=kyrjNrdmo_c<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:OSM_Architecture_and_Data_Models - Vanessa.pdf|Download Presentation]] ]'''<br />
<br />
=== Using OSM: VNF/NS On-boarding and instantiation ===<br />
<small>'''Gerardo Garcia de Blas (TSC, ETSI Open Source MANO | Telefonica)'''</small><br />
<br />
This session will focus on demonstrating the OSM User Interface, including VNF package creation, on-boarding capabilities and the new functionality enabled in OSM Release THREE.<br />
<br />
{{#evu:https://www.youtube.com/watch?v=Vu2HYN1PVJw<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
=== OSM CI/CD and Remote Labs network ===<br />
<small>'''Silvia Almagia (ETSI Open Source MANO | ETSI)'''</small><br />
<br />
This session will provide an overview of the OSM CI/CD pipeline, and how OSM is leveraging the Hub for Interoperability and Validation at ETSI (HIVE) to build a network of Remote Labs allowing for a DevOps approach that combines system and automated interoperability testing with 3rd party NFV solutions.<br />
<br />
{{#evu:https://www.youtube.com/watch?v=dQZeNbHWalM<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:OSM CI-CD and Remote Labs network - Silvia.pdf|Download Presentation]] ]'''<br />
<br />
<br />
=== Day-0, day-1 and day-2 configuration in OSM ===<br />
<small>'''Gerardo Garcia de Blas (TSC, ETSI Open Source MANO | Telefonica)'''</small><br />
<br />
This session will provide an overview of the different enablers in OSM to automate VNF configuration at the different operation stages.<br />
<br />
{{#evu:https://www.youtube.com/watch?v=vteNtXmszFw<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:day-1_and_day-2_configuration_in_OSM___Zero_Touch_Car - Gerardo.pdf|Download Presentation]] ]'''<br />
<br />
=== OSM PoC Framework and POC with OSM with VMware Integrated Openstack in MEC architectures===<br />
<small>'''Vanesa Little (TSC, ETSI Open Source MANO | VMware)'''</small><br />
<br />
This session will provide an overview of the OSM POC framework, and how to create an official OSM POC that will be endorsed by the community.<br />
<br />
The latest OSM POC, OSM Release 3 with VMware Integrated Openstack with MEC architectures. This POC will showcase leveraging OSM as an orchestrator to deploy and maintain edge services in several different use cases that make use of the same hardware footprint, as well as discuss the overall infrastructure topology. These use cases include video transcode at the network Edge with ffmpeg, using Fortinet as an sGW in vRAN edge scenarios, SD-WAN with Vyatta vRouter and operational intelligence for distributed architectures.<br />
<br />
{{#evu:<br />
https://www.youtube.com/watch?v=WUxP5_Sr23I<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
'''[ [[media:POC_Framework_and_Demo - Vanessa.pdf|Download Presentation]] ]'''<br />
<br />
<br />
=== OSM Demos 1) EPA capabilities; 2) Day-0, day-1 and day-2 configuration ===<br />
<small>'''Gerardo Garcia de Blas (TSC, ETSI Open Source MANO | Telefonica)'''</small><br />
<br />
This session will illustrate two of the most interesting features of OSM: firstly, the support of data-plane VNFs requesting EPA capabilities, and secondly the built-in automation of VNF configuration.<br />
<br />
{{#evu:<br />
https://www.youtube.com/watch?v=06NQqouRjV8<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
=== Closing Remarks ===<br />
<small>'''Francisco-Javier Ramón Salguero (Chair ETSI Open Source MANO | Telefónica)'''</small><br />
<br />
{{#evu:https://www.youtube.com/watch?v=jc1pxEzEH6w<br />
|alignment=inline<br />
|dimensions="120"<br />
}}<br />
<br />
== OSM Tutorial @OSM-MR#4 Rome (Feb 5, 2018) ==<br />
See [[OSM Tutorial]]<br />
<br />
<br />
== 1st OSM Hackfest @ 2nd ETSI NFV Plugtests, Sophia Antipolis (January 15-19, 2018) ==<br />
See [[1st OSM Hackfest]]<br />
<br />
== OSM Workshop @ SDN & NFV World Congress 2017, The Hague (October, 2017) ==<br />
<br />
See [[OSM Workshop @SDN NVF World Congress 2017, The Hague]]<br />
<br />
== OSM Workshop @ NFV World Congress 2017, San Jose (May 2, 2017) ==<br />
See [[OSM Workshop @NFV World Congress 2017, San Jose]]<br />
<br />
== MPLS+SDN+NFV World (March 2017) ==<br />
<br />
See [[OSM@MPLS + SDN + NFV World, Paris (March 2017)]]<br />
<br />
== SDN World Congress (October 2016) ==<br />
<br />
See [[OSM Workshop @SDN World Congress 2016, The Hague]]<br />
<br />
== NFV World Congress (April 2016) ==<br />
<br />
See [http://play.webvideocore.net/popplayer.php?it=8epou4jdvs4k NFV World Congress 2016 (San José, April 2016) - Keynote]<br />
<br />
== Layer 123 Webinar (March 2016) ==<br />
<br />
See [https://www.brighttalk.com/webcast/6985/198141?utm_campaign=LinkedIn&utm_content=&utm_source=brighttalk-sharing&utm_medium=web&utm_term Layer 123 Webinar (March 2016): Introducing OSM – Open Source MANO for NFV]<br />
<br />
== ONS (March 2016) ==<br />
<br />
See [[OSM@ONS16]]<br />
<br />
== MWC 16 (February 2016) ==<br />
See [[OSM@MWC16]]<br />
<br />
<br />
<br />
{{Feedback}}</div>Ramonsalguer