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 ##############################################################################
13 from apex.common import constants
15 REQ_DEPLOY_SETTINGS = ['sdn_controller',
32 OPT_DEPLOY_SETTINGS = ['performance',
36 'odl_vpp_routing_node',
42 VALID_ROLES = ['Controller', 'Compute', 'ObjectStorage']
43 VALID_PERF_OPTS = ['kernel', 'nova', 'vpp', 'ovs']
44 VALID_DATAPLANES = ['ovs', 'ovs_dpdk', 'fdio']
45 REQ_PATCH_CRITERIA = ['change-id', 'project']
46 OPT_PATCH_CRITERIA = ['branch']
49 class DeploySettings(dict):
51 This class parses a APEX deploy settings yaml file into an object
53 def __init__(self, filename):
54 if isinstance(filename, str):
55 with open(filename, 'r') as deploy_settings_file:
56 init_dict = yaml.safe_load(deploy_settings_file)
58 # assume input is a dict to build from
61 super().__init__(init_dict)
62 self._validate_settings()
64 def _validate_settings(self):
66 Validates the deploy settings file provided
68 DeploySettingsException will be raised if validation fails.
71 if 'deploy_options' not in self:
72 raise DeploySettingsException("No deploy options provided in"
73 " deploy settings file")
74 if 'global_params' not in self:
75 raise DeploySettingsException("No global options provided in"
76 " deploy settings file")
78 deploy_options = self['deploy_options']
79 if not isinstance(deploy_options, dict):
80 raise DeploySettingsException("deploy_options should be a list")
82 if ('gluon' in self['deploy_options'] and
83 'vpn' in self['deploy_options']):
84 if (self['deploy_options']['gluon'] is True and
85 self['deploy_options']['vpn'] is False):
86 raise DeploySettingsException(
87 "Invalid deployment configuration: "
88 "If gluon is enabled, "
89 "vpn also needs to be enabled")
91 for setting, value in deploy_options.items():
92 if setting not in REQ_DEPLOY_SETTINGS + OPT_DEPLOY_SETTINGS:
93 raise DeploySettingsException("Invalid deploy_option {} "
94 "specified".format(setting))
95 if setting == 'dataplane':
96 if value not in VALID_DATAPLANES:
97 planes = ' '.join(VALID_DATAPLANES)
98 raise DeploySettingsException(
99 "Invalid dataplane {} specified. Valid dataplanes:"
100 " {}".format(value, planes))
102 for req_set in REQ_DEPLOY_SETTINGS:
103 if req_set not in deploy_options:
104 if req_set == 'dataplane':
105 self['deploy_options'][req_set] = 'ovs'
106 elif req_set == 'ceph':
107 self['deploy_options'][req_set] = True
108 elif req_set == 'ceph_device':
109 self['deploy_options'][req_set] = '/dev/loop3'
110 elif req_set == 'odl_version':
111 self['deploy_options'][req_set] = \
112 constants.DEFAULT_ODL_VERSION
113 elif req_set == 'os_version':
114 self['deploy_options'][req_set] = \
115 constants.DEFAULT_OS_VERSION
117 self['deploy_options'][req_set] = False
118 elif req_set == 'odl_version' and self['deploy_options'][
119 'odl_version'] not in constants.VALID_ODL_VERSIONS:
120 raise DeploySettingsException(
121 "Invalid ODL version: {}".format(self[deploy_options][
123 elif req_set == 'sriov':
124 if self['deploy_options'][req_set] is True:
125 raise DeploySettingsException(
126 "Invalid SRIOV interface name: {}".format(
127 self['deploy_options']['sriov']))
129 if self['deploy_options']['odl_version'] == 'oxygen':
130 self['deploy_options']['odl_version'] = 'master'
132 if 'performance' in deploy_options:
133 if not isinstance(deploy_options['performance'], dict):
134 raise DeploySettingsException("Performance deploy_option"
135 "must be a dictionary.")
136 for role, role_perf_sets in deploy_options['performance'].items():
137 if role not in VALID_ROLES:
138 raise DeploySettingsException("Performance role {}"
139 "is not valid, choose"
142 " ".join(VALID_ROLES)
145 for key in role_perf_sets:
146 if key not in VALID_PERF_OPTS:
147 raise DeploySettingsException("Performance option {} "
148 "is not valid, choose"
154 # validate global params
155 if 'ha_enabled' not in self['global_params']:
157 raise DeploySettingsException('ha_enabled is missing in global '
158 'parameters of deploy settings file')
159 if 'patches' not in self['global_params']:
160 self['global_params']['patches'] = dict()
161 for node in ('undercloud', 'overcloud'):
162 if node not in self['global_params']['patches']:
163 self['global_params']['patches'][node] = list()
165 patches = self['global_params']['patches'][node]
166 assert isinstance(patches, list)
167 for patch in patches:
168 assert isinstance(patch, dict)
169 # Assert all required criteria exists for each patch
170 assert all(i in patch.keys() for i in REQ_PATCH_CRITERIA)
171 patch_criteria = REQ_PATCH_CRITERIA + OPT_PATCH_CRITERIA
172 # Assert all patch keys are valid criteria
173 assert all(i in patch_criteria for i in patch.keys())
175 def _dump_performance(self):
177 Creates performance settings string for bash consumption.
178 Output will be in the form of a list that can be iterated over in
179 bash, with each string being the direct input to the performance
180 setting script in the form <role> <category> <key> <value> to
181 facilitate modification of the correct image.
183 bash_str = 'performance_options=(\n'
184 deploy_options = self['deploy_options']
185 for role, settings in deploy_options['performance'].items():
186 for category, options in settings.items():
187 for key, value in options.items():
188 bash_str += "\"{} {} {} {}\"\n".format(role,
194 bash_str += 'performance_roles=(\n'
195 for role in self['deploy_options']['performance']:
196 bash_str += role + '\n'
202 def _dump_deploy_options_array(self):
204 Creates deploy settings array in bash syntax.
207 for key, value in self['deploy_options'].items():
208 if not isinstance(value, bool):
209 bash_str += "deploy_options_array[{}]=\"{}\"\n".format(key,
212 bash_str += "deploy_options_array[{}]={}\n".format(key,
217 class DeploySettingsException(Exception):
218 def __init__(self, value):