Class: TungstenInstall

Inherits:
Object
  • Object
show all
Defined in:
lib/tungsten/install.rb

Defined Under Namespace

Classes: TungstenTopology

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_path) ⇒ TungstenInstall

Returns a new instance of TungstenInstall.



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
 
# File 'lib/tungsten/install.rb', line 2

def initialize(base_path)
  unless self.class.is_installed?(base_path)
    raise "Unable to use #{base_path} because it is not an installed Tungsten directory"
  end
  
  @root = TU.cmd_result("cat #{base_path}/.lock")
  TU.debug("Initialize #{self.class.name} from #{@root}")
  @settings = {}
  @topology = nil
  
  begin
    @has_tpm = (TU.cmd_result("#{tpm()} query staging") != "")
    if @has_tpm == false
      @has_tpm = (TU.cmd_result("#{tpm()} query dataservices") != "")
    end
  rescue
    @has_tpm = false
  end
  
  # Preload settings about this installation
  if use_tpm?()
    # Pull the values from tpm
    settings([
      "user",
      "host_name",
      HOST_ENABLE_REPLICATOR,
      HOST_ENABLE_MANAGER,
      HOST_ENABLE_CONNECTOR,
      REPL_RMI_PORT,
      MGR_RMI_PORT,
      MGR_API,
      MGR_API_PORT,
      MGR_API_ADDRESS,
      "preferred_path"
      ])
  else
    # Read the values from files
    setting(HOST_ENABLE_REPLICATOR, "true")
    setting(HOST_ENABLE_MANAGER, "false")
    setting(HOST_ENABLE_CONNECTOR, "false")
    setting(REPL_RMI_PORT, TU.cmd_result("grep rmi_port #{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-replicator/conf/services.properties | grep -v '^#' | awk -F= '{print $2}' | tr -d ' '"))
    setting("host_name", TU.cmd_result("egrep '^replicator.host=' #{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-replicator/conf/services.properties | awk -F= '{print $2}'"))
  end
end

Class Method Details

.get(path) ⇒ Object 



468
469
470
471
472
473
474
 
# File 'lib/tungsten/install.rb', line 468

def self.get(path)
  @@instances ||= {}
  unless @@instances.has_key?(path)
    @@instances[path] = TungstenInstall.new(path)
  end
  return @@instances[path]
end

.is_installed?(base_path) ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
50
51
52
53
 
# File 'lib/tungsten/install.rb', line 47

def self.is_installed?(base_path)
  if File.exists?("#{base_path}/.manifest") && File.exists?("#{base_path}/.lock")
    return true
  else
    return false
  end
end

Instance Method Details

#base_path ⇒ Object

Path to the current running version of Continuent Tungsten.



62
63
64
 
# File 'lib/tungsten/install.rb', line 62

def base_path
  "#{@root}/#{CURRENT_RELEASE_DIRECTORY}"
end

#can_sql?(service, use_direct_extractor = false) ⇒ Boolean

Returns:

  • (Boolean) 


368
369
370
371
372
373
374
375
376
377
 
# File 'lib/tungsten/install.rb', line 368

def can_sql?(service, use_direct_extractor = false)
  case datasource_type(service, use_direct_extractor)
  when "mysql"
    return true
  when "redshift"
    return true
  else
    return false
  end
end

#cctrl ⇒ Object 



196
197
198
 
# File 'lib/tungsten/install.rb', line 196

def cctrl
  "#{tungsten_sudo_prefix()}#{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-manager/bin/cctrl -expert -port #{setting(MGR_RMI_PORT)}"
end

#check_sql_results(results) ⇒ Object 



459
460
461
462
463
464
465
466
 
# File 'lib/tungsten/install.rb', line 459

def check_sql_results(results)
  results.each{
    |r|
    if r["error"] != nil
      raise r["error"]
    end
  }
end

#dataservices ⇒ Object 



75
76
77
78
79
80
81
82
83
 
# File 'lib/tungsten/install.rb', line 75

def dataservices
  ds_list = TU.cmd_result("egrep \"^service.name\" #{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-replicator/conf/static-* | awk -F \"=\" '{print $2}'").split("\n")
  
  if use_tpm?() && is_manager?()
    ds_list = ds_list + TU.cmd_result("#{tpm()} query dataservices | awk -F \" \" '{print $1}'").split("\n")
  end
  
  ds_list.uniq()
end

#datasource(service, use_direct_extractor = false) ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/tungsten/install.rb', line 356

def datasource(service, use_direct_extractor = false)
  type = datasource_type(service, use_direct_extractor)
  
  case type
  when "mysql"
    require "#{File.dirname(__FILE__)}/datasources/mysql.rb"
    return TungstenScriptMySQLDatasource.new(self, service, use_direct_extractor)
  else
    raise "Unable to create a TungstenDatasource for #{service} because it uses #{type}"
  end
end

#datasource_type(service, use_direct_extractor = false) ⇒ Object 



346
347
348
349
350
351
352
353
354
 
# File 'lib/tungsten/install.rb', line 346

def datasource_type(service, use_direct_extractor = false)
  if use_direct_extractor == true
    key = "repl_direct_datasource_type"
  else
    key = "repl_datasource_type"
  end
  
  setting(setting_key(REPL_SERVICES, service, key))
end

#default_dataservice ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/tungsten/install.rb', line 85

def default_dataservice
  if is_manager?()
    setting("dataservice_name")
  elsif is_replicator?()
    begin
      local_services = TU.cmd_result("egrep -l \"^replicator.service.type=local\" #{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-replicator/conf/static*").split("\n")
    rescue
      local_services = []
    end
    
    if local_services.size() == 0
      dataservices()[0]
    else
      TU.cmd_result("egrep \"^service.name\" #{local_services[0]} | awk -F \"=\" '{print $2}'")
    end
  else
    dataservices()[0]
  end
end

#ensure_cctrl(cmd, max_tries = 5) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/tungsten/install.rb', line 309

def ensure_cctrl(cmd, max_tries = 5)
  i=0
  while (i<max_tries)
    begin
      return TU.cmd_result("echo #{cmd}| #{cctrl}")
    rescue CommandError
      TU.debug(e)
    end
    i+=1
  end
  
  raise "Unable to execute '#{cmd}' in cctrl"
end

#hostname ⇒ Object 



66
67
68
 
# File 'lib/tungsten/install.rb', line 66

def hostname
  setting("host_name")
end

#inherit_path ⇒ Object 



323
324
325
326
327
 
# File 'lib/tungsten/install.rb', line 323

def inherit_path
  if setting("preferred_path") != ""
    ENV['PATH'] = setting("preferred_path").to_s() + ":" + ENV['PATH']
  end
end

#is_commercial? ⇒ Boolean

Returns:

  • (Boolean) 


301
302
303
 
# File 'lib/tungsten/install.rb', line 301

def is_commercial?
  File.exists?("#{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-manager")
end

#is_connector? ⇒ Boolean

Returns:

  • (Boolean) 


297
298
299
 
# File 'lib/tungsten/install.rb', line 297

def is_connector?
  (setting(HOST_ENABLE_CONNECTOR) == "true")
end

#is_manager? ⇒ Boolean

Returns:

  • (Boolean) 


293
294
295
 
# File 'lib/tungsten/install.rb', line 293

def is_manager?
  (setting(HOST_ENABLE_MANAGER) == "true")
end

#is_replicator? ⇒ Boolean

Returns:

  • (Boolean) 


289
290
291
 
# File 'lib/tungsten/install.rb', line 289

def is_replicator?
  (setting(HOST_ENABLE_REPLICATOR) == "true")
end

#is_running?(component) ⇒ Boolean

Returns:

  • (Boolean) 


280
281
282
283
284
285
286
287
 
# File 'lib/tungsten/install.rb', line 280

def is_running?(component)
  begin
    TU.cmd_result("#{service_path(component)} status")
    return true
  rescue CommandError
    return false
  end
end

#mgr_api_uri ⇒ Object 



200
201
202
203
204
205
206
 
# File 'lib/tungsten/install.rb', line 200

def mgr_api_uri
  if setting(MGR_API_ADDRESS) == "0.0.0.0"
    "#{hostname()}:#{setting(MGR_API_PORT)}"
  else
    "#{setting(MGR_API_ADDRESS)}:#{setting(MGR_API_PORT)}"
  end
end

#replication_services ⇒ Object 



105
106
107
108
109
110
111
 
# File 'lib/tungsten/install.rb', line 105

def replication_services
  begin
    TU.cmd_result("egrep \"^service.name\" #{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-replicator/conf/static-* | awk -F \"=\" '{print $2}'").split("\n")
  rescue
    []
  end
end

#return_first_result(results) ⇒ Object 



447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/tungsten/install.rb', line 447

def return_first_result(results)
  if results.size() == 0
    raise "No results were returned by #{sql}"
  end
  
  if results[0]["error"] == nil
    return results[0]["results"][0]
  else
    raise results[0]["error"]
  end
end

#root ⇒ Object

Path to the install directory for Continuent Tungsten. This will include all previous releases and a symlink to the current running version.



57
58
59
 
# File 'lib/tungsten/install.rb', line 57

def root
  @root
end

#service_path(component) ⇒ Object 



276
277
278
 
# File 'lib/tungsten/install.rb', line 276

def service_path(component)
  "#{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-#{component}/bin/#{component}"
end

#setting(key, v = nil) ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/tungsten/install.rb', line 117

def setting(key, v = nil)
  if v == nil
    return settings([key])[key]
  else
    @settings[key] = v
    
    return v
  end
end

#setting_key(first, second, third = nil) ⇒ Object 



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
 
# File 'lib/tungsten/install.rb', line 153

def setting_key(first, second, third = nil)
  if first == CONNECTORS
    "#{first}.#{TU.to_identifier(hostname())}.#{second}"
  elsif first == DATASERVICES
    if third == nil
      raise "Unable to create setting key for #{first}.#{second}"
    end
    
    service_aliases = setting(setting_key(HOSTS, "deployment_dataservice_aliases"))
    unless service_aliases.has_key?(second)
      raise "Unable to find a configuration alias for the #{second} service"
    end
    
    "#{first}.#{TU.to_identifier(service_aliases[second])}.#{third}"
  elsif first == HOSTS
    "#{first}.#{TU.to_identifier(hostname())}.#{second}"
  elsif first == MANAGERS
    if third == nil
      raise "Unable to create setting key for #{first}.#{second}"
    end
    
    service_aliases = setting(setting_key(HOSTS, "deployment_dataservice_aliases"))
    unless service_aliases.has_key?(second)
      raise "Unable to find a configuration alias for the #{second} service"
    end
    
    "#{first}.#{TU.to_identifier(service_aliases[second])}_#{TU.to_identifier(hostname())}.#{third}"
  elsif first == REPL_SERVICES
    if third == nil
      raise "Unable to create setting key for #{first}.#{second}"
    end
    
    service_aliases = setting(setting_key(HOSTS, "deployment_dataservice_aliases"))
    unless service_aliases.has_key?(second)
      raise "Unable to find a configuration alias for the #{second} service"
    end
    
    "#{first}.#{TU.to_identifier(service_aliases[second])}_#{TU.to_identifier(hostname())}.#{third}"
  else
    "#{first}.#{TU.to_identifier(hostname())}.#{second}"
  end
end

#settings(keys) ⇒ Object 



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
 
# File 'lib/tungsten/install.rb', line 127

def settings(keys)
  remaining_keys = keys - @settings.keys()
  if remaining_keys.size() > 0
    if use_tpm?()    
      begin
        JSON.parse(TU.cmd_result("#{tpm()} query values #{remaining_keys.join(' ')}")).each{
          |k, v|
          @settings[k] = v
        }
      rescue => e
        TU.exception(e)
        raise "Unable to load tpm values #{keys.join(' ')}"
      end
    else
      TU.debug("Unable to autodetect settings because tpm was not used to install this directory")
    end
  end
  
  return_values = {}
  keys.each{
    |k|
    return_values[k] = @settings[k]
  }
  return_values
end

#sql_result(service, sql, use_direct_extractor = false) ⇒ Object 



435
436
437
438
439
 
# File 'lib/tungsten/install.rb', line 435

def sql_result(service, sql, use_direct_extractor = false)
  results = sql_results(service, sql, use_direct_extractor)
  
  return_first_result(results)
end

#sql_result_from_url(sql, url, user, password) ⇒ Object 



441
442
443
444
445
 
# File 'lib/tungsten/install.rb', line 441

def sql_result_from_url(sql, url, user, password)
  results = sql_results_from_url(sql, url, user, password)
  
  return_first_result(results)
end

#sql_results(service, sql, use_direct_extractor = false) ⇒ Object 



379
380
381
382
383
384
385
386
 
# File 'lib/tungsten/install.rb', line 379

def sql_results(service, sql, use_direct_extractor = false)
  unless can_sql?(service, use_direct_extractor)
    raise "Unable to run SQL command for the #{service} dataservice. The datasource type does not support SQL commands."
  end
  
  ds = datasource(service, use_direct_extractor)      
  sql_results_from_url(sql, ds.url(), ds.user(), ds.password())
end

#sql_results_from_url(sql, url, user, password) ⇒ Object 



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/tungsten/install.rb', line 388

def sql_results_from_url(sql, url, user, password)
  cfg = nil
  command = nil
  begin
    cfg = Tempfile.new("cnf")
    cfg.puts("url=#{url}")
    cfg.puts("user=#{user}")
    cfg.puts("password=#{password}")
    cfg.close()
    
    command = Tempfile.new("query")
    if sql.is_a?(Array)
      command.puts(sql.join("\n"))
    else
      command.puts(sql)
    end
    command.close()
    
    output = TU.cmd_result("#{self.base_path()}/tungsten-replicator/bin/query -conf #{cfg.path} -file #{command.path}")
  rescue CommandError => ce
    TU.debug(ce)
    raise "There was an error processing the query: #{ce.result}"
  ensure
    if cfg != nil
      cfg.close()
      cfg.unlink()
    end
    
    if command != nil
      command.close()
      command.unlink()
    end
  end
  
  results = JSON.parse(output)
  results.each {
    |result|
    if result["rc"] == 0
      result["error"] = nil
    else
      obj = CommandError.new(result["statement"], result["rc"], result["results"], result["error"])
      result["error"] = obj
    end
  }
  results
end

#status(dataservice = nil) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/tungsten/install.rb', line 208

def status(dataservice = nil)
  if dataservice == nil
    dataservice = default_dataservice()
  end
  
  unless dataservices().include?(dataservice)
    raise "Unable to provide a status for #{dataservice} because it is not defined on this host"
  end
  
  return TungstenStatus.new(self, dataservice)
end

#sudo_prefix ⇒ Object 



338
339
340
341
342
343
344
 
# File 'lib/tungsten/install.rb', line 338

def sudo_prefix
  if ENV['USER'] == "root" || setting("root_command_prefix") != "true"
    return ""
  else
    return "sudo -n "
  end
end

#thl(service = nil) ⇒ Object 



268
269
270
271
272
273
274
 
# File 'lib/tungsten/install.rb', line 268

def thl(service = nil)
  if service == nil
    "#{tungsten_sudo_prefix()}#{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-replicator/bin/thl"
  else
    "#{tungsten_sudo_prefix()}#{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-replicator/bin/thl -service #{service}"
  end
end

#topology(dataservice = nil) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/tungsten/install.rb', line 220

def topology(dataservice = nil)
  if dataservice == nil
    dataservice = default_dataservice()
  end
  
  unless dataservices().include?(dataservice)
    raise "Unable to provide a topology for #{dataservice} because it is not defined on this host"
  end
  
  return TungstenTopology.new(self, dataservice)
end

#tpm ⇒ Object 



113
114
115
 
# File 'lib/tungsten/install.rb', line 113

def tpm
  "#{tungsten_sudo_prefix()}#{@root}/#{CURRENT_RELEASE_DIRECTORY}/tools/tpm"
end

#trepctl(service) ⇒ Object 



232
233
234
 
# File 'lib/tungsten/install.rb', line 232

def trepctl(service)
  "#{tungsten_sudo_prefix()}#{@root}/#{CURRENT_RELEASE_DIRECTORY}/tungsten-replicator/bin/trepctl -port #{setting(REPL_RMI_PORT)} -service #{service}"
end

#trepctl_name_all(service, name_value) ⇒ Object 



250
251
252
253
254
255
256
257
 
# File 'lib/tungsten/install.rb', line 250

def trepctl_name_all(service, name_value)
  begin
    output=JSON.parse(TU.cmd_result("#{trepctl(service)} status -name #{name_value} -json"))
  rescue Exception => e
    output=nil
  end
  output
end

#trepctl_name_value(service, name_value, stage, key) ⇒ Object 



240
241
242
243
244
245
246
247
248
 
# File 'lib/tungsten/install.rb', line 240

def trepctl_name_value(service, name_value, stage, key)
  begin
    output=JSON.parse(TU.cmd_result("#{trepctl(service)} status -name #{name_value} -json"))
  rescue Exception => e
    output=nil
  end
  stage_values=output.find{|x| x['stage']=stage}
  stage_values[key]
end

#trepctl_property(service, key) ⇒ Object 



259
260
261
262
263
264
265
266
 
# File 'lib/tungsten/install.rb', line 259

def trepctl_property(service, key)
  properties = JSON.parse(TU.cmd_result("#{trepctl(service)} properties -filter #{key}"))
  if properties.has_key?(key)
    return properties[key]
  else
    raise "Unable to find a value for #{key} in the output of `trepctl -service #{service} properties`."
  end
end

#trepctl_value(service, key) ⇒ Object 



236
237
238
 
# File 'lib/tungsten/install.rb', line 236

def trepctl_value(service, key)
  TU.cmd_result("#{trepctl(service)} status | grep #{key} | awk -F: '{ st = index($0,\":\");print substr($0,st+1)}' | tr -d ' '")
end

#tungsten_sudo_prefix ⇒ Object

Build a sudo prefix to run a command as the tungsten system user



330
331
332
333
334
335
336
 
# File 'lib/tungsten/install.rb', line 330

def tungsten_sudo_prefix
  if self.user() == nil || ENV['USER'] == self.user()
    return ""
  else
    return "sudo -u #{self.user()} -n -i "
  end
end

#use_tpm? ⇒ Boolean

Returns:

  • (Boolean) 


305
306
307
 
# File 'lib/tungsten/install.rb', line 305

def use_tpm?
  @has_tpm
end

#user ⇒ Object 



70
71
72
73
 
# File 'lib/tungsten/install.rb', line 70

def user
  # Access the array directly to avoid an infinite loop
  @settings["user"]
end