Class: Bosh::Director::DeploymentPlan::Planner

Inherits:
Object
  • Object
show all
Includes:
Bosh::Director::DnsHelper, ValidationHelper
Defined in:
lib/bosh/director/deployment_plan/planner.rb

Constant Summary

Constants included from Bosh::Director::DnsHelper

Bosh::Director::DnsHelper::SOA, Bosh::Director::DnsHelper::TTL_4H, Bosh::Director::DnsHelper::TTL_5M

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ValidationHelper

#invalid_type, #safe_property

Methods included from Bosh::Director::DnsHelper

#add_default_dns_server, #canonical, #default_dns_server, #delete_dns_records, #delete_empty_domain, #dns_domain_name, #dns_ns_record, #dns_servers, #invalid_dns, #reverse_domain, #reverse_host, #update_dns_a_record, #update_dns_ptr_record

Constructor Details

#initialize(manifest, options = {}) ⇒ Planner

Returns a new instance of Planner.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 27

def initialize(manifest, options = {})
  @manifest = manifest
  @recreate = !!options['recreate']
  @job_states = safe_property(options, 'job_states',
                              :class => Hash, :default => {})

  @job_rename = safe_property(options, 'job_rename',
                              :class => Hash, :default => {})
  @unneeded_vms = []
  @unneeded_instances = []
  @dns_domain = nil

  @name = nil
  @canonical_name = nil
  @model = nil
end

Instance Attribute Details

#canonical_name ⇒ String (readonly)

Returns Deployment canonical name (for DNS).

Returns:

  • (String) —

    Deployment canonical name (for DNS)



12
13
14
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 12

def canonical_name
  @canonical_name
end

#compilation ⇒ Object

Returns the value of attribute compilation.



17
18
19
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 17

def compilation
  @compilation
end

#dns_domain ⇒ Object

Returns the value of attribute dns_domain.



21
22
23
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 21

def dns_domain
  @dns_domain
end

#job_rename ⇒ Object (readonly)

Returns the value of attribute job_rename.



24
25
26
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 24

def job_rename
  @job_rename
end

#jobs ⇒ Object (readonly)

Returns the value of attribute jobs.



23
24
25
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 23

def jobs
  @jobs
end

#model ⇒ Models::Deployment (readonly)

Returns Deployment DB model.

Returns:



14
15
16
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 14

def model
  @model
end

#name ⇒ String (readonly)

Returns Deployment name.

Returns:

  • (String) —

    Deployment name



10
11
12
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 10

def name
  @name
end

#properties ⇒ Object

Returns the value of attribute properties.



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

def properties
  @properties
end

#recreate ⇒ Object (readonly)

Returns the value of attribute recreate.



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

def recreate
  @recreate
end

#unneeded_instances ⇒ Object

Returns the value of attribute unneeded_instances.



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

def unneeded_instances
  @unneeded_instances
end

#unneeded_vms ⇒ Object

Returns the value of attribute unneeded_vms.



20
21
22
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 20

def unneeded_vms
  @unneeded_vms
end

#update ⇒ Object

Returns the value of attribute update.



18
19
20
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 18

def update
  @update
end

Instance Method Details

#bind_model ⇒ void

This method returns an undefined value.

Looks up deployment model in DB or creates one if needed



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 57

def bind_model
  if @name.nil? || @canonical_name.nil?
    raise DirectorError,
          'Unable to bind model, name and/or canonical name unknown'
  end

  attrs = {:name => @name}

  Models::Deployment.db.transaction do
    deployment = Models::Deployment.find(attrs)
    # Canonical uniqueness is not enforced in the DB
    if deployment.nil?
      Models::Deployment.each do |other|
        if canonical(other.name) == @canonical_name
          raise DeploymentCanonicalNameTaken,
                "Invalid deployment name `#{@name}', " +
                  'canonical name already taken'
        end
      end
      deployment = Models::Deployment.create(attrs)
    end
    @model = deployment
  end
end

#delete_instance(instance) ⇒ Object

Adds instance to deletion queue

Parameters:



145
146
147
148
149
150
151
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 145

def delete_instance(instance)
  if @jobs_name_index.has_key?(instance.job)
    @jobs_name_index[instance.job].unneeded_instances << instance
  else
    @unneeded_instances << instance
  end
end

#delete_vm(vm) ⇒ Object

Adds a VM to deletion queue

Parameters:



139
140
141
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 139

def delete_vm(vm)
  @unneeded_vms << vm
end

#job(name) ⇒ Bosh::Director::DeploymentPlan::Job

Returns a named job

Parameters:

  • name (String) —

    Job name

Returns:



94
95
96
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 94

def job(name)
  @jobs_name_index[name]
end

#network(name) ⇒ Bosh::Director::DeploymentPlan::Network

Returns a named network

Parameters:

  • name (String)

Returns:



107
108
109
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 107

def network(name)
  @networks[name]
end

#networks ⇒ Array<Bosh::Director::DeploymentPlan::Network>

Returns all networks in a deployment plan

Returns:



100
101
102
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 100

def networks
  @networks.values
end

#parse ⇒ Object 



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 44

def parse
  parse_name
  parse_properties
  parse_releases
  parse_networks
  parse_compilation
  parse_update
  parse_resource_pools
  parse_jobs
end

#parse_compilation ⇒ Object 



282
283
284
285
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 282

def parse_compilation
  @compilation = CompilationConfig.new(self, safe_property(
    @manifest, 'compilation', :class => Hash))
end

#parse_jobs ⇒ Object 



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

def parse_jobs
  @jobs = []
  @jobs_name_index = {}
  @jobs_canonical_name_index = Set.new

  jobs = safe_property(@manifest, 'jobs', :class => Array, :default => [])

  jobs.each do |job|
    state_overrides = @job_states[job['name']]

    if state_overrides
      job.recursive_merge!(state_overrides)
    end

    if rename_in_progress? && @job_rename['old_name'] == job['name']
      raise DeploymentRenamedJobNameStillUsed,
            "Renamed job `#{job['name']}' is still referenced in " +
              'deployment manifest'
    end

    job = Job.parse(self, job)

    if @jobs_canonical_name_index.include?(job.canonical_name)
      raise DeploymentCanonicalJobNameTaken,
            "Invalid job name `#{job.name}', canonical name already taken"
    end

    @jobs << job
    @jobs_name_index[job.name] = job
    @jobs_canonical_name_index << job.canonical_name
  end
end

#parse_name ⇒ Object 



157
158
159
160
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 157

def parse_name
  @name = safe_property(@manifest, 'name', :class => String)
  @canonical_name = canonical(@name)
end

#parse_networks ⇒ Object 



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

def parse_networks
  @networks = {}
  @networks_canonical_name_index = Set.new
  networks = safe_property(@manifest, 'networks', :class => Array)
  networks.each do |network_spec|
    type = safe_property(network_spec, 'type', :class => String,
                         :default => 'manual')
    case type
      when 'manual'
        network = ManualNetwork.new(self, network_spec)
      when 'dynamic'
        network = DynamicNetwork.new(self, network_spec)
      when 'vip'
        network = VipNetwork.new(self, network_spec)
      else
        raise DeploymentInvalidNetworkType,
              "Invalid network type `#{type}'"
    end

    if @networks_canonical_name_index.include?(network.canonical_name)
      raise DeploymentCanonicalNetworkNameTaken,
            "Invalid network name `#{network.name}', " +
              'canonical name already taken'
    end
    @networks[network.name] = network
    @networks_canonical_name_index << network.canonical_name
  end

  if @networks.empty?
    raise DeploymentNoNetworks, 'No networks specified'
  end
end

#parse_properties ⇒ Object 



162
163
164
165
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 162

def parse_properties
  @properties = safe_property(@manifest, 'properties',
                              :class => Hash, :default => {})
end

#parse_releases ⇒ Object 



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

def parse_releases
  release_specs = []

  if @manifest.has_key?('release')
    if @manifest.has_key?('releases')
      raise DeploymentAmbiguousReleaseSpec,
            "Deployment manifest contains both 'release' and 'releases' " +
              'sections, please use one of the two.'
    end
    release_specs << @manifest['release']
  else
    safe_property(@manifest, 'releases', :class => Array).each do |release|
      release_specs << release
    end
  end

  @releases = {}
  release_specs.each do |release_spec|
    release = ReleaseVersion.new(self, release_spec)
    if @releases.has_key?(release.name)
      raise DeploymentDuplicateReleaseName,
            "Duplicate release name `#{release.name}'"
    end
    @releases[release.name] = release
  end
end

#parse_resource_pools ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 194

def parse_resource_pools
  @resource_pools = {}
  resource_pools = safe_property(@manifest, 'resource_pools',
                                 :class => Array)
  resource_pools.each do |spec|
    resource_pool = ResourcePool.new(self, spec)
    if @resource_pools[resource_pool.name]
      raise DeploymentDuplicateResourcePoolName,
            "Duplicate resource pool name `#{resource_pool.name}'"
    end
    @resource_pools[resource_pool.name] = resource_pool
  end

  # Uncomment when integration test fixed
  # raise "No resource pools specified." if @resource_pools.empty?
end

#parse_update ⇒ Object 



277
278
279
280
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 277

def parse_update
  @update = UpdateConfig.new(
    safe_property(@manifest, 'update', :class => Hash))
end

#release(name) ⇒ Bosh::Director::DeploymentPlan::ReleaseVersion

Returns a named release

Returns:



132
133
134
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 132

def release(name)
  @releases[name]
end

#releases ⇒ Array<Bosh::Director::DeploymentPlan::ReleaseVersion>

Returns all releases in a deployment plan

Returns:



126
127
128
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 126

def releases
  @releases.values
end

#rename_in_progress? ⇒ Boolean

Returns:

  • (Boolean) 


153
154
155
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 153

def rename_in_progress?
  @job_rename['old_name'] && @job_rename['new_name']
end

#resource_pool(name) ⇒ Bosh::Director::DeploymentPlan::ResourcePool

Returns a named resource pool spec

Parameters:

  • name (String) —

    Resource pool name

Returns:



120
121
122
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 120

def resource_pool(name)
  @resource_pools[name]
end

#resource_pools ⇒ Array<Bosh::Director::DeploymentPlan::ResourcePool>

Returns all resource pools in a deployment plan

Returns:



113
114
115
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 113

def resource_pools
  @resource_pools.values
end

#vms ⇒ Array<Models::Vm>

Returns a list of VMs in the deployment (according to DB)

Returns:



84
85
86
87
88
89
 
# File 'lib/bosh/director/deployment_plan/planner.rb', line 84

def vms
  if @model.nil?
    raise DirectorError, "Can't get VMs list, deployment model is unbound"
  end
  @model.vms
end