1 ##############################################################################
2 # Copyright (c) 2016 Michael Chapman (michapma@redhat.com) and others.
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 ##############################################################################
14 REQ_DEPLOY_SETTINGS = ['sdn_controller',
23 OPT_DEPLOY_SETTINGS = ['performance']
25 VALID_ROLES = ['Controller', 'Compute', 'ObjectStorage']
26 VALID_PERF_OPTS = ['kernel','nova']
27 VALID_DATAPLANES = ['ovs','ovs_dpdk','fdio']
31 This class parses a APEX deploy settings yaml file into an object
33 Currently the parsed object is dumped into a bash global definition file
34 for deploy.sh consumption. This object will later be used directly as
35 deployment script move to python.
37 def __init__(self, filename):
38 with open(filename, 'r') as settings_file:
39 self.deploy_settings = yaml.load(settings_file)
40 self._validate_settings()
42 def _validate_settings(self):
44 Validates the deploy settings file provided
46 DeploySettingsException will be raised if validation fails.
49 if 'deploy_options' not in self.deploy_settings:
50 raise DeploySettingsException("No deploy options provided in"
51 " deploy settings file")
52 if 'global_params' not in self.deploy_settings:
53 raise DeploySettingsException("No global options provided in"
54 " deploy settings file")
56 deploy_options = self.deploy_settings['deploy_options']
57 if not isinstance(deploy_options, dict):
58 raise DeploySettingsException("deploy_options should be a list")
60 for setting, value in deploy_options.items():
61 if setting not in REQ_DEPLOY_SETTINGS + OPT_DEPLOY_SETTINGS:
62 raise DeploySettingsException("Invalid deploy_option {} "
63 "specified".format(setting))
64 if setting == 'dataplane':
65 if value not in VALID_DATAPLANES:
66 planes = ' '.join(VALID_DATAPLANES)
67 raise DeploySettingsException("Invalid dataplane {} "
68 "specified. Valid dataplanes:"
69 " {}".format(value,planes))
71 for req_set in REQ_DEPLOY_SETTINGS:
72 if req_set not in deploy_options:
73 if req_set == 'dataplane':
74 self.deploy_settings['deploy_options'][req_set] = 'ovs'
76 self.deploy_settings['deploy_options'][req_set] = False
78 if 'performance' in deploy_options:
79 if not isinstance(deploy_options['performance'], dict):
80 raise DeploySettingsException("Performance deploy_option"
81 "must be a dictionary.")
82 for role,role_perf_sets in deploy_options['performance'].items():
83 if role not in VALID_ROLES:
84 raise DeploySettingsException("Performance role {}"
85 "is not valid, choose"
87 role," ".join(VALID_ROLES)
90 for key in role_perf_sets:
91 if key not in VALID_PERF_OPTS:
92 raise DeploySettingsException("Performance option {}"
93 "is not valid, choose"
99 def _dump_performance(self):
101 Creates performance settings string for bash consumption.
103 Output will be in the form of a list that can be iterated over in bash,
104 with each string being the direct input to the performance setting script
105 in the form <role> <category> <key> <value> to facilitate modification of the
108 bash_str = 'performance_options=(\n'
109 for role,settings in self.deploy_settings['deploy_options']['performance'].items():
110 for category,options in settings.items():
111 for key,value in options.items():
112 bash_str += "\"{} {} {} {}\"\n".format(role, category, key, value)
115 bash_str += 'performance_roles=(\n'
116 for role in self.deploy_settings['deploy_options']['performance']:
117 bash_str += role + '\n'
123 def _dump_deploy_options_array(self):
125 Creates deploy settings array in bash syntax.
128 for key,value in self.deploy_settings['deploy_options'].items():
129 if not isinstance(value, bool):
130 bash_str += "deploy_options_array[{}]=\"{}\"\n".format(key, value)
132 bash_str += "deploy_options_array[{}]={}\n".format(key, value)
135 def dump_bash(self, path=None):
137 Prints settings for bash consumption.
139 If optional path is provided, bash string will be written to the file
143 for key, value in self.deploy_settings['global_params'].items():
144 bash_str += "{}={}\n".format(key, value)
145 if 'performance' in self.deploy_settings['deploy_options']:
146 bash_str += self._dump_performance()
147 bash_str += self._dump_deploy_options_array()
150 with open(path, 'w') as file:
156 class DeploySettingsException(Exception):
157 def __init__(self, value):