Class: KubernetesDeploy::DeployTask

Inherits:
Object
  • Object
show all
Includes:
KubeclientBuilder
Defined in:
lib/kubernetes-deploy/deploy_task.rb

Constant Summary collapse

PREDEPLOY_SEQUENCE = 
%w(
  ResourceQuota
  Cloudsql
  Redis
  Memcached
  Bugsnag
  ConfigMap
  PersistentVolumeClaim
  ServiceAccount
  Pod
)
PROTECTED_NAMESPACES = 
%w(
  default
  kube-system
  kube-public
)
NOT_FOUND_ERROR = 
'NotFound'

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DeployTask.



94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 94

def initialize(namespace:, context:, current_sha:, template_dir:, logger:, kubectl_instance: nil, bindings: {})
  @namespace = namespace
  @context = context
  @current_sha = current_sha
  @template_dir = File.expand_path(template_dir)
  @logger = logger
  @kubectl = kubectl_instance
  @bindings = bindings
  # Max length of podname is only 63chars so try to save some room by truncating sha to 8 chars
  @id = current_sha[0...8] + "-#{SecureRandom.hex(4)}" if current_sha
end

Instance Method Details

#prune_whitelist ⇒ 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 core/v1/Secret – should not committed / managed by shipit



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 69

def prune_whitelist
  wl = %w(
    core/v1/ConfigMap
    core/v1/Pod
    core/v1/Service
    batch/v1/Job
    extensions/v1beta1/DaemonSet
    extensions/v1beta1/Deployment
    apps/v1beta1/Deployment
    extensions/v1beta1/Ingress
    apps/v1beta1/StatefulSet
    autoscaling/v1/HorizontalPodAutoscaler
  )
  if server_version >= Gem::Version.new('1.8.0')
    wl << "batch/v1beta1/CronJob"
  end
  wl
end

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



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

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)
  confirm_context_exists
  confirm_namespace_exists
  resources = discover_resources
  validate_definitions(resources)

  @logger.phase_heading("Checking initial resource statuses")
  KubernetesDeploy::Concurrency.split_across_threads(resources, &:sync)
  resources.each { |r| @logger.info(r.pretty_status) }

  ejson = EjsonSecretProvisioner.new(
    namespace: @namespace,
    context: @context,
    template_dir: @template_dir,
    logger: @logger,
    prune: prune,
  )
  if ejson.secret_changes_required?
    @logger.phase_heading("Deploying kubernetes secrets from #{EjsonSecretProvisioner::EJSON_SECRETS_FILE}")
    ejson.run
  end

  if deploy_has_priority_resources?(resources)
    @logger.phase_heading("Predeploying priority resources")
    start_priority_resource = Time.now.utc
    predeploy_priority_resources(resources)
    ::StatsD.measure('priority_resources.duration', StatsD.duration(start_priority_resource), tags: statsd_tags)
  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
    start_normal_resource = Time.now.utc
    deploy_resources(resources, prune: prune, verify: true)
    ::StatsD.measure('normal_resources.duration', StatsD.duration(start_normal_resource), tags: statsd_tags)
    success = resources.all?(&:deploy_succeeded?)
  else
    deploy_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)
    success = true
  end
rescue FatalDeploymentError => error
  @logger.summary.add_action(error.message)
  success = false
ensure
  @logger.print_summary(success)
  status = success ? "success" : "failed"
  ::StatsD.measure('all_resources.duration', StatsD.duration(start), tags: statsd_tags << "status:#{status}")
  success
end

#server_version ⇒ Object 



88
89
90
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 88

def server_version
  kubectl.server_version
end

#template_variables ⇒ Object 



170
171
172
173
174
175
 
# File 'lib/kubernetes-deploy/deploy_task.rb', line 170

def template_variables
  {
    'current_sha' => @current_sha,
    'deployment_id' => @id,
  }.merge(@bindings)
end