Developer HowTo for RO Module - Revision history

Ramonsalguer at 17:22, 17 February 2021

2021-02-17T17:22:30Z

← Older revision		Revision as of 17:22, 17 February 2021
Line 1:		Line 1:
			'''THIS PAGE IS DEPRECATED'''. OSM Developer Guide has been moved to a new location: '''https://osm.etsi.org/docs/developer-guide/'''

			---

	==Getting Started==		==Getting Started==
	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.		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.

Calvinosanch: /* Creating a new VIM plugin */

2019-08-16T13:07:50Z

Creating a new VIM plugin

← Older revision		Revision as of 13:07, 16 August 2019
Line 267:		Line 267:
	logger.debug("{}".format(network_list))		logger.debug("{}".format(network_list))
	self.assertIsNotNone(network_list)		self.assertIsNotNone(network_list)

			The script could be used to launch tests against the vim connector directly with the following syntax:

			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>

			Next you can find the tests that could be executed:

			test_vimconn_connect
			test_vimconn_delete_network
			test_vimconn_get_image_list
			test_vimconn_get_network
			test_vimconn_new_flavor
			test_vimconn_new_network
			test_vimconn_new_vminstance

			Also, the script could be used to launch tests against the RO with the following syntax:

			python ./test/test_RO.py deploy -d <VIM_ACCOUNT_NAME> -n <MGMT_NET_IN_VIM> -i <IMAGE_FOR_VMs> --tests <TEST_NAME>

			Next you can find the tests that could be executed:

			v3_2vdu_set_ip_mac
			simple_multi_vnfc
			simple_linux

Calvinosanch: /* Creating a new VIM plugin */

2019-08-12T07:24:20Z

Creating a new VIM plugin

← Older revision		Revision as of 07:24, 12 August 2019
Line 258:		Line 258:

	self.__class__.test_index += 1		self.__class__.test_index += 1
	if test_config['vimtype'] == 'vmware':		if '''test_config['vimtype'] == 'vmware':'''
	vca_object = test_config["vim_conn"].connect()		vca_object = test_config["vim_conn"].connect()
	logger.debug("{}".format(vca_object))		logger.debug("{}".format(vca_object))

Calvinosanch: /* Creating a new VIM plugin */

2019-08-12T07:23:49Z

Creating a new VIM plugin

← Older revision		Revision as of 07:23, 12 August 2019
Line 262:		Line 262:
	logger.debug("{}".format(vca_object))		logger.debug("{}".format(vca_object))
	self.assertIsNotNone(vca_object)		self.assertIsNotNone(vca_object)
	elif test_config['vimtype'] == 'openstack':		elif '''test_config['vimtype'] == 'openstack':'''
	test_config["vim_conn"]._reload_connection()		test_config["vim_conn"]._reload_connection()
	network_list = test_config["vim_conn"].get_network_list()		network_list = test_config["vim_conn"].get_network_list()
	logger.debug("{}".format(network_list))		logger.debug("{}".format(network_list))
	self.assertIsNotNone(network_list)		self.assertIsNotNone(network_list)

Calvinosanch: /* Creating a new VIM plugin */

2019-08-12T07:23:02Z

Creating a new VIM plugin

← Older revision		Revision as of 07:23, 12 August 2019
Line 240:		Line 240:
	# 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		# 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
	./test/test_RO.py vimconn --help		./test/test_RO.py vimconn --help

			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:

			def test_vimconnector(args):
			global test_config
			sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + "/osm_ro")
			test_config['vimtype'] = args.vimtype
			if args.vimtype == "aws":
			import vimconn_aws as vim

			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:

			def test_000_connect(self):
			self.__class__.test_text = "{}.{}. TEST {}".format(test_config["test_number"],
			self.__class__.test_index,
			inspect.currentframe().f_code.co_name)

			self.__class__.test_index += 1
			if test_config['vimtype'] == 'vmware':
			vca_object = test_config["vim_conn"].connect()
			logger.debug("{}".format(vca_object))
			self.assertIsNotNone(vca_object)
			elif test_config['vimtype'] == 'openstack':
			test_config["vim_conn"]._reload_connection()
			network_list = test_config["vim_conn"].get_network_list()
			logger.debug("{}".format(network_list))
			self.assertIsNotNone(network_list)

Calvinosanch: /* Creating a new VIM plugin */

2019-08-09T07:46:17Z

Creating a new VIM plugin

← Older revision		Revision as of 07:46, 9 August 2019
Line 224:		Line 224:
	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.		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.

	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 ~~toOSM~~]] and [[Configuring AWS for OSM Release TWO#Add AWS to OSM]] for examples		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

	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".		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".

Calvinosanch: /* Creating a new VIM plugin */

2019-08-09T07:45:33Z

Creating a new VIM plugin

← Older revision		Revision as of 07:45, 9 August 2019
Line 224:		Line 224:
	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.		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.

	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 ~~(Release FIVE)~~#Add openstack toOSM]] and [[Configuring AWS for OSM Release TWO#Add AWS to OSM]] for examples		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 toOSM]] and [[Configuring AWS for OSM Release TWO#Add AWS to OSM]] for examples

	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".		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".

Calvinosanch: /* Creating a new VIM plugin */

2019-08-09T07:43:32Z

Creating a new VIM plugin

← Older revision		Revision as of 07:43, 9 August 2019
Line 222:		Line 222:
	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.		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.

	DO NOT change the method names, parameters or parameter content. ~~ROuse~~ the same methods for all the VIMs and they cannot be changed to accomodate VIM specifics. VIM specifics must be solved inside the connector.		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.

	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 ~~ROat~~ the methods that form part of the VIM configuration. See [[Openstack configuration (Release FIVE)#Add openstack toOSM]] and [[Configuring AWS for OSM Release TWO#Add AWS to OSM]] for examples		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 (Release FIVE)#Add openstack toOSM]] and [[Configuring AWS for OSM Release TWO#Add AWS to OSM]] for examples

	For integration with the main project, it is needed to add the new ~~vitype~~ to dictionary "vim_module" at file "osm_ro/vim_thread.py".		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".

	openmano tenant-create osm # if not already done		openmano tenant-create osm # if not already done

Tierno at 10:29, 22 March 2019

2019-03-22T10:29:13Z

← Older revision		Revision as of 10:29, 22 March 2019
Line 1:		Line 1:
	==Getting Started==		==Getting Started==
	The RO Module 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.		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.

	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		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
Line 20:		Line 20:

	==Programming Language==		==Programming Language==
	The RO module uses Python2. However Python3 conventions for a ~~possible~~ future migration ~~should~~ be used as far as possible. For example:		The RO module uses Python2. However Python3 conventions for a future migration must be used as far as possible. For example:

	{\| class="wikitable"		{\| class="wikitable"
Line 45:		Line 45:

	==Code Style==		==Code Style==
	Please follow PEP8 style guide for all the Python code.		Please follow PEP8 style guide for all the Python code. Lines up to 120 length

	===Logging===		===Logging===
Line 222:		Line 222:
	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.		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.

	DO NOT change the method names, parameters or parameter content. ~~Openmano use~~ the same methods for all the VIMs and they cannot be changed to accomodate VIM specifics. VIM specifics must be solved inside the connector.		DO NOT change the method names, parameters or parameter content. ROuse the same methods for all the VIMs and they cannot be changed to accomodate VIM specifics. VIM specifics must be solved inside the connector.

	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 ~~openmano at~~ the methods that form part of the VIM configuration. See [[Openstack configuration (Release ~~TWO~~)#Add openstack toOSM]] and [[Configuring AWS for OSM Release TWO#Add AWS to OSM]] for examples		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 ROat the methods that form part of the VIM configuration. See [[Openstack configuration (Release FIVE)#Add openstack toOSM]] and [[Configuring AWS for OSM Release TWO#Add AWS to OSM]] for examples

	~~Integration~~ with the main project is ~~automatic, just create a~~ new ~~datacenter of type XXX and this module will be automatically loaded~~. ~~No other module of the main program need to be updated~~.		For integration with the main project, it is needed to add the new vitype to dictionary "vim_module" at file "osm_ro/vim_thread.py".

	openmano tenant-create osm # if not already done		openmano tenant-create osm # if not already done
	export OPENMANO_TENANT=osm		export OPENMANO_TENANT=osm
	openmano datacenter-create <vim-name> <access-URL> --type=XXX --config <specific config>		openmano datacenter-create <vim-name> <access-URL> --type=XXX --config <specific config>
	# if fails the cause can be a ~~librery~~ you need not installed or an error upon importing. Try tho import it in a python client		# 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
	# example of <specific config> text: "{dataplane_physical_net: physnet_sriov, port_security_enabled: False}"		# example of <specific config> text: "{dataplane_physical_net: physnet_sriov, port_security_enabled: False}"
	openmano datacenter-attach <vim-name> --vim-tenant-name=<tenant-to-use-by-openmano> --user=<tenant-user> --password=<tenant-password>		openmano datacenter-attach <vim-name> --vim-tenant-name=<tenant-to-use-by-openmano> --user=<tenant-user> --password=<tenant-password>

Tierno: /* Database changes */

2018-03-05T17:14:27Z

Database changes

← Older revision		Revision as of 17:14, 5 March 2018
Line 136:		Line 136:

	==Database changes==		==Database changes==
	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 ~~this~~ steps:		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:

	1. openmanod: increment __version__, version_date and database_version		1. openmanod: increment __version__, version_date and database_version

	2. database_utils/migrate_mano_db.sh. See the three "TODO"		2. database_utils/migrate_mano_db.sh. See the three "TODO"

	2a. Increment LAST_DB_VERSION		2a. Increment LAST_DB_VERSION

	2b. Annotate a comment to have a track of versions: [ $OPENMANO_VER_NUM -ge 50XX ] && DB_VERSION=XX #0.5.XX => XX		2b. Annotate a comment to have a track of versions: [ $OPENMANO_VER_NUM -ge 50XX ] && DB_VERSION=XX #0.5.XX => XX
	3c. 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.
			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.

	Test several upgrades/downgrades to version 20 with "migrate_mano_db.sh" and "migrate_mano_db.sh 20"		Test several upgrades/downgrades to version 20 with "migrate_mano_db.sh" and "migrate_mano_db.sh 20"




	==Package dependency osm-im==		==Package dependency osm-im==