1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
##############################################################################
# Copyright (c) 2017 Ericsson AB and others.
# Author: Jose Lausuch (jose.lausuch@ericsson.com)
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
from abc import abstractmethod
import os
from opnfv.utils import opnfv_logger as logger
from opnfv.utils import ssh_utils
logger = logger.Logger(__name__).getLogger()
class Deployment(object):
def __init__(self,
installer,
installer_ip,
scenario,
pod,
status,
openstack_version,
sdn_controller,
nodes=[]):
self.deployment_info = {
'installer': installer,
'installer_ip': installer_ip,
'scenario': scenario,
'pod': pod,
'status': status,
'openstack_version': openstack_version,
'sdn_controller': sdn_controller,
'nodes': nodes
}
def _get_openstack_release(self):
'''
Translates an openstack version into the release name
'''
os_versions = {
'12': 'Liberty',
'13': 'Mitaka',
'14': 'Newton',
'15': 'Ocata',
'16': 'Pike',
'17': 'Queens'
}
try:
version = self.deployment_info['openstack_version'].split('.')[0]
name = os_versions[version]
return name
except Exception:
return 'Unknown release'
def get_dict(self):
'''
Returns a dictionary will all the attributes
'''
return self.deployment_info
def __str__(self):
'''
Override of the str method
'''
s = '''
INSTALLER: {installer}
SCENARIO: {scenario}
INSTALLER IP: {installer_ip}
POD: {pod}
STATUS: {status}
OPENSTACK: {openstack_version} ({openstack_release})
SDN: {sdn_controller}
NODES:
'''.format(installer=self.deployment_info['installer'],
scenario=self.deployment_info['scenario'],
installer_ip=self.deployment_info['installer_ip'],
pod=self.deployment_info['pod'],
status=self.deployment_info['status'],
openstack_version=self.deployment_info[
'openstack_version'],
openstack_release=self._get_openstack_release(),
sdn_controller=self.deployment_info['sdn_controller'])
for node in self.deployment_info['nodes']:
s += '\t\t{node_object}\n'.format(node_object=node)
return s
class Role():
CONTROLLER = 'controller'
COMPUTE = 'compute'
ODL = 'opendaylight'
ONOS = 'onos'
class NodeStatus():
STATUS_OK = 'active'
STATUS_INACTIVE = 'inactive'
STATUS_OFFLINE = 'offline'
STATUS_ERROR = 'error'
STATUS_UNUSED = 'unused'
class Node(object):
def __init__(self,
id,
ip,
name,
status,
roles=[],
ssh_client=None,
info={}):
self.id = id
self.ip = ip
self.name = name
self.status = status
self.ssh_client = ssh_client
self.roles = roles
self.info = info
def get_file(self, src, dest):
'''
SCP file from a node
'''
if self.status is not NodeStatus.STATUS_OK:
logger.info("The node %s is not active" % self.ip)
return 1
logger.info("Fetching %s from %s" % (src, self.ip))
get_file_result = ssh_utils.get_file(self.ssh_client, src, dest)
if get_file_result is None:
logger.error("SFTP failed to retrieve the file.")
else:
logger.info("Successfully copied %s:%s to %s" %
(self.ip, src, dest))
return get_file_result
def put_file(self, src, dest):
'''
SCP file to a node
'''
if self.status is not NodeStatus.STATUS_OK:
logger.info("The node %s is not active" % self.ip)
return 1
logger.info("Copying %s to %s" % (src, self.ip))
put_file_result = ssh_utils.put_file(self.ssh_client, src, dest)
if put_file_result is None:
logger.error("SFTP failed to retrieve the file.")
else:
logger.info("Successfully copied %s to %s:%s" %
(src, dest, self.ip))
return put_file_result
def run_cmd(self, cmd):
'''
Run command remotely on a node
'''
if self.status is not NodeStatus.STATUS_OK:
logger.info("The node %s is not active" % self.ip)
return 1
_, stdout, stderr = (self.ssh_client.exec_command(cmd))
error = stderr.readlines()
if len(error) > 0:
logger.error("error %s" % ''.join(error))
return error
output = ''.join(stdout.readlines()).rstrip()
return output
def get_dict(self):
'''
Returns a dictionary with all the attributes
'''
return {
'id': self.id,
'ip': self.ip,
'name': self.name,
'status': self.status,
'roles': self.roles,
'info': self.info
}
def get_attribute(self, attribute):
'''
Returns an attribute given the name
'''
return self.get_dict()[attribute]
def is_controller(self):
'''
Returns if the node is a controller
'''
if 'controller' in self.roles:
return True
return False
def is_compute(self):
'''
Returns if the node is a compute
'''
if 'compute' in self.roles:
return True
return False
def __str__(self):
return str(self.get_dict())
class DeploymentHandler(object):
EX_OK = os.EX_OK
EX_ERROR = os.EX_SOFTWARE
FUNCTION_NOT_IMPLEMENTED = "Function not implemented by adapter!"
def __init__(self,
installer,
installer_ip,
installer_user,
installer_pwd=None,
pkey_file=None):
self.installer = installer.lower()
self.installer_ip = installer_ip
self.installer_user = installer_user
self.installer_pwd = installer_pwd
self.pkey_file = pkey_file
if pkey_file is not None and not os.path.isfile(pkey_file):
raise Exception(
'The private key file %s does not exist!' % pkey_file)
self.installer_connection = ssh_utils.get_ssh_client(
hostname=self.installer_ip,
username=self.installer_user,
password=self.installer_pwd,
pkey_file=self.pkey_file)
if self.installer_connection:
self.installer_node = Node(id='',
ip=installer_ip,
name=installer,
status=NodeStatus.STATUS_OK,
ssh_client=self.installer_connection,
roles='installer node')
else:
raise Exception(
'Cannot establish connection to the installer node!')
self.nodes = self.get_nodes()
@abstractmethod
def get_openstack_version(self):
'''
Returns a string of the openstack version (nova-compute)
'''
raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
@abstractmethod
def get_sdn_version(self):
'''
Returns a string of the sdn controller and its version, if exists
'''
raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
@abstractmethod
def get_deployment_status(self):
'''
Returns a string of the status of the deployment
'''
raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
@abstractmethod
def get_nodes(self, options=None):
'''
Generates a list of all the nodes in the deployment
'''
raise Exception(DeploymentHandler.FUNCTION_NOT_IMPLEMENTED)
def get_installer_node(self):
'''
Returns the installer node object
'''
return self.installer_node
def get_deployment_info(self):
'''
Returns an object of type Deployment
'''
return Deployment(installer=self.installer,
installer_ip=self.installer_ip,
scenario=os.getenv('DEPLOY_SCENARIO', 'Unknown'),
status=self.get_deployment_status(),
pod=os.getenv('NODE_NAME', 'Unknown'),
openstack_version=self.get_openstack_version(),
sdn_controller=self.get_sdn_version(),
nodes=self.get_nodes())
|
