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',
24 OPT_DEPLOY_SETTINGS = ['performance', 'vsperf']
26 VALID_ROLES = ['Controller', 'Compute', 'ObjectStorage']
27 VALID_PERF_OPTS = ['kernel', 'nova']
28 VALID_DATAPLANES = ['ovs', 'ovs_dpdk', 'fdio']
31 class DeploySettings(dict):
33 This class parses a APEX deploy settings yaml file into an object
35 Currently the parsed object is dumped into a bash global definition file
36 for deploy.sh consumption. This object will later be used directly as
37 deployment script move to python.
39 def __init__(self, filename):
41 if type(filename) is str:
42 with open(filename, 'r') as deploy_settings_file:
43 init_dict = yaml.safe_load(deploy_settings_file)
45 # assume input is a dict to build from
48 super().__init__(init_dict)
49 self._validate_settings()
51 def _validate_settings(self):
53 Validates the deploy settings file provided
55 DeploySettingsException will be raised if validation fails.
58 if 'deploy_options' not in self:
59 raise DeploySettingsException("No deploy options provided in"
60 " deploy settings file")
61 if 'global_params' not in self:
62 raise DeploySettingsException("No global options provided in"
63 " deploy settings file")
65 deploy_options = self['deploy_options']
66 if not isinstance(deploy_options, dict):
67 raise DeploySettingsException("deploy_options should be a list")
69 for setting, value in deploy_options.items():
70 if setting not in REQ_DEPLOY_SETTINGS + OPT_DEPLOY_SETTINGS:
71 raise DeploySettingsException("Invalid deploy_option {} "
72 "specified".format(setting))
73 if setting == 'dataplane':
74 if value not in VALID_DATAPLANES:
75 planes = ' '.join(VALID_DATAPLANES)
76 raise DeploySettingsException(
77 "Invalid dataplane {} specified. Valid dataplanes:"
78 " {}".format(value, planes))
80 for req_set in REQ_DEPLOY_SETTINGS:
81 if req_set not in deploy_options:
82 if req_set == 'dataplane':
83 self['deploy_options'][req_set] = 'ovs'
85 self['deploy_options'][req_set] = False
87 if 'performance' in deploy_options:
88 if not isinstance(deploy_options['performance'], dict):
89 raise DeploySettingsException("Performance deploy_option"
90 "must be a dictionary.")
91 for role, role_perf_sets in deploy_options['performance'].items():
92 if role not in VALID_ROLES:
93 raise DeploySettingsException("Performance role {}"
94 "is not valid, choose"
100 for key in role_perf_sets:
101 if key not in VALID_PERF_OPTS:
102 raise DeploySettingsException("Performance option {} "
103 "is not valid, choose"
110 def _dump_performance(self):
112 Creates performance settings string for bash consumption.
114 Output will be in the form of a list that can be iterated over in
115 bash, with each string being the direct input to the performance
116 setting script in the form <role> <category> <key> <value> to
117 facilitate modification of the correct image.
119 bash_str = 'performance_options=(\n'
120 deploy_options = self['deploy_options']
121 for role, settings in deploy_options['performance'].items():
122 for category, options in settings.items():
123 for key, value in options.items():
124 bash_str += "\"{} {} {} {}\"\n".format(role,
130 bash_str += 'performance_roles=(\n'
131 for role in self['deploy_options']['performance']:
132 bash_str += role + '\n'
138 def _dump_deploy_options_array(self):
140 Creates deploy settings array in bash syntax.
143 for key, value in self['deploy_options'].items():
144 if not isinstance(value, bool):
145 bash_str += "deploy_options_array[{}]=\"{}\"\n".format(key,
148 bash_str += "deploy_options_array[{}]={}\n".format(key,
152 def dump_bash(self, path=None):
154 Prints settings for bash consumption.
156 If optional path is provided, bash string will be written to the file
160 for key, value in self['global_params'].items():
161 bash_str += "{}={}\n".format(key, value)
162 if 'performance' in self['deploy_options']:
163 bash_str += self._dump_performance()
164 bash_str += self._dump_deploy_options_array()
167 with open(path, 'w') as file:
173 class DeploySettingsException(Exception):
174 def __init__(self, value):