Release ONE HowTo guide for users
From OSM Public Wiki
This wiki page is under development. It contains some of the common tasks done in OSM.
Adding datacenters/VIMs
Three kind of datacenters are currently supported by OSM:
- OpenVIM
- OpenStack
- VMware vCloud Director
The following instructions are required to be executed in the host to add each kind of datacenter
- OpenVIM DC (e.g. IP address: 10.10.10.10, VIM tenant "osm")
lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-create --type openvim --description "Openvim Datacenter" openvim-site http://10.10.10.10:9080/openvim lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-attach openvim-site --vim-tenant-name=osm lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-list
- OpenStack DC (e.g. IP address: 10.10.10.11, VIM tenant "admin", user "admin", password "userpwd")
lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-create --type openstack --description "OpenStack Datacenter" openstack-site http://10.10.10.11:5000/v2.0 lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-attach openstack-site --user=admin --password=userpwd --vim-tenant-name=admin lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-list
- VMware DC (e.g. IP address: 10.10.10.12, VIM tenant "vmware-tenant", user "osm", password "osm4u", admin user "admin", admin password "adminpwd")
lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-create --type vmware --description "vmWare Datacenter" --config '{admin_password: adminpwd, admin_username: admin}' vmware-site https://10.10.10.12 lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-attach vmware-site --user=osm --password=osm4u --vim-tenant-name=vmware-tenant lxc exec RO --env OPENMANO_TENANT=osm -- openmano datacenter-list
Note: It is needed to match the name of the datacenter "vmware-site" to the name of the organization of "vCloud Director". Inside this organization the tenant "vmware-tenant" must exist
Adding VNF and NS to the catalog
You can use the UI to onboard VNF and NS to the catalog. VNF and NS packages can be found in the URLs below:
- VNF packages: https://osm-download.etsi.org/ftp/osm-1.0-one/vnf-packages
- NS packages: https://osm-download.etsi.org/ftp/osm-1.0-one/ns-packages
Creating your own VNF packages
VNF without primitives
You can use the form in this web page, or use the CLI tool. In order to use the CLI tool, follow these instructions:
- Clone the descriptor-packages repo:
git clone https://osm.etsi.org/gerrit/osm/descriptor-packages
- Run the following command to create a folder with all the files required for a single-VM VNF package:
./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd --image <IMAGE_PATH> -c <VNF_NAME>
- A folder called <VNF_NAME>_vnfd will be created with all the files required for a VNF package.
- Edit the file <VNF_NAME>_vnfd.yaml.
- Once done, you can generate the tar.gz VNF package with the command:
./descriptor-packages/src/generate_descriptor_pkg.sh -t vnfd -N <VNF_NAME>_vnfd #Note: the argument -N is optional and is intended to keep the package files after creating the package
VNF with primitives
(Under elaboration) You will have to create a proxy charm for the VNF. You can follow the general instructions below:
- Clone the descriptor-packages repo:
git clone https://osm.etsi.org/gerrit/osm/juju-charms
- ...