-
Notifications
You must be signed in to change notification settings - Fork 115
/
deploy_task.rb
373 lines (329 loc) · 13.4 KB
/
deploy_task.rb
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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# frozen_string_literal: true
require 'yaml'
require 'shellwords'
require 'tempfile'
require 'fileutils'
require 'krane/annotation'
require 'krane/common'
require 'krane/concurrency'
require 'krane/resource_cache'
require 'krane/kubernetes_resource'
%w(
custom_resource
config_map
deployment
ingress
persistent_volume_claim
pod
network_policy
service
pod_template
pod_disruption_budget
replica_set
service_account
daemon_set
resource_quota
stateful_set
cron_job
job
custom_resource_definition
horizontal_pod_autoscaler
secret
).each do |subresource|
require "krane/kubernetes_resource/#{subresource}"
end
require 'krane/resource_watcher'
require 'krane/kubectl'
require 'krane/kubeclient_builder'
require 'krane/ejson_secret_provisioner'
require 'krane/renderer'
require 'krane/cluster_resource_discovery'
require 'krane/template_sets'
require 'krane/deploy_task_config_validator'
require 'krane/resource_deployer'
require 'krane/concerns/template_reporting'
module Krane
# Ship resources to a namespace
class DeployTask
extend Krane::StatsD::MeasureMethods
include Krane::TemplateReporting
PROTECTED_NAMESPACES = %w(
default
kube-system
kube-public
)
def predeploy_sequence
default_group = { group: nil }
before_crs = %w(
ResourceQuota
NetworkPolicy
ConfigMap
PersistentVolumeClaim
ServiceAccount
Role
RoleBinding
Secret
).map { |r| [r, default_group] }
after_crs = %w(
Pod
).map { |r| [r, default_group] }
crs = cluster_resource_discoverer.crds.select(&:predeployed?).map { |cr| [cr.kind, { group: cr.group }] }
Hash[before_crs + crs + after_crs]
end
def prune_allowlist
cluster_resource_discoverer.prunable_resources(namespaced: true)
end
def server_version
kubectl.server_version
end
attr_reader :task_config
delegate :kubeclient_builder, to: :task_config
# Initializes the deploy task
#
# @param namespace [String] Kubernetes namespace (*required*)
# @param context [String] Kubernetes context (*required*)
# @param current_sha [String] The SHA of the commit
# @param logger [Object] Logger object (defaults to an instance of Krane::FormattedLogger)
# @param kubectl_instance [Kubectl] Kubectl instance
# @param bindings [Hash] Bindings parsed by Krane::BindingsParser
# @param global_timeout [Integer] Timeout in seconds
# @param selector [Hash] Selector(s) parsed by Krane::LabelSelector
# @param selector_as_filter [Boolean] Allow selecting a subset of Kubernetes resource templates to deploy
# @param filenames [Array<String>] An array of filenames and/or directories containing templates (*required*)
# @param protected_namespaces [Array<String>] Array of protected Kubernetes namespaces (defaults
# to Krane::DeployTask::PROTECTED_NAMESPACES)
# @param render_erb [Boolean] Enable ERB rendering
def initialize(namespace:, context:, current_sha: nil, logger: nil, kubectl_instance: nil, bindings: {},
global_timeout: nil, selector: nil, selector_as_filter: false, filenames: [], protected_namespaces: nil,
render_erb: false, kubeconfig: nil)
@logger = logger || Krane::FormattedLogger.build(namespace, context)
@template_sets = TemplateSets.from_dirs_and_files(paths: filenames, logger: @logger, render_erb: render_erb)
@task_config = Krane::TaskConfig.new(context, namespace, @logger, kubeconfig)
@bindings = bindings
@namespace = namespace
@namespace_tags = []
@context = context
@current_sha = current_sha
@kubectl = kubectl_instance
@global_timeout = global_timeout
@selector = selector
@selector_as_filter = selector_as_filter
@protected_namespaces = protected_namespaces || PROTECTED_NAMESPACES
@render_erb = render_erb
end
# Runs the task, returning a boolean representing success or failure
#
# @return [Boolean]
def run(**args)
run!(**args)
true
rescue FatalDeploymentError
false
end
# Runs the task, raising exceptions in case of issues
#
# @param verify_result [Boolean] Wait for completion and verify success
# @param prune [Boolean] Enable deletion of resources that do not appear in the template dir
#
# @return [nil]
def run!(verify_result: true, prune: true)
start = Time.now.utc
@logger.reset
@logger.phase_heading("Initializing deploy")
validate_configuration(prune: prune)
resources = discover_resources
validate_resources(resources)
@logger.phase_heading("Checking initial resource statuses")
check_initial_status(resources)
if deploy_has_priority_resources?(resources)
@logger.phase_heading("Predeploying priority resources")
resource_deployer.predeploy_priority_resources(resources, predeploy_sequence)
end
@logger.phase_heading("Deploying all resources")
if @protected_namespaces.include?(@namespace) && prune
raise FatalDeploymentError, "Refusing to deploy to protected namespace '#{@namespace}' with pruning enabled"
end
resource_deployer.deploy!(resources, verify_result, prune)
StatsD.client.event("Deployment of #{@namespace} succeeded",
"Successfully deployed all #{@namespace} resources to #{@context}",
alert_type: "success", tags: statsd_tags + %w(status:success))
StatsD.client.distribution('all_resources.duration', StatsD.duration(start),
tags: statsd_tags + %w(status:success))
@logger.print_summary(:success)
rescue DeploymentTimeoutError
@logger.print_summary(:timed_out)
StatsD.client.event("Deployment of #{@namespace} timed out",
"One or more #{@namespace} resources failed to deploy to #{@context} in time",
alert_type: "error", tags: statsd_tags + %w(status:timeout))
StatsD.client.distribution('all_resources.duration', StatsD.duration(start),
tags: statsd_tags + %w(status:timeout))
raise
rescue FatalDeploymentError => error
@logger.summary.add_action(error.message) if error.message != error.class.to_s
@logger.print_summary(:failure)
StatsD.client.event("Deployment of #{@namespace} failed",
"One or more #{@namespace} resources failed to deploy to #{@context}",
alert_type: "error", tags: statsd_tags + %w(status:failed))
StatsD.client.distribution('all_resources.duration', StatsD.duration(start),
tags: statsd_tags + %w(status:failed))
raise
end
private
def resource_deployer
@resource_deployer ||= Krane::ResourceDeployer.new(task_config: @task_config,
prune_allowlist: prune_allowlist, global_timeout: @global_timeout,
selector: @selector, statsd_tags: statsd_tags, current_sha: @current_sha)
end
def cluster_resource_discoverer
@cluster_resource_discoverer ||= ClusterResourceDiscovery.new(
task_config: @task_config,
namespace_tags: @namespace_tags
)
end
def ejson_provisioners
@ejson_provisoners ||= @template_sets.ejson_secrets_files.map do |ejson_secret_file|
EjsonSecretProvisioner.new(
task_config: @task_config,
ejson_keys_secret: ejson_keys_secret,
ejson_file: ejson_secret_file,
statsd_tags: @namespace_tags,
selector: @selector,
)
end
end
def deploy_has_priority_resources?(resources)
resources.any? do |r|
next unless (pr = predeploy_sequence[r.type])
!pr[:group] || pr[:group] == r.group
end
end
def check_initial_status(resources)
cache = ResourceCache.new(@task_config)
cache.prewarm(resources)
Krane::Concurrency.split_across_threads(resources) { |r| r.sync(cache) }
resources.each { |r| @logger.info(r.pretty_status) }
end
measure_method(:check_initial_status, "initial_status.duration")
def secrets_from_ejson
ejson_provisioners.flat_map(&:resources)
end
def discover_resources
@logger.info("Discovering resources:")
resources = []
crds_by_kind = cluster_resource_discoverer.crds.group_by(&:kind)
@template_sets.with_resource_definitions(current_sha: @current_sha, bindings: @bindings) do |r_def|
crd = crds_by_kind[r_def["kind"]]&.first
r = KubernetesResource.build(namespace: @namespace, context: @context, logger: @logger, definition: r_def,
statsd_tags: @namespace_tags, crd: crd, global_names: @task_config.global_kinds)
resources << r
@logger.info(" - #{r.id}")
end
secrets_from_ejson.each do |secret|
resources << secret
@logger.info(" - #{secret.id} (from ejson)")
end
StatsD.client.gauge('discover_resources.count', resources.size, tags: statsd_tags)
if resources.empty?
raise FatalDeploymentError, "No deployable resources were found!"
end
resources.sort
rescue InvalidTemplateError => e
record_invalid_template(logger: @logger, err: e.message, filename: e.filename,
content: e.content)
raise FatalDeploymentError, "Failed to render and parse template"
end
measure_method(:discover_resources)
def validate_configuration(prune:)
task_config_validator = DeployTaskConfigValidator.new(@protected_namespaces, prune,
@task_config, kubectl, kubeclient_builder)
errors = []
errors += task_config_validator.errors
errors += @template_sets.validate
unless errors.empty?
add_para_from_list(logger: @logger, action: "Configuration invalid", enum: errors)
raise Krane::TaskConfigurationError
end
confirm_ejson_keys_not_prunable if prune
@logger.info("Using resource selector #{@selector}") if @selector
@logger.info("Only deploying resources filtered by labels in selector") if @selector && @selector_as_filter
@namespace_tags |= tags_from_namespace_labels
@logger.info("All required parameters and files are present")
end
measure_method(:validate_configuration)
def validate_resources(resources)
validate_globals(resources)
resources.select! { |r| r.selected?(@selector) } if @selector_as_filter
Krane::Concurrency.split_across_threads(resources) do |r|
r.validate_definition(kubectl: kubectl, selector: @selector, dry_run: true)
end
failed_resources = resources.select(&:validation_failed?)
if failed_resources.present?
failed_resources.each do |r|
content = File.read(r.file_path) if File.file?(r.file_path) && !r.sensitive_template_content?
record_invalid_template(logger: @logger, err: r.validation_error_msg,
filename: File.basename(r.file_path), content: content)
end
raise FatalDeploymentError, "Template validation failed"
end
end
measure_method(:validate_resources)
def validate_globals(resources)
return unless (global = resources.select(&:global?).presence)
global_names = global.map do |resource|
"#{resource.name} (#{resource.type}) in #{File.basename(resource.file_path)}"
end
global_names = FormattedLogger.indent_four(global_names.join("\n"))
@logger.summary.add_paragraph(ColorizedString.new("Global resources:\n#{global_names}").yellow)
raise FatalDeploymentError, "This command is namespaced and cannot be used to deploy global resources. "\
"Use GlobalDeployTask instead."
end
def namespace_definition
@namespace_definition ||= begin
definition, _err, st = kubectl.run("get", "namespace", @namespace, use_namespace: false,
log_failure: true, raise_if_not_found: true, attempts: 3, output: 'json')
st.success? ? MultiJson.load(definition, symbolize_names: true) : nil
end
rescue Kubectl::ResourceNotFoundError
nil
end
# make sure to never prune the ejson-keys secret
def confirm_ejson_keys_not_prunable
return unless ejson_keys_secret.dig("metadata", "annotations", KubernetesResource::LAST_APPLIED_ANNOTATION)
@logger.error("Deploy cannot proceed because protected resource " \
"Secret/#{EjsonSecretProvisioner::EJSON_KEYS_SECRET} would be pruned.")
raise EjsonPrunableError
rescue Kubectl::ResourceNotFoundError => e
@logger.debug("Secret/#{EjsonSecretProvisioner::EJSON_KEYS_SECRET} does not exist: #{e}")
end
def tags_from_namespace_labels
return [] if namespace_definition.blank?
namespace_labels = namespace_definition.fetch(:metadata, {}).fetch(:labels, {})
namespace_labels.map { |key, value| "#{key}:#{value}" }
end
def kubectl
@kubectl ||= Kubectl.new(task_config: @task_config, log_failure_by_default: true)
end
def ejson_keys_secret
@ejson_keys_secret ||= begin
out, err, st = kubectl.run("get", "secret", EjsonSecretProvisioner::EJSON_KEYS_SECRET, output: "json",
raise_if_not_found: true, attempts: 3, output_is_sensitive: true, log_failure: true)
unless st.success?
raise EjsonSecretError, "Error retrieving Secret/#{EjsonSecretProvisioner::EJSON_KEYS_SECRET}: #{err}"
end
MultiJson.load(out)
end
end
def statsd_tags
tags = %W(namespace:#{@namespace} context:#{@context}) | @namespace_tags
@current_sha.nil? ? tags : %W(sha:#{@current_sha}) | tags
end
def with_retries(limit)
retried = 0
while retried <= limit
success = yield
break if success
retried += 1
end
end
end
end