Class: Bosh::Director::DeploymentPlan::Job

Inherits:
Object
  • Object
show all
Includes:
Common::PropertyHelper
Defined in:
lib/bosh/director/deployment_plan/job.rb

Constant Summary collapse

VALID_JOB_STATES =

started, stopped and detached are real states (persisting in DB and reflecting target instance state) recreate and restart are two virtual states (both set target instance state to “started” and set appropriate instance spec modifiers)

%w(started stopped detached recreate restart)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(deployment) ⇒ Job

Returns a new instance of Job.

Parameters:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 78

def initialize(deployment)
  @deployment = deployment

  @release = nil
  @templates = []
  @all_properties = nil # All properties available to job
  @properties = nil # Actual job properties

  @instances = []
  @unneeded_instances = []
  @instance_states = {}

  @error_mutex = Mutex.new
  @packages = {}
  @halt = false
end

Instance Attribute Details

#all_properties ⇒ Object

Returns the value of attribute all_properties.



67
68
69
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 67

def all_properties
  @all_properties
end

#canonical_name ⇒ String

Returns Job canonical name (mostly for DNS).

Returns:

  • (String) —

    Job canonical name (mostly for DNS)



19
20
21
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 19

def canonical_name
  @canonical_name
end

#default_network ⇒ DeploymentPlan::Network Job default network

Returns DeploymentPlan::Network Job default network.

Returns:



35
36
37
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 35

def default_network
  @default_network
end

#deployment ⇒ DeploymentPlan

Returns Current deployment plan.

Returns:



25
26
27
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 25

def deployment
  @deployment
end

#halt_exception ⇒ Exception

Returns Exception that requires job update process to be interrupted.

Returns:

  • (Exception) —

    Exception that requires job update process to be interrupted



65
66
67
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 65

def halt_exception
  @halt_exception
end

#instance_states ⇒ Hash<Integer, String>

Returns Individual instance expected states.

Returns:

  • (Hash<Integer, String>) —

    Individual instance expected states



61
62
63
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 61

def instance_states
  @instance_states
end

#instances ⇒ Array<DeploymentPlan::Instance>

Returns All job instances.

Returns:



51
52
53
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 51

def instances
  @instances
end

#name ⇒ String

Returns Job name.

Returns:

  • (String) —

    Job name



16
17
18
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 16

def name
  @name
end

#packages ⇒ Hash<String, DeploymentPlan::Package] Packages included into this job

Returns Hash<String, DeploymentPlan::Package] Packages included into this job.

Returns:

  • (Hash<String, DeploymentPlan::Package] Packages included into this job) —

    Hash<String, DeploymentPlan::Package] Packages included into this job



45
46
47
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 45

def packages
  @packages
end

#persistent_disk ⇒ Integer

Returns Persistent disk size (no disk if zero).

Returns:

  • (Integer) —

    Persistent disk size (no disk if zero)



22
23
24
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 22

def persistent_disk
  @persistent_disk
end

#properties ⇒ Hash

Returns Job properties.

Returns:

  • (Hash) —

    Job properties



41
42
43
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 41

def properties
  @properties
end

#release ⇒ DeploymentPlan::ReleaseVersion

Returns Release this job belongs to.

Returns:



28
29
30
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 28

def release
  @release
end

#resource_pool ⇒ DeploymentPlan::ResourcePool

Returns Resource pool this job should be run in.

Returns:



32
33
34
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 32

def resource_pool
  @resource_pool
end

#state ⇒ String

Returns Expected job state.

Returns:

  • (String) —

    Expected job state



58
59
60
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 58

def state
  @state
end

#templates ⇒ Array<DeploymentPlan::Template] Templates included into the job

Returns Array<DeploymentPlan::Template] Templates included into the job.

Returns:



38
39
40
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 38

def templates
  @templates
end

#unneeded_instances ⇒ Array<Models::Instance>

Returns List of excess instance models that are not needed for current deployment.

Returns:

  • (Array<Models::Instance>) —

    List of excess instance models that are not needed for current deployment



55
56
57
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 55

def unneeded_instances
  @unneeded_instances
end

#update ⇒ DeploymentPlan::UpdateConfig

Returns Job update settings.

Returns:



48
49
50
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 48

def update
  @update
end

Class Method Details

.convert_from_legacy_spec(job_spec) ⇒ Object

Takes in a job spec and returns a job spec in the new format, if it needs to be modified. The new format has “templates” key, which is an array with each template’s data. This is used for job collocation, specifically for the agent’s current job spec when compared to the director’s. We only convert their template to a single array entry because it should be impossible for the agent to have a job spec with multiple templates in legacy form.



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 106

def self.convert_from_legacy_spec(job_spec)
  return job_spec if !self.is_legacy_spec?(job_spec)
  template = {
    "name" => job_spec["template"],
    "version" => job_spec["version"],
    "sha1" => job_spec["sha1"],
    "blobstore_id" => job_spec["blobstore_id"]
  }
  job_spec["templates"] = [template]
end

.is_legacy_spec?(job_spec) ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 95

def self.is_legacy_spec?(job_spec)
  !job_spec.has_key?("templates")
end

.parse(deployment, job_spec) ⇒ Bosh::Director::DeploymentPlan::Job

Parameters:

Returns:



72
73
74
75
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 72

def self.parse(deployment, job_spec)
  job_parser = JobSpecParser.new(deployment)
  job_parser.parse(job_spec)
end

Instance Method Details

#bind_properties ⇒ Object

Extracts only the properties needed by this job. This is decoupled from parsing properties because templates need to be bound to their models before ‘bind_properties’ is being called (as we persist job template property definitions in DB).



201
202
203
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 201

def bind_properties
  @properties = filter_properties(@all_properties)
end

#instance(index) ⇒ DeploymentPlan::Instance

Returns job instance by index

Parameters:

  • index (Integer)

Returns:



167
168
169
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 167

def instance(index)
  @instances[index]
end

#instance_state(index) ⇒ String?

Returns the state state of job instance by its index

Parameters:

  • index (Integer) —

    Instance index

Returns:

  • (String, nil) —

    Instance state (nil if not specified)



174
175
176
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 174

def instance_state(index)
  @instance_states[index] || @state
end

#package_spec ⇒ Hash<String, Hash>

Returns package specs for all packages in the job indexed by package name. To be used by all instances of the job to populate agent state.

Returns:

  • (Hash<String, Hash>) —

    All package specs indexed by package name



155
156
157
158
159
160
161
162
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 155

def package_spec
  result = {}
  @packages.each do |name, package|
    result[name] = package.spec
  end

  result.select { |name, _| run_time_dependencies.include? name }
end

#record_update_error(error, options = {}) ⇒ Object 



190
191
192
193
194
195
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 190

def record_update_error(error, options = {})
  @error_mutex.synchronize do
    @halt = true
    @halt_exception = error
  end
end

#should_halt? ⇒ Boolean

Returns:

  • (Boolean) 


186
187
188
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 186

def should_halt?
  @halt
end

#spec ⇒ Hash

Returns job spec as a Hash. To be used by all instances of the job to populate agent state.

Returns:

  • (Hash) —

    Hash representation



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
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 120

def spec
  first_template = @templates[0]
  result = {
    "name" => @name,
    "templates" => [],
    # --- Legacy ---
    "template" => first_template.name,
    "version" => first_template.version,
    "sha1" => first_template.sha1,
    "blobstore_id" => first_template.blobstore_id
  }
  if first_template.logs
    result["logs"] = first_template.logs
  end
  # --- /Legacy ---

  @templates.each do |template|
    template_entry = {
      "name" => template.name,
      "version" => template.version,
      "sha1" => template.sha1,
      "blobstore_id" => template.blobstore_id
    }
    if template.logs
      template_entry["logs"] = template.logs
    end
    result["templates"] << template_entry
  end

  result
end

#use_compiled_package(compiled_package_model) ⇒ void

This method returns an undefined value.

Registers compiled package with this job.

Parameters:



181
182
183
184
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 181

def use_compiled_package(compiled_package_model)
  compiled_package = CompiledPackage.new(compiled_package_model)
  @packages[compiled_package.name] = compiled_package
end

#validate_package_names_do_not_collide! ⇒ Object 



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
 
# File 'lib/bosh/director/deployment_plan/job.rb', line 205

def validate_package_names_do_not_collide!
  releases_by_package_names = templates
    .reduce([]) { |memo, t| memo + t.model.package_names.product([t.release]) }
    .reduce({}) { |memo, package_name_and_release_version|
      package_name = package_name_and_release_version.first
      release_version = package_name_and_release_version.last
      memo[package_name] ||= Set.new
      memo[package_name] << release_version
      memo
    }

  releases_by_package_names.each do |package_name, releases|
    if releases.size > 1
      release1, release2 = releases.to_a[0..1]
      offending_template1 = templates.find { |t| t.release == release1 }
      offending_template2 = templates.find { |t| t.release == release2 }

      raise JobPackageCollision,
            "Package name collision detected in job `#{@name}': "\
            "template `#{release1.name}/#{offending_template1.name}' depends on package `#{release1.name}/#{package_name}', "\
            "template `#{release2.name}/#{offending_template2.name}' depends on `#{release2.name}/#{package_name}'. " +
            'BOSH cannot currently collocate two packages with identical names from separate releases.'
    end
  end
end