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 from .common import utils
16 REQ_DEPLOY_SETTINGS = ['sdn_controller',
28 OPT_DEPLOY_SETTINGS = ['performance', 'vsperf', 'ceph_device', 'yardstick']
30 VALID_ROLES = ['Controller', 'Compute', 'ObjectStorage']
31 VALID_PERF_OPTS = ['kernel', 'nova', 'vpp']
32 VALID_DATAPLANES = ['ovs', 'ovs_dpdk', 'fdio']
35 class DeploySettings(dict):
37 This class parses a APEX deploy settings yaml file into an object
39 Currently the parsed object is dumped into a bash global definition file
40 for deploy.sh consumption. This object will later be used directly as
41 deployment script move to python.
43 def __init__(self, filename):
45 if isinstance(filename, str):
46 with open(filename, 'r') as deploy_settings_file:
47 init_dict = yaml.safe_load(deploy_settings_file)
49 # assume input is a dict to build from
52 super().__init__(init_dict)
53 self._validate_settings()
55 def _validate_settings(self):
57 Validates the deploy settings file provided
59 DeploySettingsException will be raised if validation fails.
62 if 'deploy_options' not in self:
63 raise DeploySettingsException("No deploy options provided in"
64 " deploy settings file")
65 if 'global_params' not in self:
66 raise DeploySettingsException("No global options provided in"
67 " deploy settings file")
69 deploy_options = self['deploy_options']
70 if not isinstance(deploy_options, dict):
71 raise DeploySettingsException("deploy_options should be a list")
73 if ('gluon' in self['deploy_options'] and
74 'vpn' in self['deploy_options']):
75 if (self['deploy_options']['gluon'] is True and
76 self['deploy_options']['vpn'] is False):
77 raise DeploySettingsException(
78 "Invalid deployment configuration: "
79 "If gluon is enabled, "
80 "vpn also needs to be enabled")
82 for setting, value in deploy_options.items():
83 if setting not in REQ_DEPLOY_SETTINGS + OPT_DEPLOY_SETTINGS:
84 raise DeploySettingsException("Invalid deploy_option {} "
85 "specified".format(setting))
86 if setting == 'dataplane':
87 if value not in VALID_DATAPLANES:
88 planes = ' '.join(VALID_DATAPLANES)
89 raise DeploySettingsException(
90 "Invalid dataplane {} specified. Valid dataplanes:"
91 " {}".format(value, planes))
93 for req_set in REQ_DEPLOY_SETTINGS:
94 if req_set not in deploy_options:
95 if req_set == 'dataplane':
96 self['deploy_options'][req_set] = 'ovs'
97 elif req_set == 'ceph':
98 self['deploy_options'][req_set] = True
100 self['deploy_options'][req_set] = False
102 if 'performance' in deploy_options:
103 if not isinstance(deploy_options['performance'], dict):
104 raise DeploySettingsException("Performance deploy_option"
105 "must be a dictionary.")
106 for role, role_perf_sets in deploy_options['performance'].items():
107 if role not in VALID_ROLES:
108 raise DeploySettingsException("Performance role {}"
109 "is not valid, choose"
112 " ".join(VALID_ROLES)
115 for key in role_perf_sets:
116 if key not in VALID_PERF_OPTS:
117 raise DeploySettingsException("Performance option {} "
118 "is not valid, choose"
125 def _dump_performance(self):
127 Creates performance settings string for bash consumption.
129 Output will be in the form of a list that can be iterated over in
130 bash, with each string being the direct input to the performance
131 setting script in the form <role> <category> <key> <value> to
132 facilitate modification of the correct image.
134 bash_str = 'performance_options=(\n'
135 deploy_options = self['deploy_options']
136 for role, settings in deploy_options['performance'].items():
137 for category, options in settings.items():
138 for key, value in options.items():
139 bash_str += "\"{} {} {} {}\"\n".format(role,
145 bash_str += 'performance_roles=(\n'
146 for role in self['deploy_options']['performance']:
147 bash_str += role + '\n'
153 def _dump_deploy_options_array(self):
155 Creates deploy settings array in bash syntax.
158 for key, value in self['deploy_options'].items():
159 if not isinstance(value, bool):
160 bash_str += "deploy_options_array[{}]=\"{}\"\n".format(key,
163 bash_str += "deploy_options_array[{}]={}\n".format(key,
167 def dump_bash(self, path=None):
169 Prints settings for bash consumption.
171 If optional path is provided, bash string will be written to the file
175 for key, value in self['global_params'].items():
176 bash_str += "{}={}\n".format(key, value)
177 if 'performance' in self['deploy_options']:
178 bash_str += self._dump_performance()
179 bash_str += self._dump_deploy_options_array()
180 utils.write_str(bash_str, path)
183 class DeploySettingsException(Exception):
184 def __init__(self, value):