1
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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
151
152
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
195
196
197
198
199
200
201
202
203
204
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
#
# Author:: Nathan Williams (<nath.e.will@gmail.com>)
# Copyright:: Copyright 2016-2018, Nathan Williams
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require_relative "../provider"
require_relative "../mixin/which"
require_relative "../resource/file"
require_relative "../resource/file/verification/systemd_unit"
require "iniparse"
require "shellwords" unless defined?(Shellwords)
require "chef-utils/dist" unless defined?(ChefUtils::Dist)
class Chef
class Provider
class SystemdUnit < Chef::Provider
include Chef::Mixin::Which
provides :systemd_unit
def load_current_resource
@current_resource = Chef::Resource::SystemdUnit.new(new_resource.name)
current_resource.unit_name(new_resource.unit_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.indirect(indirect?)
current_resource.triggers_reload(new_resource.triggers_reload)
current_resource
end
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
def systemd_unit_status
@systemd_unit_status ||= begin
# Collect all the status information for a unit and return it at once
# This may fail if we are managing a template unit (e.g. with '@'), in which case
# we just ignore the error because unit status is irrelevant in that case
s = shell_out(*systemctl_cmd, "show", "-p", "UnitFileState", "-p", "ActiveState", new_resource.unit_name, **systemctl_opts)
# e.g. /bin/systemctl --system show -p UnitFileState -p ActiveState syslog.socket
# Returns something like:
# ActiveState=inactive
# UnitFileState=static
status = {}
s.stdout.each_line do |line|
k, v = line.strip.split("=")
status[k] = v
end
status
end
end
action :create, description: "Create a systemd unit file, if it does not already exist." do
if current_resource.content != new_resource.to_ini
converge_by("creating unit: #{new_resource.unit_name}") do
manage_unit_file(:create)
daemon_reload if new_resource.triggers_reload
end
end
end
action :delete, description: "Delete a systemd unit file, if it exists." do
if ::File.exist?(unit_path)
converge_by("deleting unit: #{new_resource.unit_name}") do
manage_unit_file(:delete)
daemon_reload if new_resource.triggers_reload
end
end
end
action :preset, description: "Restore the preset '`enable`/`disable`' configuration for a systemd unit. *New in #{ChefUtils::Dist::Infra::PRODUCT} 14.0.*" do
converge_by("restoring enable/disable preset configuration for unit: #{new_resource.unit_name}") do
systemctl_execute!(:preset, new_resource.unit_name)
end
end
action :revert, description: "Revert to a vendor's version of a systemd unit file. *New in #{ChefUtils::Dist::Infra::PRODUCT} 14.0.*" do
converge_by("reverting to vendor version of unit: #{new_resource.unit_name}") do
systemctl_execute!(:revert, new_resource.unit_name)
end
end
action :enable, description: "Ensure the unit will be started after the next system boot." do
if current_resource.static
logger.debug("#{new_resource.unit_name} is a static unit, enabling is a NOP.")
end
if current_resource.indirect
logger.debug("#{new_resource.unit_name} is an indirect unit, enabling is a NOP.")
end
unless current_resource.enabled || current_resource.static || current_resource.indirect
converge_by("enabling unit: #{new_resource.unit_name}") do
systemctl_execute!(:enable, new_resource.unit_name)
logger.info("#{new_resource} enabled")
end
end
end
action :disable, description: "Ensure the unit will not be started after the next system boot." do
if current_resource.static
logger.debug("#{new_resource.unit_name} is a static unit, disabling is a NOP.")
end
if current_resource.indirect
logger.debug("#{new_resource.unit_name} is an indirect unit, enabling is a NOP.")
end
if current_resource.enabled && !current_resource.static && !current_resource.indirect
converge_by("disabling unit: #{new_resource.unit_name}") do
systemctl_execute!(:disable, new_resource.unit_name)
logger.info("#{new_resource} disabled")
end
end
end
action :reenable, description: "Reenable a unit file. *New in #{ChefUtils::Dist::Infra::PRODUCT} 14.0.*" do
converge_by("reenabling unit: #{new_resource.unit_name}") do
systemctl_execute!(:reenable, new_resource.unit_name)
logger.info("#{new_resource} reenabled")
end
end
action :mask, description: "Ensure the unit will not start, even to satisfy dependencies." do
unless current_resource.masked
converge_by("masking unit: #{new_resource.unit_name}") do
systemctl_execute!(:mask, new_resource.unit_name)
logger.info("#{new_resource} masked")
end
end
end
action :unmask, description: "Stop the unit from being masked and cause it to start as specified." do
if current_resource.masked
converge_by("unmasking unit: #{new_resource.unit_name}") do
systemctl_execute!(:unmask, new_resource.unit_name)
logger.info("#{new_resource} unmasked")
end
end
end
action :start, description: "Start a systemd unit." do
unless current_resource.active
converge_by("starting unit: #{new_resource.unit_name}") do
systemctl_execute!(:start, new_resource.unit_name, default_env: false)
logger.info("#{new_resource} started")
end
end
end
action :stop, description: "Stop a running systemd unit." do
if current_resource.active
converge_by("stopping unit: #{new_resource.unit_name}") do
systemctl_execute!(:stop, new_resource.unit_name, default_env: false)
logger.info("#{new_resource} stopped")
end
end
end
action :restart, description: "Restart a systemd unit." do
converge_by("restarting unit: #{new_resource.unit_name}") do
systemctl_execute!(:restart, new_resource.unit_name, default_env: false)
logger.info("#{new_resource} restarted")
end
end
action :reload, description: "Reload the configuration file for a systemd unit." do
if current_resource.active
converge_by("reloading unit: #{new_resource.unit_name}") do
systemctl_execute!(:reload, new_resource.unit_name, default_env: false)
logger.info("#{new_resource} reloaded")
end
else
logger.debug("#{new_resource.unit_name} is not active, skipping reload.")
end
end
action :try_restart, description: "Try to restart a systemd unit if the unit is running." do
converge_by("try-restarting unit: #{new_resource.unit_name}") do
systemctl_execute!("try-restart", new_resource.unit_name, default_env: false)
logger.info("#{new_resource} try-restarted")
end
end
action :reload_or_restart, description: "For systemd units that are services, this action reloads the configuration of the service without restarting, if possible; otherwise, it will restart the service so the new configuration is applied." do
converge_by("reload-or-restarting unit: #{new_resource.unit_name}") do
systemctl_execute!("reload-or-restart", new_resource.unit_name, default_env: false)
logger.info("#{new_resource} reload-or-restarted")
end
end
action :reload_or_try_restart, description: "For systemd units that are services, this action reloads the configuration of the service without restarting, if possible; otherwise, it will try to restart the service so the new configuration is applied." do
converge_by("reload-or-try-restarting unit: #{new_resource.unit_name}") do
systemctl_execute!("reload-or-try-restart", new_resource.unit_name, default_env: false)
logger.info("#{new_resource} reload-or-try-restarted")
end
end
def active?
# Note: "activating" is not active (as with type=notify or a oneshot)
systemd_unit_status["ActiveState"] == "active"
end
def enabled?
# See https://github.com/systemd/systemd/blob/master/src/systemctl/systemctl-is-enabled.c
# Note: enabled-runtime is excluded because this is volatile, and the state of enabled-runtime
# specifically means that the service is not enabled
%w{enabled static generated alias indirect}.include?(systemd_unit_status["UnitFileState"])
end
def masked?
# Note: masked-runtime is excluded, because runtime is volatile, and
# because masked-runtime is not masked.
systemd_unit_status["UnitFileState"] == "masked"
end
def static?
systemd_unit_status["UnitFileState"] == "static"
end
def indirect?
systemd_unit_status["UnitFileState"] == "indirect"
end
private
def unit_path
if new_resource.user
"/etc/systemd/user/#{new_resource.unit_name}"
else
"/etc/systemd/system/#{new_resource.unit_name}"
end
end
def manage_unit_file(the_action = :nothing)
file unit_path do
owner "root"
group "root"
mode "0644"
sensitive new_resource.sensitive
content new_resource.to_ini
verify :systemd_unit if new_resource.verify
action the_action
end
end
def daemon_reload
shell_out!(systemctl_cmd, "daemon-reload", **systemctl_opts, default_env: false)
end
def systemctl_execute!(action, unit, **options)
shell_out!(systemctl_cmd, action, unit, **systemctl_opts.merge(options))
end
def systemctl_execute(action, unit, **options)
shell_out(systemctl_cmd, action, unit, **systemctl_opts.merge(options))
end
def systemctl_cmd
@systemctl_cmd ||= [ systemctl_path, systemctl_args ]
end
def systemctl_path
@systemctl_path ||= which("systemctl")
end
def systemctl_args
@systemctl_args ||= new_resource.user ? "--user" : "--system"
end
def systemctl_opts
@systemctl_opts ||=
if new_resource.user
uid = Etc.getpwnam(new_resource.user).uid
{
user: new_resource.user,
environment: {
"DBUS_SESSION_BUS_ADDRESS" => "unix:path=/run/user/#{uid}/bus",
},
}
else
{}
end
end
end
end
end
|