Updates docs for SR1 with final revision
[genesis.git] / fuel / deploy / reap.py
1 ###############################################################################
2 # Copyright (c) 2015 Ericsson AB and others.
3 # szilard.cserey@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
11 import common
12 import time
13 import os
14 import yaml
15 import glob
16 import shutil
17
18 N = common.N
19 E = common.E
20 R = common.R
21 ArgParser = common.ArgParser
22 exec_cmd = common.exec_cmd
23 parse = common.parse
24 err = common.err
25 log = common.log
26 delete = common.delete
27 commafy = common.commafy
28
29 DEA_1 = '''
30 title: Deployment Environment Adapter (DEA)
31 # DEA API version supported
32 version: 1.1
33 created: {date}
34 comment: {comment}
35 '''
36
37 DHA_1 = '''
38 title: Deployment Hardware Adapter (DHA)
39 # DHA API version supported
40 version: 1.1
41 created: {date}
42 comment: {comment}
43
44 # Adapter to use for this definition
45 # adapter: [ipmi|libvirt]
46 adapter:
47
48 # Node list.
49 # Mandatory properties are id and role.
50 # All other properties are adapter specific.
51 # For Non-Fuel nodes controlled by:
52 #   - ipmi adapter you need to provide:
53 #       pxeMac
54 #       ipmiIp
55 #       ipmiUser
56 #       ipmiPass
57 #   - libvirt adapter you need to provide:
58 #       libvirtName: <whatever>
59 #       libvirtTemplate: [libvirt/vms/controller.xml | libvirt/vms/compute.xml]
60 #
61 # For the Fuel Node you need to provide:
62 #       libvirtName: <whatever>
63 #       libvirtTemplate: libvirt/vms/fuel.xml
64 #       isFuel: yes
65 #       username: root
66 #       password: r00tme
67 '''
68
69 DHA_2 = '''
70 # Adding the Fuel node as node id {node_id}
71 # which may not be correct - please adjust as needed.
72 '''
73
74 DISKS = {'fuel': '30G',
75          'controller': '30G',
76          'compute': '30G'}
77
78
79 class Reap(object):
80
81     def __init__(self, dea_file, dha_file, comment):
82         self.dea_file = dea_file
83         self.dha_file = dha_file
84         self.comment = comment
85         self.temp_dir = None
86         self.env = None
87         self.env_id = None
88         self.last_node = None
89
90     def get_env(self):
91         env_list = parse(exec_cmd('fuel env'))
92         if len(env_list) > 1:
93             err('Not exactly one environment')
94         self.env = env_list[0]
95         self.env_id = self.env[E['id']]
96
97     def download_config(self, config_type):
98         log('Download %s config for environment %s'
99             % (config_type, self.env_id))
100         exec_cmd('fuel %s --env %s --download --dir %s'
101                  % (config_type, self.env_id, self.temp_dir))
102
103     def write(self, file, text, newline=True):
104         mode = 'a' if os.path.isfile(file) else 'w'
105         with open(file, mode) as f:
106             f.write('%s%s' % (text, ('\n' if newline else '')))
107
108     def write_yaml(self, file, data, newline=True):
109         self.write(file, yaml.dump(data, default_flow_style=False).strip(),
110                    newline)
111
112     def get_node_by_id(self, node_list, node_id):
113         for node in node_list:
114             if node[N['id']] == node_id:
115                 return node
116
117     def reap_interface(self, node_id, interfaces):
118         interface, mac = self.get_interface(node_id)
119         if_name = None
120         if interfaces:
121             if_name = self.check_dict_exists(interfaces, interface)
122         if not if_name:
123             if_name = 'interfaces_%s' % str(len(interfaces) + 1)
124             interfaces[if_name] = interface
125         return if_name, mac
126
127     def reap_transformation(self, node_id, roles, transformations):
128         main_role = 'controller' if 'controller' in roles else 'compute'
129         node_file = glob.glob('%s/deployment_%s/*%s_%s.yaml'
130                               % (self.temp_dir, self.env_id,
131                                  main_role, node_id))
132         tr_name = None
133         with open(node_file[0]) as f:
134             node_config = yaml.load(f)
135         transformation = {'transformations':
136                               node_config['network_scheme']['transformations']}
137         if transformations:
138             tr_name = self.check_dict_exists(transformations, transformation)
139         if not tr_name:
140             tr_name = 'transformations_%s' % str(len(transformations) + 1)
141             transformations[tr_name] = transformation
142         return tr_name
143
144     def check_dict_exists(self, main_dict, dict):
145         for key, val in main_dict.iteritems():
146             if cmp(dict, val) == 0:
147                 return key
148
149     def reap_nodes_interfaces_transformations(self):
150         node_list = parse(exec_cmd('fuel node'))
151         real_node_ids = [node[N['id']] for node in node_list]
152         real_node_ids.sort()
153         min_node = real_node_ids[0]
154
155         interfaces = {}
156         transformations = {}
157         dea_nodes = []
158         dha_nodes = []
159
160         for real_node_id in real_node_ids:
161             node_id = int(real_node_id) - int(min_node) + 1
162             self.last_node = node_id
163             node = self.get_node_by_id(node_list, real_node_id)
164             roles = commafy(node[N['roles']])
165             if not roles:
166                 err('Fuel Node %s has no role' % real_node_id)
167             dea_node = {'id': node_id,
168                         'role': roles}
169             dha_node = {'id': node_id}
170             if_name, mac = self.reap_interface(real_node_id, interfaces)
171             tr_name = self.reap_transformation(real_node_id, roles,
172                                                transformations)
173             dea_node.update(
174                 {'interfaces': if_name,
175                  'transformations': tr_name})
176
177             dha_node.update(
178                 {'pxeMac': mac if mac else None,
179                  'ipmiIp': None,
180                  'ipmiUser': None,
181                  'ipmiPass': None,
182                  'libvirtName': None,
183                  'libvirtTemplate': None})
184
185             dea_nodes.append(dea_node)
186             dha_nodes.append(dha_node)
187
188         self.write_yaml(self.dha_file, {'nodes': dha_nodes}, False)
189         self.write_yaml(self.dea_file, {'nodes': dea_nodes})
190         self.write_yaml(self.dea_file, interfaces)
191         self.write_yaml(self.dea_file, transformations)
192         self.reap_fuel_node_info()
193         self.write_yaml(self.dha_file, {'disks': DISKS})
194
195     def reap_fuel_node_info(self):
196         dha_nodes = []
197         dha_node = {
198             'id': self.last_node + 1,
199             'libvirtName': None,
200             'libvirtTemplate': None,
201             'isFuel': True,
202             'username': 'root',
203             'password': 'r00tme'}
204
205         dha_nodes.append(dha_node)
206
207         self.write(self.dha_file, DHA_2.format(node_id=dha_node['id']), False)
208         self.write_yaml(self.dha_file, dha_nodes)
209
210     def reap_environment_info(self):
211         network_file = ('%s/network_%s.yaml'
212                         % (self.temp_dir, self.env_id))
213         network = self.read_yaml(network_file)
214         env = {'environment':
215                    {'name': self.env[E['name']],
216                     'mode': self.env[E['mode']],
217                     'net_segment_type':
218                         network['networking_parameters']['segmentation_type']}}
219         self.write_yaml(self.dea_file, env)
220         wanted_release = None
221         rel_list = parse(exec_cmd('fuel release'))
222         for rel in rel_list:
223             if rel[R['id']] == self.env[E['release_id']]:
224                 wanted_release = rel[R['name']]
225         self.write_yaml(self.dea_file, {'wanted_release': wanted_release})
226
227     def reap_fuel_settings(self):
228         data = self.read_yaml('/etc/fuel/astute.yaml')
229         fuel = {}
230         del data['ADMIN_NETWORK']['mac']
231         del data['ADMIN_NETWORK']['interface']
232         for key in ['ADMIN_NETWORK', 'HOSTNAME', 'DNS_DOMAIN', 'DNS_SEARCH',
233                     'DNS_UPSTREAM', 'NTP1', 'NTP2', 'NTP3', 'FUEL_ACCESS']:
234             fuel[key] = data[key]
235         for key in fuel['ADMIN_NETWORK'].keys():
236             if key not in ['ipaddress', 'netmask',
237                            'dhcp_pool_start', 'dhcp_pool_end']:
238                 del fuel['ADMIN_NETWORK'][key]
239         self.write_yaml(self.dea_file, {'fuel': fuel})
240
241     def reap_network_settings(self):
242         network_file = ('%s/network_%s.yaml'
243                         % (self.temp_dir, self.env_id))
244         data = self.read_yaml(network_file)
245         network = {}
246         network['networking_parameters'] = data['networking_parameters']
247         network['networks'] = data['networks']
248         for net in network['networks']:
249             del net['id']
250             del net['group_id']
251         self.write_yaml(self.dea_file, {'network': network})
252
253     def reap_settings(self):
254         settings_file = '%s/settings_%s.yaml' % (self.temp_dir, self.env_id)
255         settings = self.read_yaml(settings_file)
256         self.write_yaml(self.dea_file, {'settings': settings})
257
258     def get_interface(self, real_node_id):
259         exec_cmd('fuel node --node-id %s --network --download --dir %s'
260                  % (real_node_id, self.temp_dir))
261         interface_file = ('%s/node_%s/interfaces.yaml'
262                           % (self.temp_dir, real_node_id))
263         interfaces = self.read_yaml(interface_file)
264         interface_config = {}
265         pxe_mac = None
266         for interface in interfaces:
267             networks = []
268             for network in interface['assigned_networks']:
269                 networks.append(network['name'])
270                 if network['name'] == 'fuelweb_admin':
271                     pxe_mac = interface['mac']
272             if networks:
273                 interface_config[interface['name']] = networks
274         return interface_config, pxe_mac
275
276     def read_yaml(self, yaml_file):
277         with open(yaml_file) as f:
278             data = yaml.load(f)
279             return data
280
281     def intro(self):
282         delete(self.dea_file)
283         delete(self.dha_file)
284         self.temp_dir = exec_cmd('mktemp -d')
285         date = time.strftime('%c')
286         self.write(self.dea_file,
287                    DEA_1.format(date=date, comment=self.comment), False)
288         self.write(self.dha_file,
289                    DHA_1.format(date=date, comment=self.comment))
290         self.get_env()
291         self.download_config('deployment')
292         self.download_config('settings')
293         self.download_config('network')
294
295     def finale(self):
296         log('DEA file is available at %s' % self.dea_file)
297         log('DHA file is available at %s (this is just a template)'
298             % self.dha_file)
299         shutil.rmtree(self.temp_dir)
300
301     def reap(self):
302         self.intro()
303         self.reap_environment_info()
304         self.reap_nodes_interfaces_transformations()
305         self.reap_fuel_settings()
306         self.reap_network_settings()
307         self.reap_settings()
308         self.finale()
309
310
311 def usage():
312     print '''
313     Usage:
314     python reap.py <dea_file> <dha_file> <comment>
315     '''
316
317
318 def parse_arguments():
319     parser = ArgParser(prog='python %s' % __file__)
320     parser.add_argument('dea_file', nargs='?', action='store',
321                         default='dea.yaml',
322                         help='Deployment Environment Adapter: dea.yaml')
323     parser.add_argument('dha_file', nargs='?', action='store',
324                         default='dha.yaml',
325                         help='Deployment Hardware Adapter: dha.yaml')
326     parser.add_argument('comment', nargs='?', action='store', help='Comment')
327     args = parser.parse_args()
328     return (args.dea_file, args.dha_file, args.comment)
329
330
331 def main():
332     dea_file, dha_file, comment = parse_arguments()
333
334     r = Reap(dea_file, dha_file, comment)
335     r.reap()
336
337
338 if __name__ == '__main__':
339     main()