-
Notifications
You must be signed in to change notification settings - Fork 50
/
construct_pipeline_block.py
278 lines (226 loc) · 9.85 KB
/
construct_pipeline_block.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# Foremast - Pipeline Tooling
#
# Copyright 2018 Gogo, LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Construct a block section of Stages in a Spinnaker Pipeline."""
import collections
import copy
import json
import logging
from pprint import pformat
from ..consts import ASG_WHITELIST, DEFAULT_EC2_SECURITYGROUPS, EC2_PIPELINE_TYPES, ENV_CONFIGS
from ..utils import generate_encoded_user_data, get_template, remove_duplicate_sg, verify_approval_skip
LOG = logging.getLogger(__name__)
def check_provider_healthcheck(settings, default_provider='Discovery'):
"""Set Provider Health Check when specified.
Returns:
collections.namedtuple: **ProviderHealthCheck** with attributes:
* providers (list): Providers set to use native Health Check.
* has_healthcheck (bool): If any native Health Checks requested.
"""
ProviderHealthCheck = collections.namedtuple('ProviderHealthCheck', ['providers', 'has_healthcheck'])
eureka_enabled = settings['app']['eureka_enabled']
providers = settings['asg']['provider_healthcheck']
LOG.debug('Template defined Health Check Providers: %s', providers)
health_check_providers = []
has_healthcheck = False
normalized_default_provider = default_provider.capitalize()
if eureka_enabled:
LOG.info('Eureka enabled, enabling default Provider Health Check: %s', normalized_default_provider)
for provider, active in providers.items():
if provider.lower() == normalized_default_provider.lower():
providers[provider] = True
LOG.debug('Override defined Provider Health Check: %s -> %s', active, providers[provider])
break
else:
LOG.debug('Adding default Provider Health Check: %s', normalized_default_provider)
providers[normalized_default_provider] = True
for provider, active in providers.items():
if active:
health_check_providers.append(provider.capitalize())
LOG.info('Provider healthchecks: %s', health_check_providers)
if health_check_providers:
has_healthcheck = True
return ProviderHealthCheck(providers=health_check_providers, has_healthcheck=has_healthcheck)
def get_template_name(env, pipeline_type):
"""Generates the correct template name based on pipeline type
Args:
env (str): environment to generate templates for
pipeline_type (str): Type of pipeline like ec2 or lambda
Returns:
str: Name of template
"""
pipeline_base = 'pipeline/pipeline'
template_name_format = '{pipeline_base}'
if env.startswith('prod'):
template_name_format = template_name_format + '_{env}'
else:
template_name_format = template_name_format + '_stages'
if pipeline_type != 'ec2':
template_name_format = template_name_format + '_{pipeline_type}'
template_name_format = template_name_format + '.json.j2'
template_name = template_name_format.format(pipeline_base=pipeline_base, env=env, pipeline_type=pipeline_type)
return template_name
def construct_pipeline_block(env='',
generated=None,
previous_env='',
region='us-east-1',
settings=None,
pipeline_data=None,
region_subnets=None,
**kwargs):
"""Create the Pipeline JSON from template.
This handles the common repeatable patterns in a pipeline, such as
judgement, infrastructure, tagger and qe.
Note:
ASG Health Check type is overridden to `EC2` when deploying to **dev** or
using :ref:`eureka_enabled`.
Args:
env (str): Deploy environment name, e.g. dev, stage, prod.
generated (foremastutils.Generator): Foremast Application name generator.
kwargs (dict): Extra variables to pass to Pipeline Templates.
previous_env (str): The previous deploy environment to use as
Trigger.
region (str): AWS Region to deploy to.
settings (dict): Environment settings from configurations.
pipeline_data (dict): Pipeline settings from configurations
region_subnets (dict): Subnets for a Region, e.g.
{'us-west-2': ['us-west-2a', 'us-west-2b', 'us-west-2c']}.
Returns:
dict: Pipeline JSON template rendered with configurations.
"""
LOG.info('%s block for [%s].', env, region)
LOG.debug('%s info:\n%s', env, pformat(settings))
pipeline_type = pipeline_data['type']
if pipeline_type in EC2_PIPELINE_TYPES:
data = ec2_pipeline_setup(
generated=generated,
settings=settings,
env=env,
region=region,
pipeline_type=pipeline_type,
project=generated.project,
region_subnets=region_subnets,
)
else:
data = copy.deepcopy(settings)
approval_skip = verify_approval_skip(data, env, ENV_CONFIGS)
data['app'].update({
'appname': generated.app_name(),
'approval_skip': approval_skip,
'repo_name': generated.repo,
'group_name': generated.project,
'environment': env,
'region': region,
'previous_env': previous_env,
'promote_restrict': pipeline_data['promote_restrict'],
'owner_email': pipeline_data['owner_email'],
'pipeline': pipeline_data,
})
LOG.debug('Block data:\n%s', pformat(data))
template_name = get_template_name(env, pipeline_type)
pipeline_json = get_template(template_file=template_name, data=data, formats=generated, **kwargs)
return pipeline_json
def ec2_pipeline_setup(
generated=None,
project='',
settings=None,
env='',
pipeline_type='',
region='',
region_subnets=None,
):
"""Handles ec2 pipeline data setup
Args:
generated (foremastutils.Generator): Generated naming formats.
project (str): Group name of application
settings (dict): Environment settings from configurations.
env (str): Deploy environment name, e.g. dev, stage, prod.
pipeline_type (str): Type of Foremast Pipeline to configure.
region (str): AWS Region to deploy to.
region_subnets (dict): Subnets for a Region, e.g.
{'us-west-2': ['us-west-2a', 'us-west-2b', 'us-west-2c']}.
Returns:
dict: Updated settings to pass to templates for EC2 info
"""
data = copy.deepcopy(settings)
user_data = generate_encoded_user_data(
env=env,
region=region,
generated=generated,
group_name=project,
pipeline_type=pipeline_type,
)
# Use different variable to keep template simple
instance_security_groups = sorted(DEFAULT_EC2_SECURITYGROUPS[env])
instance_security_groups.append(generated.security_group_app)
instance_security_groups.extend(settings['security_group']['instance_extras'])
instance_security_groups = remove_duplicate_sg(instance_security_groups)
LOG.info('Instance security groups to attach: %s', instance_security_groups)
# check if scaling policy exists
if settings['asg']['scaling_policy']:
scalingpolicy = True
LOG.info('Found scaling policy')
else:
scalingpolicy = False
LOG.info('No scaling policy found')
if settings['app']['eureka_enabled']:
elb = []
else:
elb = [generated.elb_app]
LOG.info('Attaching the following ELB: %s', elb)
health_checks = check_provider_healthcheck(settings)
# Use EC2 Health Check for DEV or Eureka enabled
if env == 'dev' or settings['app']['eureka_enabled']:
data['asg'].update({'hc_type': 'EC2'})
LOG.info('Switching health check type to: EC2')
# Aggregate the default grace period, plus the exposed app_grace_period
# to allow per repo extension of asg healthcheck grace period
hc_grace_period = data['asg'].get('hc_grace_period')
app_grace_period = data['asg'].get('app_grace_period')
grace_period = hc_grace_period + app_grace_period
# TODO: Migrate the naming logic to an external library to make it easier
# to update in the future. foremast-utils looks like a good candidate
ssh_keypair = data['asg'].get('ssh_keypair', None)
if not ssh_keypair:
ssh_keypair = '{0}_{1}_default'.format(env, region)
LOG.info('SSH keypair (%s) used', ssh_keypair)
if settings['app']['canary']:
canary_user_data = generate_encoded_user_data(
env=env,
region=region,
generated=generated,
group_name=project,
canary=True,
)
data['app'].update({
'canary_encoded_user_data': canary_user_data,
})
data['asg'].update({
'hc_type': data['asg'].get('hc_type').upper(),
'hc_grace_period': grace_period,
'ssh_keypair': ssh_keypair,
'provider_healthcheck': json.dumps(health_checks.providers),
'enable_public_ips': json.dumps(settings['asg']['enable_public_ips']),
'has_provider_healthcheck': health_checks.has_healthcheck,
'asg_whitelist': ASG_WHITELIST,
})
data['app'].update({
'az_dict': json.dumps(region_subnets),
'encoded_user_data': user_data,
'instance_security_groups': json.dumps(instance_security_groups),
'elb': json.dumps(elb),
'scalingpolicy': scalingpolicy,
})
return data