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 def get_file(self, src, dest):
134 if self.status is not NodeStatus.STATUS_OK:
135 logger.info("The node %s is not active" % self.ip)
137 logger.info("Fetching %s from %s" % (src, self.ip))
138 get_file_result = ssh_utils.get_file(self.ssh_client, src, dest)
139 if get_file_result is None:
140 logger.error("SFTP failed to retrieve the file.")
142 logger.info("Successfully copied %s:%s to %s" %
143 (self.ip, src, dest))
144 return get_file_result
146 def put_file(self, src, dest):
150 if self.status is not NodeStatus.STATUS_OK:
151 logger.info("The node %s is not active" % self.ip)
153 logger.info("Copying %s to %s" % (src, self.ip))
154 put_file_result = ssh_utils.put_file(self.ssh_client, src, dest)
155 if put_file_result is None:
156 logger.error("SFTP failed to retrieve the file.")
158 logger.info("Successfully copied %s to %s:%s" %
159 (src, dest, self.ip))
160 return put_file_result
162 def run_cmd(self, cmd):
164 Run command remotely on a node
166 if self.status is not NodeStatus.STATUS_OK:
167 logger.error("The node %s is not active" % self.ip)
169 _, stdout, stderr = (self.ssh_client.exec_command(cmd))
170 error = stderr.readlines()
172 logger.error("error %s" % ''.join(error))
174 output = ''.join(stdout.readlines()).rstrip()
179 Returns a dictionary with all the attributes
185 'status': self.status,
190 def get_attribute(self, attribute):
192 Returns an attribute given the name
194 return self.get_dict()[attribute]
196 def is_controller(self):
198 Returns if the node is a controller
200 if 'controller' in self.roles:
204 def is_compute(self):
206 Returns if the node is a compute
208 if 'compute' in self.roles:
212 def get_ovs_info(self):
214 Returns the ovs version installed
216 cmd = "ovs-vsctl --version|head -1| sed 's/^.*) //'"
217 return self.run_cmd(cmd)
227 info: {info}'''.format(name=self.name,
232 ovs=self.get_ovs_info(),
236 class DeploymentHandler(object):
239 EX_ERROR = os.EX_SOFTWARE
240 FUNCTION_NOT_IMPLEMENTED = "Function not implemented by adapter!"
249 self.installer = installer.lower()
250 self.installer_ip = installer_ip
251 self.installer_user = installer_user
252 self.installer_pwd = installer_pwd
253 self.pkey_file = pkey_file
255 if pkey_file is not None and not os.path.isfile(pkey_file):
257 'The private key file %s does not exist!' % pkey_file)
259 self.installer_connection = ssh_utils.get_ssh_client(
260 hostname=self.installer_ip,
261 username=self.installer_user,
262 password=self.installer_pwd,
263 pkey_file=self.pkey_file)
265 if self.installer_connection:
266 self.installer_node = Node(id='',
269 status=NodeStatus.STATUS_OK,
270 ssh_client=self.installer_connection,
271 roles='installer node')
274 'Cannot establish connection to the installer node!')
276 self.nodes = self.get_nodes()
279 def get_openstack_version(self):
281 Returns a string of the openstack version (nova-compute)
283 raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
286 def get_sdn_version(self):
288 Returns a string of the sdn controller and its version, if exists
290 raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
293 def get_deployment_status(self):
295 Returns a string of the status of the deployment
297 raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
300 def get_nodes(self, options=None):
302 Generates a list of all the nodes in the deployment
304 raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
306 def get_installer_node(self):
308 Returns the installer node object
310 return self.installer_node
312 def get_deployment_info(self):
314 Returns an object of type Deployment
316 return Deployment(installer=self.installer,
317 installer_ip=self.installer_ip,
318 scenario=os.getenv('DEPLOY_SCENARIO', 'Unknown'),
319 status=self.get_deployment_status(),
320 pod=os.getenv('NODE_NAME', 'Unknown'),
321 openstack_version=self.get_openstack_version(),
322 sdn_controller=self.get_sdn_version(),
323 nodes=self.get_nodes())