X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=vimconn.py;h=cd529de82d211dc51089ab1ce119b3497c14eda4;hb=ed1be4b1591c258748261f21947dc388c28c6fd9;hp=7ae33592c8917e63d0aadafc6558c442921be4f0;hpb=c78233e1750d5d231e99ffedb5ba81014f84e6fe;p=osm%2FRO.git diff --git a/vimconn.py b/vimconn.py index 7ae33592..cd529de8 100644 --- a/vimconn.py +++ b/vimconn.py @@ -28,6 +28,8 @@ vimconn implement an Abstract class for the vim connector plugins __author__="Alfonso Tierno" __date__ ="$16-oct-2015 11:09:29$" +import logging + #Error variables HTTP_Bad_Request = 400 HTTP_Unauthorized = 401 @@ -35,18 +37,52 @@ HTTP_Not_Found = 404 HTTP_Method_Not_Allowed = 405 HTTP_Request_Timeout = 408 HTTP_Conflict = 409 +HTTP_Not_Implemented = 501 HTTP_Service_Unavailable = 503 HTTP_Internal_Server_Error = 500 -class vimconnectorException(Exception): - pass +class vimconnException(Exception): + '''Common and base class Exception for all vimconnector exceptions''' + def __init__(self, message, http_code=HTTP_Bad_Request): + Exception.__init__(self, message) + self.http_code = http_code + +class vimconnConnectionException(vimconnException): + '''Connectivity error with the VIM''' + def __init__(self, message, http_code=HTTP_Service_Unavailable): + vimconnException.__init__(self, message, http_code) + +class vimconnUnexpectedResponse(vimconnException): + '''Get an wrong response from VIM''' + def __init__(self, message, http_code=HTTP_Service_Unavailable): + vimconnException.__init__(self, message, http_code) + +class vimconnAuthException(vimconnException): + '''Invalid credentials or authorization to perform this action over the VIM''' + def __init__(self, message, http_code=HTTP_Unauthorized): + vimconnException.__init__(self, message, http_code) + +class vimconnNotFoundException(vimconnException): + '''The item is not found at VIM''' + def __init__(self, message, http_code=HTTP_Not_Found): + vimconnException.__init__(self, message, http_code) + +class vimconnConflictException(vimconnException): + '''There is a conflict, e.g. more item found than one''' + def __init__(self, message, http_code=HTTP_Conflict): + vimconnException.__init__(self, message, http_code) + +class vimconnNotImplemented(vimconnException): + '''The method is not implemented by the connected''' + def __init__(self, message, http_code=HTTP_Not_Implemented): + vimconnException.__init__(self, message, http_code) class vimconnector(): '''Abstract base class for all the VIM connector plugins - These plugins must implement a vimconnector class deribed from this + These plugins must implement a vimconnector class derived from this and all these methods ''' - def __init__(self, uuid, name, tenant_id, tenant_name, url, url_admin=None, user=None, passwd=None,debug=True,config={}): + def __init__(self, uuid, name, tenant_id, tenant_name, url, url_admin=None, user=None, passwd=None, log_level=None, config={}): self.id = uuid self.name = name self.url = url @@ -56,7 +92,11 @@ class vimconnector(): self.user = user self.passwd = passwd self.config = config - self.debug = debug + self.logger = logging.getLogger('openmano.vim') + if log_level: + self.logger.setLevel( getattr(logging, log_level) ) + if not self.url_admin: #try to use normal url + self.url_admin = self.url def __getitem__(self,index): if index=='tenant_id': @@ -99,41 +139,36 @@ class vimconnector(): self.url_admin = value else: raise KeyError("Invalid key '%s'" %str(index)) - - def new_host(self, host_data): - '''Adds a new host to VIM''' - '''Returns status code of the VIM response''' - raise NotImplementedError( "Should have implemented this" ) - - def new_external_port(self, port_data): - '''Adds a external port to VIM''' - '''Returns the port identifier''' - raise NotImplementedError( "Should have implemented this" ) - - def new_external_network(self,net_name,net_type): - '''Adds a external network to VIM (shared)''' - '''Returns the network identifier''' - raise NotImplementedError( "Should have implemented this" ) - - def connect_port_network(self, port_id, network_id, admin=False): - '''Connects a external port to a network''' - '''Returns status code of the VIM response''' - raise NotImplementedError( "Should have implemented this" ) def new_tenant(self,tenant_name,tenant_description): - '''Adds a new tenant to VIM''' - '''Returns the tenant identifier''' - raise NotImplementedError( "Should have implemented this" ) + '''Adds a new tenant to VIM with this name and description, + returns the tenant identifier''' + raise vimconnNotImplemented( "Should have implemented this" ) def delete_tenant(self,tenant_id,): '''Delete a tenant from VIM''' '''Returns the tenant identifier''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) - def new_tenant_network(self,net_name,net_type): - '''Adds a tenant network to VIM''' - '''Returns the network identifier''' - raise NotImplementedError( "Should have implemented this" ) + def get_tenant_list(self, filter_dict={}): + '''Obtain tenants of VIM + filter_dict can contain the following keys: + name: filter by tenant name + id: filter by tenant uuid/id + + Returns the tenant list of dictionaries: + [{'name':', 'id':', ...}, ...] + ''' + raise vimconnNotImplemented( "Should have implemented this" ) + + def new_network(self,net_name, net_type, ip_profile=None, shared=False): + '''Adds a tenant network to VIM + net_name is the name + net_type can be 'bridge','data'.'ptp'. TODO: this need to be revised + ip_profile is a dict containing the IP parameters of the network + shared is a boolean + Returns the network identifier''' + raise vimconnNotImplemented( "Should have implemented this" ) def get_network_list(self, filter_dict={}): '''Obtain tenant networks of VIM @@ -144,62 +179,108 @@ class vimconnector(): tenant_id: tenant admin_state_up: boolean status: 'ACTIVE' - Returns the network list of dictionaries + Returns the network list of dictionaries: + [{}, ...] + List can be empty ''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) - def get_tenant_network(self, net_id, tenant_id=None): - '''Obtain tenant networks of VIM''' - '''Returns the network information from a network id''' - raise NotImplementedError( "Should have implemented this" ) + def get_network(self, net_id): + '''Obtain network details of net_id VIM network' + Return a dict with the fields at filter_dict (see get_network_list) plus some VIM specific>}, ...]''' + raise vimconnNotImplemented( "Should have implemented this" ) - def delete_tenant_network(self, net_id): - '''Deletes a tenant network from VIM''' - '''Returns the network identifier''' - raise NotImplementedError( "Should have implemented this" ) + def delete_network(self, net_id): + '''Deletes a tenant network from VIM, provide the network id. + Returns the network identifier or raise an exception''' + raise vimconnNotImplemented( "Should have implemented this" ) - def refresh_tenant_network(self, net_id): - '''Refreshes the status of the tenant network''' - '''Returns: 0 if no error, - <0 if error''' - raise NotImplementedError( "Should have implemented this" ) + def refresh_nets_status(self, net_list): + '''Get the status of the networks + Params: the list of network identifiers + Returns a dictionary with: + net_id: #VIM id of this network + status: #Mandatory. Text with one of: + # DELETED (not found at vim) + # VIM_ERROR (Cannot connect to VIM, VIM response error, ...) + # OTHER (Vim reported other status not understood) + # ERROR (VIM indicates an ERROR status) + # ACTIVE, INACTIVE, DOWN (admin down), + # BUILD (on building process) + # + error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR + vim_info: #Text with plain information obtained from vim (yaml.safe_dump) - def get_tenant_flavor(self, flavor_id): + ''' + raise vimconnNotImplemented( "Should have implemented this" ) + + def get_flavor(self, flavor_id): '''Obtain flavor details from the VIM - Returns the flavor dict details + Returns the flavor dict details {'id':<>, 'name':<>, other vim specific } #TODO to concrete ''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) - def new_tenant_flavor(self, flavor_data): - '''Adds a tenant flavor to VIM''' - '''Returns the flavor identifier''' - raise NotImplementedError( "Should have implemented this" ) + def new_flavor(self, flavor_data): + '''Adds a tenant flavor to VIM + flavor_data contains a dictionary with information, keys: + name: flavor name + ram: memory (cloud type) in MBytes + vpcus: cpus (cloud type) + extended: EPA parameters + - numas: #items requested in same NUMA + memory: number of 1G huge pages memory + paired-threads|cores|threads: number of paired hyperthreads, complete cores OR individual threads + interfaces: # passthrough(PT) or SRIOV interfaces attached to this numa + - name: interface name + dedicated: yes|no|yes:sriov; for PT, SRIOV or only one SRIOV for the physical NIC + bandwidth: X Gbps; requested guarantee bandwidth + vpci: requested virtual PCI address + disk: disk size + is_public: + + + + #TODO to concrete + Returns the flavor identifier''' + raise vimconnNotImplemented( "Should have implemented this" ) - def delete_tenant_flavor(self,flavor_id): - '''Deletes a tenant flavor from VIM''' - '''Returns the HTTP response code and a message indicating details of the success or fail''' - raise NotImplementedError( "Should have implemented this" ) + def delete_flavor(self, flavor_id): + '''Deletes a tenant flavor from VIM identify by its id + Returns the used id or raise an exception''' + raise vimconnNotImplemented( "Should have implemented this" ) - def new_tenant_image(self,image_dict): + def new_image(self,image_dict): ''' Adds a tenant image to VIM Returns: 200, image-id if the image is created <0, message if there is an error ''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) - def delete_tenant_image(self, image_id): + def delete_image(self, image_id): '''Deletes a tenant image from VIM''' '''Returns the HTTP response code and a message indicating details of the success or fail''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) + + def get_image_id_from_path(self, path): + '''Get the image id from image path in the VIM database. Returns the image_id''' + raise vimconnNotImplemented( "Should have implemented this" ) - def new_tenant_vminstancefromJSON(self, vm_data): - '''Adds a VM instance to VIM''' - '''Returns the instance identifier''' - raise NotImplementedError( "Should have implemented this" ) + def get_image_list(self, filter_dict={}): + '''Obtain tenant images from VIM + Filter_dict can be: + name: image name + id: image uuid + checksum: image checksum + location: image path + Returns the image list of dictionaries: + [{}, ...] + List can be empty + ''' + raise vimconnNotImplemented( "Should have implemented this" ) - def new_tenant_vminstance(self,name,description,start,image_id,flavor_id,net_list): + def new_vminstance(self,name,description,start,image_id,flavor_id,net_list,cloud_config=None): '''Adds a VM instance to VIM Params: start: indicates if VM must start or boot in pause mode. Ignored @@ -213,64 +294,115 @@ class vimconnector(): use: 'data', 'bridge', 'mgmt' type: 'virtual', 'PF', 'VF', 'VFnotShared' vim_id: filled/added by this function + cloud_config: can be a text script to be passed directly to cloud-init, + or an object to inject users and ssh keys with format: + key-pairs: [] list of keys to install to the default user + users: [{ name, key-pairs: []}] list of users to add with their key-pair #TODO ip, security groups Returns >=0, the instance identifier <0, error_text ''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) - def get_tenant_vminstance(self,vm_id): + def get_vminstance(self,vm_id): '''Returns the VM instance information from VIM''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) - def delete_tenant_vminstance(self, vm_id): + def delete_vminstance(self, vm_id): '''Removes a VM instance from VIM''' '''Returns the instance identifier''' - raise NotImplementedError( "Should have implemented this" ) - - def refresh_tenant_vms_and_nets(self, vmDict, netDict): - '''Refreshes the status of the dictionaries of VM instances and nets passed as arguments. It modifies the dictionaries''' - '''Returns: - - result: 0 if all elements could be refreshed (even if its status didn't change) - n>0, the number of elements that couldn't be refreshed, - <0 if error (foreseen) - - error_msg: text with reference to possible errors + raise vimconnNotImplemented( "Should have implemented this" ) + + def refresh_vms_status(self, vm_list): + '''Get the status of the virtual machines and their interfaces/ports + Params: the list of VM identifiers + Returns a dictionary with: + vm_id: #VIM id of this Virtual Machine + status: #Mandatory. Text with one of: + # DELETED (not found at vim) + # VIM_ERROR (Cannot connect to VIM, VIM response error, ...) + # OTHER (Vim reported other status not understood) + # ERROR (VIM indicates an ERROR status) + # ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running), + # CREATING (on building process), ERROR + # ACTIVE:NoMgmtIP (Active but any of its interface has an IP address + # + error_msg: #Text with VIM error message, if any. Or the VIM connection ERROR + vim_info: #Text with plain information obtained from vim (yaml.safe_dump) + interfaces: + - vim_info: #Text with plain information obtained from vim (yaml.safe_dump) + mac_address: #Text format XX:XX:XX:XX:XX:XX + vim_net_id: #network id where this interface is connected + vim_interface_id: #interface/port VIM id + ip_address: #null, or text with IPv4, IPv6 address ''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) - def action_tenant_vminstance(self, vm_id, action_dict): - '''Send and action over a VM instance from VIM''' - '''Returns the status''' - raise NotImplementedError( "Should have implemented this" ) + def action_vminstance(self, vm_id, action_dict): + '''Send and action over a VM instance from VIM + Returns the vm_id if the action was successfully sent to the VIM''' + raise vimconnNotImplemented( "Should have implemented this" ) + + def get_vminstance_console(self,vm_id, console_type="vnc"): + ''' + Get a console for the virtual machine + Params: + vm_id: uuid of the VM + console_type, can be: + "novnc" (by default), "xvpvnc" for VNC types, + "rdp-html5" for RDP types, "spice-html5" for SPICE types + Returns dict with the console parameters: + protocol: ssh, ftp, http, https, ... + server: usually ip address + port: the http, ssh, ... port + suffix: extra text, e.g. the http path and query string + ''' + raise vimconnNotImplemented( "Should have implemented this" ) +#NOT USED METHODS in current version + def host_vim2gui(self, host, server_dict): '''Transform host dictionary from VIM format to GUI format, and append to the server_dict ''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) def get_hosts_info(self): '''Get the information of deployed hosts Returns the hosts content''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) def get_hosts(self, vim_tenant): '''Get the hosts and deployed instances Returns the hosts content''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) def get_processor_rankings(self): '''Get the processor rankings in the VIM database''' - raise NotImplementedError( "Should have implemented this" ) + raise vimconnNotImplemented( "Should have implemented this" ) - def get_image_id_from_path(self, path): - '''Get the image id from image path in the VIM database''' - '''Returns: - 0,"Image not found" if there are no images with that path - 1,image-id if there is one image with that path - <0,message if there was an error (Image not found, error contacting VIM, more than 1 image with that path, etc.) - ''' - raise NotImplementedError( "Should have implemented this" ) - + def new_host(self, host_data): + '''Adds a new host to VIM''' + '''Returns status code of the VIM response''' + raise vimconnNotImplemented( "Should have implemented this" ) + + def new_external_port(self, port_data): + '''Adds a external port to VIM''' + '''Returns the port identifier''' + raise vimconnNotImplemented( "Should have implemented this" ) + def new_external_network(self,net_name,net_type): + '''Adds a external network to VIM (shared)''' + '''Returns the network identifier''' + raise vimconnNotImplemented( "Should have implemented this" ) + + def connect_port_network(self, port_id, network_id, admin=False): + '''Connects a external port to a network''' + '''Returns status code of the VIM response''' + raise vimconnNotImplemented( "Should have implemented this" ) + + def new_vminstancefromJSON(self, vm_data): + '''Adds a VM instance to VIM''' + '''Returns the instance identifier''' + raise vimconnNotImplemented( "Should have implemented this" )