Class: KubernetesDeploy::DeployTask

Inherits:
Object
  • Object
show all
Extended by:
StatsD::MeasureMethods
Defined in:
lib/kubernetes-deploy/deploy_task.rb

Constant Summary collapse

PROTECTED_NAMESPACES = 
%w(
  default
  kube-system
  kube-public
)

Instance Method Summary collapse

Methods included from StatsD::MeasureMethods

measure_method

Constructor Details

#initialize(namespace:, context:, current_sha:, template_dir:, logger:, kubectl_instance: nil, bindings: {}, max_watch_seconds: nil, selector: nil) ⇒ DeployTask

Returns a new instance of DeployTask.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 105

def initialize(namespace:, context:, current_sha:, template_dir:, logger:, kubectl_instance: nil, bindings: {},
  max_watch_seconds: nil, selector: nil)
  @namespace = namespace
  @namespace_tags = []
  @context = context
  @current_sha = current_sha
  @template_dir = File.expand_path(template_dir)
  @logger = logger
  @kubectl = kubectl_instance
  @max_watch_seconds = max_watch_seconds
  @renderer = KubernetesDeploy::Renderer.new(
    current_sha: @current_sha,
    template_dir: @template_dir,
    logger: @logger,
    bindings: bindings,
  )
  @selector = selector
end

Instance Method Details

#predeploy_sequence ⇒ Object

Things removed from default prune whitelist at github.com/kubernetes/kubernetes/blob/0dff56b4d88ec7551084bf89028dbeebf569620e/pkg/kubectl/cmd/apply.go#L411: core/v1/Namespace – not namespaced core/v1/PersistentVolume – not namespaced core/v1/Endpoints – managed by services core/v1/PersistentVolumeClaim – would delete data core/v1/ReplicationController – superseded by deployments/replicasets extensions/v1beta1/ReplicaSet – managed by deployments



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 63

def predeploy_sequence
  before_crs = %w(
    ResourceQuota
    NetworkPolicy
  )
  after_crs = %w(
    ConfigMap
    PersistentVolumeClaim
    ServiceAccount
    Role
    RoleBinding
    Secret
    Pod
  )

  before_crs + cluster_resource_discoverer.crds.map(&:kind) + after_crs
end

#prune_whitelist ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 81

def prune_whitelist
  wl = %w(
    core/v1/ConfigMap
    core/v1/Pod
    core/v1/Service
    core/v1/ResourceQuota
    core/v1/Secret
    batch/v1/Job
    extensions/v1beta1/DaemonSet
    extensions/v1beta1/Deployment
    extensions/v1beta1/Ingress
    networking.k8s.io/v1/NetworkPolicy
    apps/v1beta1/StatefulSet
    autoscaling/v1/HorizontalPodAutoscaler
    policy/v1beta1/PodDisruptionBudget
    batch/v1beta1/CronJob
  )
  wl + cluster_resource_discoverer.crds.select(&:prunable?).map(&:group_version_kind)
end

#run(*args) ⇒ Object 



124
125
126
127
128
129
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 124

def run(*args)
  run!(*args)
  true
rescue FatalDeploymentError
  false
end

#run!(verify_result: true, allow_protected_ns: false, prune: true) ⇒ Object 



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
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 131

def run!(verify_result: true, allow_protected_ns: false, prune: true)
  start = Time.now.utc
  @logger.reset

  @logger.phase_heading("Initializing deploy")
  validate_configuration(allow_protected_ns: allow_protected_ns, 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")
    predeploy_priority_resources(resources)
  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

  if verify_result
    deploy_all_resources(resources, prune: prune, verify: true)
    failed_resources = resources.reject(&:deploy_succeeded?)
    success = failed_resources.empty?
    if !success && failed_resources.all?(&:deploy_timed_out?)
      raise DeploymentTimeoutError
    end
    raise FatalDeploymentError unless success
  else
    deploy_all_resources(resources, prune: prune, verify: false)
    @logger.summary.add_action("deployed #{resources.length} #{'resource'.pluralize(resources.length)}")
    warning = <<~MSG
      Deploy result verification is disabled for this deploy.
      This means the desired changes were communicated to Kubernetes, but the deploy did not make sure they actually succeeded.
    MSG
    @logger.summary.add_paragraph(ColorizedString.new(warning).yellow)
  end
  StatsD.event("Deployment of #{@namespace} succeeded",
    "Successfully deployed all #{@namespace} resources to #{@context}",
    alert_type: "success", tags: statsd_tags << "status:success")
  StatsD.distribution('all_resources.duration', StatsD.duration(start), tags: statsd_tags << "status:success")
  @logger.print_summary(:success)
rescue DeploymentTimeoutError
  @logger.print_summary(:timed_out)
  StatsD.event("Deployment of #{@namespace} timed out",
    "One or more #{@namespace} resources failed to deploy to #{@context} in time",
    alert_type: "error", tags: statsd_tags << "status:timeout")
  StatsD.distribution('all_resources.duration', StatsD.duration(start), tags: statsd_tags << "status:timeout")
  raise
rescue FatalDeploymentError => error
  @logger.summary.add_action(error.message) if error.message != error.class.to_s
  @logger.print_summary(:failure)
  StatsD.event("Deployment of #{@namespace} failed",
    "One or more #{@namespace} resources failed to deploy to #{@context}",
    alert_type: "error", tags: statsd_tags << "status:failed")
  StatsD.distribution('all_resources.duration', StatsD.duration(start), tags: statsd_tags << "status:failed")
  raise
end

#server_version ⇒ Object 



101
102
103
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 101

def server_version
  kubectl.server_version
end