diff --git a/03-developer-how-to-for-modules.md b/03-developer-how-to-for-modules.md index b069b6de524d86d1f8fa539d25eac06105596392..2db0483ec54530d21e9c820691eda81e14483e74 100644 --- a/03-developer-how-to-for-modules.md +++ b/03-developer-how-to-for-modules.md @@ -557,3 +557,32 @@ Creating a new SDN plugin is quite easy following these steps: `update_of_flows` 1. (Suggested): Modify the value of `switch_port` and `switch_dpid` at every fake compute nodes descriptors at `/test/hosts/host-example?.json` and insert real values 2. or: Modify the file `openvim/database_utils/of_ports_pci_correspondence.sql` and change the names `port?/?` by valid names obtained with `openflow port-list` (the physical port names) 3. Run the script (to be completed) for testing. Openflow rules must appear at the openflow controller, and all the networks must be ACTIVE (not ERROR) (see with `openvim net-list`) + +## Developer Guide for OSM client + +### Getting Started + +TODO: fill in + +### Installation procedure + +```bash +# Ubuntu 18.04 pre-requirements +sudo apt-get install python3-pip libcurl4-openssl-dev libssl-dev +# Centos pre-requirements: +# sudo yum install python3-pip libcurl-devel gnutls-devel +sudo -H python3 -m pip install python-magic +# Install OSM Information model +sudo -H python3 -m pip install git+https://osm.etsi.org/gerrit/osm/IM --upgrade +# Clone the osmclient repo and install OSM client from the git repo. +git clone https://osm.etsi.org/gerrit/osm/osmclient +cd osmclient +python3 -m pip install --user -e . +# logout and login so that PATH can be updated. Executable osm will be found in /home/ubuntu/.local/bin +``` + +To uninstall, just: + +```bash +python3 -m pip uninstall osmclient +```