Module: Proxy::RemoteExecution::Ssh

Defined in:
lib/smart_proxy_remote_execution_ssh/version.rb,
lib/smart_proxy_remote_execution_ssh/dispatcher.rb,
lib/smart_proxy_remote_execution_ssh/job_storage.rb,
lib/smart_proxy_remote_execution_ssh/actions/run_script.rb,
lib/smart_proxy_remote_execution_ssh/runners.rb,
lib/smart_proxy_remote_execution_ssh/actions.rb,
lib/smart_proxy_remote_execution_ssh/plugin.rb,
lib/smart_proxy_remote_execution_ssh/mqtt.rb,
lib/smart_proxy_remote_execution_ssh/api.rb,
lib/smart_proxy_remote_execution_ssh.rb

Defined Under Namespace

Modules: Actions, Runners Classes: Api, Dispatcher, JobStorage, MQTT, Plugin

Constant Summary collapse

VERSION = 
'0.11.2'

Class Method Summary collapse

Class Method Details

.job_storage ⇒ Object 



110
111
112
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 110

def job_storage
  @job_storage ||= Proxy::RemoteExecution::Ssh::JobStorage.new
end

.private_key_file ⇒ Object 



16
17
18
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 16

def private_key_file
  File.expand_path(Plugin.settings.ssh_identity_key_file)
end

.public_key_file ⇒ Object 



20
21
22
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 20

def public_key_file
  File.expand_path("#{private_key_file}.pub")
end

.requires_configured_ssh? ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 99

def requires_configured_ssh?
  %i[ssh ssh-async].include?(Plugin.settings.mode) || Plugin.settings.cockpit_integration
end

.validate! ⇒ Object 



9
10
11
12
13
14
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 9

def validate!
  validate_mode!
  validate_ssh_settings!
  validate_mqtt_settings!
  validate_socket_path!
end

.validate_mode! ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 24

def validate_mode!
  Plugin.settings.mode = Plugin.settings.mode.to_sym

  unless Plugin::MODES.include? Plugin.settings.mode
    raise "Mode has to be one of #{Plugin::MODES.join(', ')}, given #{Plugin.settings.mode}"
  end

  if Plugin.settings.async_ssh
    Plugin.logger.warn('Option async_ssh is deprecated, use ssh-async mode instead.')

    case Plugin.settings.mode
    when :ssh
      Plugin.logger.warn('Deprecated option async_ssh used together with ssh mode, switching mode to ssh-async.')
      Plugin.settings.mode = :'ssh-async'
    when :'ssh-async'
      # This is a noop
    else
      Plugin.logger.warn('Deprecated option async_ssh used together with incompatible mode, ignoring.')
    end
  end
end

.validate_mqtt_settings! ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 46

def validate_mqtt_settings!
  return unless with_mqtt?

  raise 'mqtt_broker has to be set when pull-mqtt mode is used' if Plugin.settings.mqtt_broker.nil?
  raise 'mqtt_port has to be set when pull-mqtt mode is used' if Plugin.settings.mqtt_port.nil?

  if Plugin.settings.mqtt_tls.nil?
    Plugin.settings.mqtt_tls = [[:foreman_ssl_cert, :ssl_certificate], [:foreman_ssl_key, :ssl_private_key],
                                [:foreman_ssl_ca, :ssl_ca_file]].all? do |(client, server)|
      ::Proxy::SETTINGS[client] || ::Proxy::SETTINGS[server]
    end
  end
end

.validate_socket_path! ⇒ Object 



103
104
105
106
107
108
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 103

def validate_socket_path!
  return unless Plugin.settings.mode == :'ssh' || Plugin.settings.mode == :'ssh-async'

  socket_path = File.expand_path(Plugin.settings.socket_working_dir)
  raise "Socket path #{socket_path} is too long" if socket_path.length > Plugin::SOCKET_PATH_MAX_LENGTH
end

.validate_ssh_log_level! ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 78

def validate_ssh_log_level!
  wanted_level = Plugin.settings.ssh_log_level.to_s
  levels = Plugin::SSH_LOG_LEVELS
  unless levels.include? wanted_level
    raise "Wrong value '#{Plugin.settings.ssh_log_level}' for ssh_log_level, must be one of #{levels.join(', ')}"
  end

  current = ::Proxy::SETTINGS.log_level.to_s.downcase

  # regular log levels correspond to upcased ssh logger levels
  ssh, regular = [wanted_level, current].map do |wanted|
    levels.each_with_index.find { |value, _index| value == wanted }.last
  end

  if ssh < regular
    raise 'ssh_log_level cannot be more verbose than regular log level'
  end

  Plugin.settings.ssh_log_level = Plugin.settings.ssh_log_level.to_sym
end

.validate_ssh_settings! ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 60

def validate_ssh_settings!
  return unless requires_configured_ssh?
  unless private_key_file
    raise "settings for `ssh_identity_key` not set"
  end

  unless File.exist?(private_key_file)
    raise "SSH public key file #{private_key_file} doesn't exist.\n"\
      "You can generate one with `ssh-keygen -t rsa -b 4096 -f #{private_key_file} -N ''`"
  end

  unless File.exist?(public_key_file)
    raise "SSH public key file #{public_key_file} doesn't exist"
  end

  validate_ssh_log_level!
end

.with_mqtt? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/smart_proxy_remote_execution_ssh.rb', line 114

def with_mqtt?
  Proxy::RemoteExecution::Ssh::Plugin.settings.mode == :'pull-mqtt'
end