Class: Chef::Provider::SystemdUnit

Inherits:
Chef::Provider show all
Includes:
Mixin::ShellOut, Mixin::Which
Defined in:
lib/chef/provider/systemd_unit.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Methods included from Mixin::Which

#where, #which

Methods inherited from Chef::Provider

action, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?, #whyrun_supported?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

Methods included from Mixin::DescendantsTracker

#descendants, descendants, #direct_descendants, direct_descendants, #find_descendants_by_name, find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #with_run_context

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Constructor Details

This class inherits a constructor from Chef::Provider

Instance Method Details

#action_createObject


57
58
59
60
61
62
63
64
# File 'lib/chef/provider/systemd_unit.rb', line 57

def action_create
  if current_resource.content != new_resource.to_ini
    converge_by("creating unit: #{new_resource.name}") do
      manage_unit_file(:create)
      daemon_reload if new_resource.triggers_reload
    end
  end
end

#action_deleteObject


66
67
68
69
70
71
72
73
# File 'lib/chef/provider/systemd_unit.rb', line 66

def action_delete
  if ::File.exist?(unit_path)
    converge_by("deleting unit: #{new_resource.name}") do
      manage_unit_file(:delete)
      daemon_reload if new_resource.triggers_reload
    end
  end
end

#action_disableObject


87
88
89
90
91
92
93
94
95
96
97
# File 'lib/chef/provider/systemd_unit.rb', line 87

def action_disable
  if current_resource.static
    Chef::Log.debug("#{new_resource.name} is a static unit, disabling is a NOP.")
  end

  if current_resource.enabled && !current_resource.static
    converge_by("disabling unit: #{new_resource.name}") do
      systemctl_execute!(:disable, new_resource.name)
    end
  end
end

#action_enableObject


75
76
77
78
79
80
81
82
83
84
85
# File 'lib/chef/provider/systemd_unit.rb', line 75

def action_enable
  if current_resource.static
    Chef::Log.debug("#{new_resource.name} is a static unit, enabling is a NOP.")
  end

  unless current_resource.enabled || current_resource.static
    converge_by("enabling unit: #{new_resource.name}") do
      systemctl_execute!(:enable, new_resource.name)
    end
  end
end

#action_maskObject


99
100
101
102
103
104
105
# File 'lib/chef/provider/systemd_unit.rb', line 99

def action_mask
  unless current_resource.masked
    converge_by("masking unit: #{new_resource.name}") do
      systemctl_execute!(:mask, new_resource.name)
    end
  end
end

#action_reloadObject


137
138
139
140
141
142
143
144
145
# File 'lib/chef/provider/systemd_unit.rb', line 137

def action_reload
  if current_resource.active
    converge_by("reloading unit: #{new_resource.name}") do
      systemctl_execute!(:reload, new_resource.name)
    end
  else
    Chef::Log.debug("#{new_resource.name} is not active, skipping reload.")
  end
end

#action_reload_or_restartObject


153
154
155
156
157
# File 'lib/chef/provider/systemd_unit.rb', line 153

def action_reload_or_restart
  converge_by("reload-or-restarting unit: #{new_resource.name}") do
    systemctl_execute!("reload-or-restart", new_resource.name)
  end
end

#action_reload_or_try_restartObject


159
160
161
162
163
# File 'lib/chef/provider/systemd_unit.rb', line 159

def action_reload_or_try_restart
  converge_by("reload-or-try-restarting unit: #{new_resource.name}") do
    systemctl_execute!("reload-or-try-restart", new_resource.name)
  end
end

#action_restartObject


131
132
133
134
135
# File 'lib/chef/provider/systemd_unit.rb', line 131

def action_restart
  converge_by("restarting unit: #{new_resource.name}") do
    systemctl_execute!(:restart, new_resource.name)
  end
end

#action_startObject


115
116
117
118
119
120
121
# File 'lib/chef/provider/systemd_unit.rb', line 115

def action_start
  unless current_resource.active
    converge_by("starting unit: #{new_resource.name}") do
      systemctl_execute!(:start, new_resource.name)
    end
  end
end

#action_stopObject


123
124
125
126
127
128
129
# File 'lib/chef/provider/systemd_unit.rb', line 123

def action_stop
  if current_resource.active
    converge_by("stopping unit: #{new_resource.name}") do
      systemctl_execute!(:stop, new_resource.name)
    end
  end
end

#action_try_restartObject


147
148
149
150
151
# File 'lib/chef/provider/systemd_unit.rb', line 147

def action_try_restart
  converge_by("try-restarting unit: #{new_resource.name}") do
    systemctl_execute!("try-restart", new_resource.name)
  end
end

#action_unmaskObject


107
108
109
110
111
112
113
# File 'lib/chef/provider/systemd_unit.rb', line 107

def action_unmask
  if current_resource.masked
    converge_by("unmasking unit: #{new_resource.name}") do
      systemctl_execute!(:unmask, new_resource.name)
    end
  end
end

#active?Boolean

Returns:

  • (Boolean)

165
166
167
# File 'lib/chef/provider/systemd_unit.rb', line 165

def active?
  systemctl_execute("is-active", new_resource.name).exitstatus == 0
end

#define_resource_requirementsObject


48
49
50
51
52
53
54
55
# File 'lib/chef/provider/systemd_unit.rb', line 48

def define_resource_requirements
  super

  requirements.assert(:create) do |a|
    a.assertion { IniParse.parse(new_resource.to_ini) }
    a.failure_message "Unit content is not valid INI text"
  end
end

#enabled?Boolean

Returns:

  • (Boolean)

169
170
171
# File 'lib/chef/provider/systemd_unit.rb', line 169

def enabled?
  systemctl_execute("is-enabled", new_resource.name).exitstatus == 0
end

#load_current_resourceObject


34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/chef/provider/systemd_unit.rb', line 34

def load_current_resource
  @current_resource = Chef::Resource::SystemdUnit.new(new_resource.name)

  current_resource.content(::File.read(unit_path)) if ::File.exist?(unit_path)
  current_resource.user(new_resource.user)
  current_resource.enabled(enabled?)
  current_resource.active(active?)
  current_resource.masked(masked?)
  current_resource.static(static?)
  current_resource.triggers_reload(new_resource.triggers_reload)

  current_resource
end

#masked?Boolean

Returns:

  • (Boolean)

173
174
175
# File 'lib/chef/provider/systemd_unit.rb', line 173

def masked?
  systemctl_execute(:status, new_resource.name).stdout.include?("masked")
end

#static?Boolean

Returns:

  • (Boolean)

177
178
179
# File 'lib/chef/provider/systemd_unit.rb', line 177

def static?
  systemctl_execute("is-enabled", new_resource.name).stdout.include?("static")
end