modules/opnfv/deployment/manager.py

   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 ##############################################################################
   9
  10 from abc import abstractmethod
  11 import os
  12
  13
  14 from opnfv.utils import opnfv_logger as logger
  15 from opnfv.utils import ssh_utils
  16
  17 logger = logger.Logger(__name__).getLogger()
  18
  19
  20 class Deployment(object):
  21
  22     def __init__(self,
  23                  installer,
  24                  installer_ip,
  25                  scenario,
  26                  pod,
  27                  status,
  28                  openstack_version,
  29                  sdn_controller,
  30                  nodes=None):
  31
  32         self.deployment_info = {
  33             'installer': installer,
  34             'installer_ip': installer_ip,
  35             'scenario': scenario,
  36             'pod': pod,
  37             'status': status,
  38             'openstack_version': openstack_version,
  39             'sdn_controller': sdn_controller,
  40             'nodes': nodes
  41         }
  42
  43     def _get_openstack_release(self):
  44         '''
  45         Translates an openstack version into the release name
  46         '''
  47         os_versions = {
  48             '12': 'Liberty',
  49             '13': 'Mitaka',
  50             '14': 'Newton',
  51             '15': 'Ocata',
  52             '16': 'Pike',
  53             '17': 'Queens'
  54         }
  55         try:
  56             version = self.deployment_info['openstack_version'].split('.')[0]
  57             name = os_versions[version]
  58             return name
  59         except Exception:
  60             return 'Unknown release'
  61
  62     def get_dict(self):
  63         '''
  64         Returns a dictionary will all the attributes
  65         '''
  66         return self.deployment_info
  67
  68     def __str__(self):
  69         '''
  70         Override of the str method
  71         '''
  72         s = '''
  73         INSTALLER:    {installer}
  74         SCENARIO:     {scenario}
  75         INSTALLER IP: {installer_ip}
  76         POD:          {pod}
  77         STATUS:       {status}
  78         OPENSTACK:    {openstack_version} ({openstack_release})
  79         SDN:          {sdn_controller}
  80         NODES:
  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[
  87             'openstack_version'],
  88             openstack_release=self._get_openstack_release(),
  89             sdn_controller=self.deployment_info['sdn_controller'])
  90
  91         for node in self.deployment_info['nodes']:
  92             s += '{node_object}\n'.format(node_object=node)
  93
  94         return s
  95
  96
  97 class Role():
  98     CONTROLLER = 'controller'
  99     COMPUTE = 'compute'
 100     ODL = 'opendaylight'
 101     ONOS = 'onos'
 102
 103
 104 class NodeStatus():
 105     STATUS_OK = 'active'
 106     STATUS_INACTIVE = 'inactive'
 107     STATUS_OFFLINE = 'offline'
 108     STATUS_ERROR = 'error'
 109     STATUS_UNUSED = 'unused'
 110
 111
 112 class Node(object):
 113
 114     def __init__(self,
 115                  id,
 116                  ip,
 117                  name,
 118                  status,
 119                  roles=None,
 120                  ssh_client=None,
 121                  info=None):
 122         self.id = id
 123         self.ip = ip
 124         self.name = name
 125         self.status = status
 126         self.ssh_client = ssh_client
 127         self.roles = roles
 128         self.info = info
 129
 130         self.cpu_info = 'unknown'
 131         self.memory = 'unknown'
 132         self.ovs = 'unknown'
 133
 134         if ssh_client:
 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()
 139
 140     def get_file(self, src, dest):
 141         '''
 142         SCP file from a node
 143         '''
 144         if self.status is not NodeStatus.STATUS_OK:
 145             logger.info("The node %s is not active" % self.ip)
 146             return 1
 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.")
 151         else:
 152             logger.info("Successfully copied %s:%s to %s" %
 153                         (self.ip, src, dest))
 154         return get_file_result
 155
 156     def put_file(self, src, dest):
 157         '''
 158         SCP file to a node
 159         '''
 160         if self.status is not NodeStatus.STATUS_OK:
 161             logger.info("The node %s is not active" % self.ip)
 162             return 1
 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.")
 167         else:
 168             logger.info("Successfully copied %s to %s:%s" %
 169                         (src, dest, self.ip))
 170         return put_file_result
 171
 172     def run_cmd(self, cmd):
 173         '''
 174         Run command remotely on a node
 175         '''
 176         if self.status is not NodeStatus.STATUS_OK:
 177             logger.error("The node %s is not active" % self.ip)
 178             return None
 179         _, stdout, stderr = (self.ssh_client.exec_command(cmd))
 180         error = stderr.readlines()
 181         if len(error) > 0:
 182             logger.error("error %s" % ''.join(error))
 183             return error
 184         output = ''.join(stdout.readlines()).rstrip()
 185         return output
 186
 187     def get_dict(self):
 188         '''
 189         Returns a dictionary with all the attributes
 190         '''
 191         return {
 192             'id': self.id,
 193             'ip': self.ip,
 194             'name': self.name,
 195             'status': self.status,
 196             'roles': self.roles,
 197             'cpu_info': self.cpu_info,
 198             'memory': self.memory,
 199             'ovs': self.ovs,
 200             'info': self.info
 201         }
 202
 203     def is_controller(self):
 204         '''
 205         Returns if the node is a controller
 206         '''
 207         return Role.CONTROLLER in self.roles
 208
 209     def is_compute(self):
 210         '''
 211         Returns if the node is a compute
 212         '''
 213         return Role.COMPUTE in self.roles
 214
 215     def is_odl(self):
 216         '''
 217         Returns if the node is an opendaylight
 218         '''
 219         return Role.ODL in self.roles
 220
 221     def get_ovs_info(self):
 222         '''
 223         Returns the ovs version installed
 224         '''
 225         cmd = "ovs-vsctl --version|head -1| sed 's/^.*) //'"
 226         return self.run_cmd(cmd)
 227
 228     def get_system_info(self):
 229         '''
 230         Returns the ovs version installed
 231         '''
 232         cmd = 'grep MemTotal /proc/meminfo'
 233         memory = self.run_cmd(cmd).partition('MemTotal:')[-1].strip().encode()
 234
 235         cpu_info = {}
 236         cmd = 'lscpu'
 237         result = self.run_cmd(cmd)
 238         for line in result.splitlines():
 239             if line.startswith('CPU(s)'):
 240                 cpu_info['num_cpus'] = line.split(' ')[-1].encode()
 241             elif line.startswith('Thread(s) per core'):
 242                 cpu_info['threads/core'] = line.split(' ')[-1].encode()
 243             elif line.startswith('Core(s) per socket'):
 244                 cpu_info['cores/socket'] = line.split(' ')[-1].encode()
 245             elif line.startswith('Model name'):
 246                 cpu_info['model'] = line.partition(
 247                     'Model name:')[-1].strip().encode()
 248             elif line.startswith('Architecture'):
 249                 cpu_info['arch'] = line.split(' ')[-1].encode()
 250
 251         return {'memory': memory, 'cpu_info': cpu_info}
 252
 253     def __str__(self):
 254         return '''
 255             name:    {name}
 256             id:      {id}
 257             ip:      {ip}
 258             status:  {status}
 259             roles:   {roles}
 260             cpu:     {cpu_info}
 261             memory:  {memory}
 262             ovs:     {ovs}
 263             info:    {info}'''.format(name=self.name,
 264                                       id=self.id,
 265                                       ip=self.ip,
 266                                       status=self.status,
 267                                       roles=self.roles,
 268                                       cpu_info=self.cpu_info,
 269                                       memory=self.memory,
 270                                       ovs=self.ovs,
 271                                       info=self.info)
 272
 273
 274 class DeploymentHandler(object):
 275
 276     EX_OK = os.EX_OK
 277     EX_ERROR = os.EX_SOFTWARE
 278     FUNCTION_NOT_IMPLEMENTED = "Function not implemented by adapter!"
 279
 280     def __init__(self,
 281                  installer,
 282                  installer_ip,
 283                  installer_user,
 284                  installer_pwd=None,
 285                  pkey_file=None):
 286
 287         self.installer = installer.lower()
 288         self.installer_ip = installer_ip
 289         self.installer_user = installer_user
 290         self.installer_pwd = installer_pwd
 291         self.pkey_file = pkey_file
 292
 293         if pkey_file is not None and not os.path.isfile(pkey_file):
 294             raise Exception(
 295                 'The private key file %s does not exist!' % pkey_file)
 296
 297         self.installer_connection = ssh_utils.get_ssh_client(
 298             hostname=self.installer_ip,
 299             username=self.installer_user,
 300             password=self.installer_pwd,
 301             pkey_file=self.pkey_file)
 302
 303         if self.installer_connection:
 304             self.installer_node = Node(id='',
 305                                        ip=installer_ip,
 306                                        name=installer,
 307                                        status=NodeStatus.STATUS_OK,
 308                                        ssh_client=self.installer_connection,
 309                                        roles='installer node')
 310         else:
 311             raise Exception(
 312                 'Cannot establish connection to the installer node!')
 313
 314         self.nodes = self.get_nodes()
 315
 316     @abstractmethod
 317     def get_openstack_version(self):
 318         '''
 319         Returns a string of the openstack version (nova-compute)
 320         '''
 321         raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
 322
 323     @abstractmethod
 324     def get_sdn_version(self):
 325         '''
 326         Returns a string of the sdn controller and its version, if exists
 327         '''
 328         raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
 329
 330     @abstractmethod
 331     def get_deployment_status(self):
 332         '''
 333         Returns a string of the status of the deployment
 334         '''
 335         raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
 336
 337     @abstractmethod
 338     def get_nodes(self, options=None):
 339         '''
 340             Generates a list of all the nodes in the deployment
 341         '''
 342         raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
 343
 344     def get_installer_node(self):
 345         '''
 346             Returns the installer node object
 347         '''
 348         return self.installer_node
 349
 350     def get_deployment_info(self):
 351         '''
 352             Returns an object of type Deployment
 353         '''
 354         return Deployment(installer=self.installer,
 355                           installer_ip=self.installer_ip,
 356                           scenario=os.getenv('DEPLOY_SCENARIO', 'Unknown'),
 357                           status=self.get_deployment_status(),
 358                           pod=os.getenv('NODE_NAME', 'Unknown'),
 359                           openstack_version=self.get_openstack_version(),
 360                           sdn_controller=self.get_sdn_version(),
 361                           nodes=self.get_nodes())