1 ##############################################################################
2 # Copyright (c) 2017 Ericsson AB and others.
3 # Author: Jose Lausuch (jose.lausuch@ericsson.com)
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
10 from abc import abstractmethod
14 from opnfv.utils import opnfv_logger as logger
15 from opnfv.utils import ssh_utils
17 logger = logger.Logger(__name__).getLogger()
20 class Deployment(object):
32 self.deployment_info = {
33 'installer': installer,
34 'installer_ip': installer_ip,
38 'openstack_version': openstack_version,
39 'sdn_controller': sdn_controller,
43 def _get_openstack_release(self):
45 Translates an openstack version into the release name
56 version = self.deployment_info['openstack_version'].split('.')[0]
57 name = os_versions[version]
60 return 'Unknown release'
64 Returns a dictionary will all the attributes
66 return self.deployment_info
70 Override of the str method
73 INSTALLER: {installer}
75 INSTALLER IP: {installer_ip}
78 OPENSTACK: {openstack_version} ({openstack_release})
81 '''.format(installer=self.deployment_info['installer'],
82 scenario=self.deployment_info['scenario'],
83 installer_ip=self.deployment_info['installer_ip'],
84 pod=self.deployment_info['pod'],
85 status=self.deployment_info['status'],
86 openstack_version=self.deployment_info[
88 openstack_release=self._get_openstack_release(),
89 sdn_controller=self.deployment_info['sdn_controller'])
91 for node in self.deployment_info['nodes']:
92 s += '{node_object}\n'.format(node_object=node)
98 CONTROLLER = 'controller'
106 STATUS_INACTIVE = 'inactive'
107 STATUS_OFFLINE = 'offline'
108 STATUS_ERROR = 'error'
109 STATUS_UNUSED = 'unused'
126 self.ssh_client = ssh_client
130 self.cpu_info = 'unknown'
131 self.memory = 'unknown'
135 sys_info = self.get_system_info()
136 self.cpu_info = sys_info['cpu_info']
137 self.memory = sys_info['memory']
138 self.ovs = self.get_ovs_info()
140 def get_file(self, src, dest):
144 if self.status is not NodeStatus.STATUS_OK:
145 logger.info("The node %s is not active" % self.ip)
147 logger.info("Fetching %s from %s" % (src, self.ip))
148 get_file_result = ssh_utils.get_file(self.ssh_client, src, dest)
149 if get_file_result is None:
150 logger.error("SFTP failed to retrieve the file.")
152 logger.info("Successfully copied %s:%s to %s" %
153 (self.ip, src, dest))
154 return get_file_result
156 def put_file(self, src, dest):
160 if self.status is not NodeStatus.STATUS_OK:
161 logger.info("The node %s is not active" % self.ip)
163 logger.info("Copying %s to %s" % (src, self.ip))
164 put_file_result = ssh_utils.put_file(self.ssh_client, src, dest)
165 if put_file_result is None:
166 logger.error("SFTP failed to retrieve the file.")
168 logger.info("Successfully copied %s to %s:%s" %
169 (src, dest, self.ip))
170 return put_file_result
172 def run_cmd(self, cmd):
174 Run command remotely on a node
176 if self.status is not NodeStatus.STATUS_OK:
177 logger.error("The node %s is not active" % self.ip)
179 _, stdout, stderr = (self.ssh_client.exec_command(cmd))
180 error = stderr.readlines()
182 logger.error("error %s" % ''.join(error))
184 output = ''.join(stdout.readlines()).rstrip()
189 Returns a dictionary with all the attributes
195 'status': self.status,
197 'cpu_info': self.cpu_info,
198 'memory': self.memory,
203 def is_controller(self):
205 Returns if the node is a controller
207 if 'controller' in self.roles:
211 def is_compute(self):
213 Returns if the node is a compute
215 if 'compute' in self.roles:
219 def get_ovs_info(self):
221 Returns the ovs version installed
223 cmd = "ovs-vsctl --version|head -1| sed 's/^.*) //'"
224 return self.run_cmd(cmd)
226 def get_system_info(self):
228 Returns the ovs version installed
230 cmd = 'grep MemTotal /proc/meminfo'
231 memory = self.run_cmd(cmd).partition('MemTotal:')[-1].strip().encode()
235 result = self.run_cmd(cmd)
236 for line in result.splitlines():
237 if line.startswith('CPU(s)'):
238 cpu_info['num_cpus'] = line.split(' ')[-1].encode()
239 elif line.startswith('Thread(s) per core'):
240 cpu_info['threads/core'] = line.split(' ')[-1].encode()
241 elif line.startswith('Core(s) per socket'):
242 cpu_info['cores/socket'] = line.split(' ')[-1].encode()
243 elif line.startswith('Model name'):
244 cpu_info['model'] = line.partition(
245 'Model name:')[-1].strip().encode()
246 elif line.startswith('Architecture'):
247 cpu_info['arch'] = line.split(' ')[-1].encode()
249 return {'memory': memory, 'cpu_info': cpu_info}
261 info: {info}'''.format(name=self.name,
266 cpu_info=self.cpu_info,
272 class DeploymentHandler(object):
275 EX_ERROR = os.EX_SOFTWARE
276 FUNCTION_NOT_IMPLEMENTED = "Function not implemented by adapter!"
285 self.installer = installer.lower()
286 self.installer_ip = installer_ip
287 self.installer_user = installer_user
288 self.installer_pwd = installer_pwd
289 self.pkey_file = pkey_file
291 if pkey_file is not None and not os.path.isfile(pkey_file):
293 'The private key file %s does not exist!' % pkey_file)
295 self.installer_connection = ssh_utils.get_ssh_client(
296 hostname=self.installer_ip,
297 username=self.installer_user,
298 password=self.installer_pwd,
299 pkey_file=self.pkey_file)
301 if self.installer_connection:
302 self.installer_node = Node(id='',
305 status=NodeStatus.STATUS_OK,
306 ssh_client=self.installer_connection,
307 roles='installer node')
310 'Cannot establish connection to the installer node!')
312 self.nodes = self.get_nodes()
315 def get_openstack_version(self):
317 Returns a string of the openstack version (nova-compute)
319 raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
322 def get_sdn_version(self):
324 Returns a string of the sdn controller and its version, if exists
326 raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
329 def get_deployment_status(self):
331 Returns a string of the status of the deployment
333 raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
336 def get_nodes(self, options=None):
338 Generates a list of all the nodes in the deployment
340 raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
342 def get_installer_node(self):
344 Returns the installer node object
346 return self.installer_node
348 def get_deployment_info(self):
350 Returns an object of type Deployment
352 return Deployment(installer=self.installer,
353 installer_ip=self.installer_ip,
354 scenario=os.getenv('DEPLOY_SCENARIO', 'Unknown'),
355 status=self.get_deployment_status(),
356 pod=os.getenv('NODE_NAME', 'Unknown'),
357 openstack_version=self.get_openstack_version(),
358 sdn_controller=self.get_sdn_version(),
359 nodes=self.get_nodes())