cookbooks/systemd/resources/service.rb

   1 #
   2 # Cookbook:: systemd
   3 # Resource:: systemd_service
   4 #
   5 # Copyright:: 2016, OpenStreetMap Foundation
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 # https://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19
  20 unified_mode true
  21
  22 default_action :create
  23
  24 property :service, String, :name_property => true
  25 property :dropin, String
  26 property :description, String
  27 property :condition_path_exists, [String, Array]
  28 property :condition_path_exists_glob, [String, Array]
  29 property :after, [String, Array]
  30 property :conflicts, [String, Array]
  31 property :wants, [String, Array]
  32 property :requires, [String, Array]
  33 property :joins_namespace_of, [String, Array]
  34 property :type, String, :is => %w[simple forking oneshot dbus notify idle]
  35 property :notify_access, String, :is => %w[none main exec all]
  36 property :limit_nofile, Integer
  37 property :limit_as, [Integer, String]
  38 property :limit_cpu, [Integer, String]
  39 property :memory_low, [Integer, String]
  40 property :memory_high, [Integer, String]
  41 property :memory_max, [Integer, String]
  42 property :environment, Hash, :default => {}
  43 property :environment_file, [String, Hash]
  44 property :user, String
  45 property :group, String
  46 property :dynamic_user, [true, false]
  47 property :working_directory, String
  48 property :umask, String
  49 property :exec_start_pre, [String, Array]
  50 property :exec_start, [String, Array]
  51 property :exec_start_post, [String, Array]
  52 property :exec_stop, [String, Array]
  53 property :exec_stop_post, [String, Array]
  54 property :exec_reload, String
  55 property :runtime_max_sec, Integer
  56 property :runtime_directory, String
  57 property :runtime_directory_mode, Integer
  58 property :state_directory, String
  59 property :state_directory_mode, Integer
  60 property :cache_directory, String
  61 property :cache_directory_mode, Integer
  62 property :logs_directory, String
  63 property :logs_directory_mode, Integer
  64 property :configuration_directory, String
  65 property :configuration_directory_mode, Integer
  66 property :standard_input, String,
  67          :is => %w[null tty tty-force tty-fail socket]
  68 property :standard_output, String,
  69          :is => %w[inherit null tty journal syslog kmsg journal+console syslog+console kmsg+console socket]
  70 property :standard_error, String,
  71          :is => %w[inherit null tty journal syslog kmsg journal+console syslog+console kmsg+console socket]
  72 property :success_exit_status, [Integer, String, Array]
  73 property :restart, String,
  74          :is => %w[on-success on-failure on-abnormal on-watchdog on-abort always]
  75 property :restart_sec, [Integer, String]
  76 property :protect_proc, String,
  77          :is => %w[noaccess invisible ptraceable default]
  78 property :proc_subset, String,
  79          :is => %w[all pid]
  80 property :bind_paths, [String, Array]
  81 property :bind_read_only_paths, [String, Array]
  82 property :capability_bounding_set, [String, Array]
  83 property :ambient_capabilities, [String, Array]
  84 property :no_new_privileges, [true, false]
  85 property :protect_system, [true, false, String]
  86 property :protect_home, [true, false, String]
  87 property :read_write_paths, [String, Array]
  88 property :read_only_paths, [String, Array]
  89 property :inaccessible_paths, [String, Array]
  90 property :private_tmp, [true, false]
  91 property :private_devices, [true, false]
  92 property :private_network, [true, false]
  93 property :private_ipc, [true, false]
  94 property :private_users, [true, false]
  95 property :protect_hostname, [true, false]
  96 property :protect_clock, [true, false]
  97 property :protect_kernel_tunables, [true, false]
  98 property :protect_kernel_modules, [true, false]
  99 property :protect_kernel_logs, [true, false]
 100 property :protect_control_groups, [true, false]
 101 property :restrict_address_families, [String, Array]
 102 property :restrict_namespaces, [true, false, String, Array]
 103 property :lock_personality, [true, false]
 104 property :memory_deny_write_execute, [true, false]
 105 property :restrict_realtime, [true, false]
 106 property :restrict_suid_sgid, [true, false]
 107 property :remove_ipc, [true, false]
 108 property :system_call_filter, [String, Array]
 109 property :system_call_architectures, [String, Array]
 110 property :tasks_max, Integer
 111 property :timeout_start_sec, Integer
 112 property :timeout_stop_sec, Integer
 113 property :timeout_abort_sec, Integer
 114 property :timeout_sec, Integer
 115 property :pid_file, String
 116 property :nice, Integer
 117 property :io_scheduling_class, [Integer, String]
 118 property :io_scheduling_priority, Integer
 119 property :kill_mode, String,
 120          :is => %w[control-group process mixed none]
 121 property :sandbox, [true, false, Hash]
 122
 123 action :create do
 124   service_variables = new_resource.to_hash
 125
 126   unless new_resource.dropin
 127     service_variables[:type] ||= "simple"
 128   end
 129
 130   if new_resource.sandbox
 131     service_variables[:protect_proc] = "invisible" unless property_is_set?(:protect_proc)
 132     service_variables[:proc_subset] = "pid" unless property_is_set?(:proc_subset)
 133     service_variables[:capability_bounding_set] = [] unless property_is_set?(:capability_bounding_set)
 134     service_variables[:ambient_capabilities] = [] unless property_is_set?(:ambient_capabilities)
 135     service_variables[:no_new_privileges] = true unless property_is_set?(:no_new_privileges)
 136     service_variables[:protect_system] = "strict" unless property_is_set?(:protect_system)
 137     service_variables[:protect_home] = true unless property_is_set?(:protect_home)
 138     service_variables[:private_tmp] = true unless property_is_set?(:private_tmp)
 139     service_variables[:private_devices] = true unless property_is_set?(:private_devices)
 140     service_variables[:private_network] = true unless property_is_set?(:private_network)
 141     service_variables[:private_ipc] = true unless property_is_set?(:private_ipc)
 142     service_variables[:private_users] = true unless property_is_set?(:private_users)
 143     service_variables[:protect_hostname] = true unless property_is_set?(:protect_hostname)
 144     service_variables[:protect_clock] = true unless property_is_set?(:protect_clock)
 145     service_variables[:protect_kernel_tunables] = true unless property_is_set?(:protect_kernel_tunables)
 146     service_variables[:protect_kernel_modules] = true unless property_is_set?(:protect_kernel_modules)
 147     service_variables[:protect_kernel_logs] = true unless property_is_set?(:protect_kernel_logs)
 148     service_variables[:protect_control_groups] = true unless property_is_set?(:protect_control_groups)
 149     service_variables[:restrict_address_families] = [] unless property_is_set?(:restrict_address_families)
 150     service_variables[:restrict_namespaces] = true unless property_is_set?(:restrict_namespaces)
 151     service_variables[:lock_personality] = true unless property_is_set?(:lock_personality)
 152     service_variables[:memory_deny_write_execute] = true unless property_is_set?(:memory_deny_write_execute)
 153     service_variables[:restrict_realtime] = true unless property_is_set?(:restrict_realtime)
 154     service_variables[:restrict_suid_sgid] = true unless property_is_set?(:restrict_suid_sgid)
 155     service_variables[:remove_ipc] = true unless property_is_set?(:remove_ipc)
 156     service_variables[:system_call_filter] = "@system-service" unless property_is_set?(:system_call_filter)
 157     service_variables[:system_call_architectures] = "native" unless property_is_set?(:system_call_architectures)
 158
 159     if sandbox_option(:enable_network)
 160       service_variables[:private_network] = false
 161       service_variables[:restrict_address_families] = Array(service_variables[:restrict_address_families]).append("AF_INET", "AF_INET6").reject { |f| f == "none" }
 162     end
 163   end
 164
 165   if new_resource.environment_file.is_a?(Hash)
 166     template "/etc/default/#{new_resource.service}" do
 167       cookbook "systemd"
 168       source "environment.erb"
 169       owner "root"
 170       group "root"
 171       mode "640"
 172       variables :environment => new_resource.environment_file
 173     end
 174
 175     service_variables[:environment_file] = "/etc/default/#{new_resource.service}"
 176   end
 177
 178   if new_resource.dropin
 179     directory dropin_directory do
 180       owner "root"
 181       group "root"
 182       mode "755"
 183     end
 184   end
 185
 186   template config_name do
 187     cookbook "systemd"
 188     source "service.erb"
 189     owner "root"
 190     group "root"
 191     mode "644"
 192     variables service_variables
 193     notifies :run, "execute[systemctl-reload]"
 194   end
 195
 196   execute "systemctl-reload" do
 197     action :nothing
 198     command "systemctl daemon-reload"
 199     user "root"
 200     group "root"
 201   end
 202 end
 203
 204 action :delete do
 205   file "/etc/default/#{new_resource.service}" do
 206     action :delete
 207     only_if { new_resource.environment_file.is_a?(Hash) }
 208   end
 209
 210   file config_name do
 211     action :delete
 212     notifies :run, "execute[systemctl-reload]"
 213   end
 214
 215   execute "systemctl-reload" do
 216     action :nothing
 217     command "systemctl daemon-reload"
 218     user "root"
 219     group "root"
 220   end
 221 end
 222
 223 action_class do
 224   def sandbox_option(option)
 225     new_resource.sandbox[option] if new_resource.sandbox.is_a?(Hash)
 226   end
 227
 228   def dropin_directory
 229     "/etc/systemd/system/#{new_resource.service}.service.d"
 230   end
 231
 232   def config_name
 233     if new_resource.dropin
 234       "#{dropin_directory}/#{new_resource.dropin}.conf"
 235     else
 236       "/etc/systemd/system/#{new_resource.service}.service"
 237     end
 238   end
 239 end