diff --git a/REFERENCE.md b/REFERENCE.md index 04bf5df..a72e4d1 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,1280 +1,1289 @@ # Reference ## Table of Contents ### Classes #### Public Classes * [`systemd`](#systemd): This module allows triggering systemd commands once for all modules * [`systemd::tmpfiles`](#systemdtmpfiles): Update the systemd temp files #### Private Classes * `systemd::journald`: This class manages and configures journald. * `systemd::logind`: This class manages systemd's login manager configuration. * `systemd::networkd`: This class provides an abstract way to trigger systemd-networkd * `systemd::resolved`: This class provides an abstract way to trigger resolved. * `systemd::system`: This class provides a solution to enable accounting * `systemd::timesyncd`: This class provides an abstract way to trigger systemd-timesyncd * `systemd::udevd`: This class manages systemd's udev config ### Defined types * [`systemd::dropin_file`](#systemddropin_file): Creates a drop-in file for a systemd unit * [`systemd::network`](#systemdnetwork): Creates network config for systemd-networkd * [`systemd::service_limits`](#systemdservice_limits): Adds a set of custom limits to the service * [`systemd::timer`](#systemdtimer): Create a timer and optionally a service unit to execute with the timer unit * [`systemd::tmpfile`](#systemdtmpfile): Creates a systemd tmpfile * [`systemd::udev::rule`](#systemdudevrule): Adds a custom udev rule * [`systemd::unit_file`](#systemdunit_file): Creates a systemd unit file ### Resource types * [`loginctl_user`](#loginctl_user): An arbitrary name used as the identity of the resource. ### Data types * [`Systemd::Dropin`](#systemddropin) * [`Systemd::JournaldSettings`](#systemdjournaldsettings): Matches Systemd journald config Struct * [`Systemd::JournaldSettings::Ensure`](#systemdjournaldsettingsensure) * [`Systemd::LogindSettings`](#systemdlogindsettings): Matches Systemd Login Manager Struct * [`Systemd::LogindSettings::Ensure`](#systemdlogindsettingsensure) * [`Systemd::ServiceLimits`](#systemdservicelimits): Matches Systemd Service Limit Struct * [`Systemd::Unit`](#systemdunit) ## Classes ### `systemd` This module allows triggering systemd commands once for all modules #### Parameters The following parameters are available in the `systemd` class: * [`service_limits`](#service_limits) * [`manage_resolved`](#manage_resolved) * [`resolved_ensure`](#resolved_ensure) * [`dns`](#dns) * [`fallback_dns`](#fallback_dns) * [`domains`](#domains) * [`llmnr`](#llmnr) * [`multicast_dns`](#multicast_dns) * [`dnssec`](#dnssec) * [`dnsovertls`](#dnsovertls) * [`cache`](#cache) * [`dns_stub_listener`](#dns_stub_listener) * [`use_stub_resolver`](#use_stub_resolver) * [`manage_networkd`](#manage_networkd) * [`networkd_ensure`](#networkd_ensure) * [`manage_timesyncd`](#manage_timesyncd) * [`timesyncd_ensure`](#timesyncd_ensure) * [`ntp_server`](#ntp_server) * [`fallback_ntp_server`](#fallback_ntp_server) * [`manage_journald`](#manage_journald) * [`journald_settings`](#journald_settings) * [`manage_udevd`](#manage_udevd) * [`udev_log`](#udev_log) * [`udev_children_max`](#udev_children_max) * [`udev_exec_delay`](#udev_exec_delay) * [`udev_event_timeout`](#udev_event_timeout) * [`udev_resolve_names`](#udev_resolve_names) * [`udev_timeout_signal`](#udev_timeout_signal) * [`udev_rules`](#udev_rules) * [`manage_logind`](#manage_logind) * [`logind_settings`](#logind_settings) * [`loginctl_users`](#loginctl_users) * [`dropin_files`](#dropin_files) * [`manage_accounting`](#manage_accounting) * [`accounting`](#accounting) * [`purge_dropin_dirs`](#purge_dropin_dirs) ##### `service_limits` Data type: `Hash[String,Hash[String, Any]]` May be passed a resource hash suitable for passing directly into the ``create_resources()`` function as called on ``systemd::service_limits`` ##### `manage_resolved` Data type: `Boolean` Manage the systemd resolver ##### `resolved_ensure` Data type: `Enum['stopped','running']` The state that the ``resolved`` service should be in ##### `dns` Data type: `Optional[Variant[Array[String],String]]` A space-separated list of IPv4 and IPv6 addresses to use as system DNS servers. DNS requests are sent to one of the listed DNS servers in parallel to suitable per-link DNS servers acquired from systemd-networkd.service(8) or set at runtime by external applications. requires puppetlabs-inifile ##### `fallback_dns` Data type: `Optional[Variant[Array[String],String]]` A space-separated list of IPv4 and IPv6 addresses to use as the fallback DNS servers. Any per-link DNS servers obtained from systemd-networkd take precedence over this setting. requires puppetlabs-inifile ##### `domains` Data type: `Optional[Variant[Array[String],String]]` A space-separated list of domains host names or IP addresses to be used systemd-resolved take precedence over this setting. ##### `llmnr` Data type: `Optional[Variant[Boolean,Enum['resolve']]]` Takes a boolean argument or "resolve". ##### `multicast_dns` Data type: `Optional[Variant[Boolean,Enum['resolve']]]` Takes a boolean argument or "resolve". ##### `dnssec` Data type: `Optional[Variant[Boolean,Enum['allow-downgrade']]]` Takes a boolean argument or "allow-downgrade". ##### `dnsovertls` Data type: `Optional[Variant[Boolean,Enum['opportunistic', 'no']]]` Takes a boolean argument or "opportunistic" ##### `cache` Data type: `Optional[Variant[Boolean,Enum['no-negative']]]` Takes a boolean argument or "no-negative". ##### `dns_stub_listener` Data type: `Optional[Variant[Boolean,Enum['udp','tcp']]]` Takes a boolean argument or one of "udp" and "tcp". ##### `use_stub_resolver` Data type: `Boolean` Takes a boolean argument. When "false" (default) it uses /run/systemd/resolve/resolv.conf as /etc/resolv.conf. When "true", it uses /run/systemd/resolve/stub-resolv.conf ##### `manage_networkd` Data type: `Boolean` Manage the systemd network daemon ##### `networkd_ensure` Data type: `Enum['stopped','running']` The state that the ``networkd`` service should be in ##### `manage_timesyncd` Data type: `Boolean` Manage the systemd tiemsyncd daemon ##### `timesyncd_ensure` Data type: `Enum['stopped','running']` The state that the ``timesyncd`` service should be in ##### `ntp_server` Data type: `Optional[Variant[Array,String]]` comma separated list of ntp servers, will be combined with interface specific addresses from systemd-networkd. requires puppetlabs-inifile ##### `fallback_ntp_server` Data type: `Optional[Variant[Array,String]]` A space-separated list of NTP server host names or IP addresses to be used as the fallback NTP servers. Any per-interface NTP servers obtained from systemd-networkd take precedence over this setting. requires puppetlabs-inifile ##### `manage_journald` Data type: `Boolean` Manage the systemd journald ##### `journald_settings` Data type: `Systemd::JournaldSettings` Config Hash that is used to configure settings in journald.conf ##### `manage_udevd` Data type: `Boolean` Manage the systemd udev daemon ##### `udev_log` Data type: `Optional[Variant[Integer,String]]` The value of /etc/udev/udev.conf udev_log ##### `udev_children_max` Data type: `Optional[Integer]` The value of /etc/udev/udev.conf children_max ##### `udev_exec_delay` Data type: `Optional[Integer]` The value of /etc/udev/udev.conf exec_delay ##### `udev_event_timeout` Data type: `Optional[Integer]` The value of /etc/udev/udev.conf event_timeout ##### `udev_resolve_names` Data type: `Optional[Enum['early', 'late', 'never']]` The value of /etc/udev/udev.conf resolve_names ##### `udev_timeout_signal` Data type: `Optional[Variant[Integer,String]]` The value of /etc/udev/udev.conf timeout_signal ##### `udev_rules` Data type: `Hash` Config Hash that is used to generate instances of our `udev::rule` define. Default value: `{}` ##### `manage_logind` Data type: `Boolean` Manage the systemd logind ##### `logind_settings` Data type: `Systemd::LogindSettings` Config Hash that is used to configure settings in logind.conf ##### `loginctl_users` Data type: `Hash` Config Hash that is used to generate instances of our type `loginctl_user`. Default value: `{}` ##### `dropin_files` Data type: `Hash` Configure dropin files via hiera with factory pattern Default value: `{}` ##### `manage_accounting` Data type: `Boolean` ##### `accounting` Data type: `Hash[String,String]` ##### `purge_dropin_dirs` Data type: `Boolean` ### `systemd::tmpfiles` Update the systemd temp files * **See also** * systemd-tmpfiles(8) #### Parameters The following parameters are available in the `systemd::tmpfiles` class: * [`operations`](#operations) ##### `operations` Data type: `Array[Enum['create','clean','remove']]` The operations to perform on the systemd tempfiles * All operations may be combined but you'll probably only ever want to use ``create`` Default value: `['create']` ## Defined types ### `systemd::dropin_file` Creates a drop-in file for a systemd unit * **See also** * systemd.unit(5) #### Parameters The following parameters are available in the `systemd::dropin_file` defined type: * [`name`](#name) * [`path`](#path) * [`selinux_ignore_defaults`](#selinux_ignore_defaults) * [`content`](#content) * [`source`](#source) * [`target`](#target) * [`owner`](#owner) * [`group`](#group) * [`mode`](#mode) * [`show_diff`](#show_diff) +* [`notify_service`](#notify_service) * [`unit`](#unit) * [`filename`](#filename) * [`ensure`](#ensure) ##### `name` Data type: `Pattern['^[^/]+\.conf$']` The target unit file to create ##### `path` Data type: `Stdlib::Absolutepath` The main systemd configuration path Default value: `'/etc/systemd/system'` ##### `selinux_ignore_defaults` Data type: `Optional[Boolean]` If Puppet should ignore the default SELinux labels. Default value: ``false`` ##### `content` Data type: `Optional[Variant[String,Sensitive[String]]]` The full content of the unit file * Mutually exclusive with ``$source`` Default value: ``undef`` ##### `source` Data type: `Optional[String]` The ``File`` resource compatible ``source`` * Mutually exclusive with ``$content`` Default value: ``undef`` ##### `target` Data type: `Optional[Stdlib::Absolutepath]` If set, will force the file to be a symlink to the given target * Mutually exclusive with both ``$source`` and ``$content`` Default value: ``undef`` ##### `owner` Data type: `String` The owner to set on the dropin file Default value: `'root'` ##### `group` Data type: `String` The group to set on the dropin file Default value: `'root'` ##### `mode` Data type: `String` The mode to set on the dropin file Default value: `'0444'` ##### `show_diff` Data type: `Boolean` Whether to show the diff when updating dropin file Default value: ``true`` +##### `notify_service` + +Data type: `Boolean` + +Notify a service for the unit, if it exists + +Default value: ``false`` + ##### `unit` Data type: `Systemd::Unit` ##### `filename` Data type: `Systemd::Dropin` Default value: `$name` ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Default value: `'present'` ### `systemd::network` Creates network config for systemd-networkd #### Parameters The following parameters are available in the `systemd::network` defined type: * [`ensure`](#ensure) * [`path`](#path) * [`content`](#content) * [`source`](#source) * [`target`](#target) * [`owner`](#owner) * [`group`](#group) * [`mode`](#mode) * [`show_diff`](#show_diff) * [`restart_service`](#restart_service) ##### `ensure` Data type: `Enum['file', 'absent']` Default value: `file` ##### `path` Data type: `Stdlib::Absolutepath` Default value: `'/etc/systemd/network'` ##### `content` Data type: `Optional[String]` Default value: ``undef`` ##### `source` Data type: `Optional[String]` Default value: ``undef`` ##### `target` Data type: `Optional[Stdlib::Absolutepath]` Default value: ``undef`` ##### `owner` Data type: `String` Default value: `'root'` ##### `group` Data type: `String` Default value: `'root'` ##### `mode` Data type: `String` Default value: `'0444'` ##### `show_diff` Data type: `Boolean` Default value: ``true`` ##### `restart_service` Data type: `Boolean` Default value: ``true`` ### `systemd::service_limits` Adds a set of custom limits to the service * **See also** * systemd.exec(5) #### Parameters The following parameters are available in the `systemd::service_limits` defined type: * [`name`](#name) * [`ensure`](#ensure) * [`path`](#path) * [`selinux_ignore_defaults`](#selinux_ignore_defaults) * [`limits`](#limits) * [`source`](#source) * [`restart_service`](#restart_service) ##### `name` Data type: `Pattern['^.+\.(service|socket|mount|swap)$']` The name of the service that you will be modifying ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Whether to drop a file or remove it Default value: `'present'` ##### `path` Data type: `Stdlib::Absolutepath` The path to the main systemd settings directory Default value: `'/etc/systemd/system'` ##### `selinux_ignore_defaults` Data type: `Optional[Boolean]` If Puppet should ignore the default SELinux labels. Default value: ``false`` ##### `limits` Data type: `Optional[Systemd::ServiceLimits]` A Hash of service limits matching the settings in ``systemd.exec(5)`` * Mutually exclusive with ``$source`` Default value: ``undef`` ##### `source` Data type: `Optional[String]` A ``File`` resource compatible ``source`` * Mutually exclusive with ``$limits`` Default value: ``undef`` ##### `restart_service` Data type: `Boolean` Restart the managed service after setting the limits Default value: ``true`` ### `systemd::timer` Create a timer and optionally a service unit to execute with the timer unit * **See also** * https://www.freedesktop.org/software/systemd/man/systemd.timer.html * systemd.timer(5) #### Parameters The following parameters are available in the `systemd::timer` defined type: * [`name`](#name) * [`path`](#path) * [`timer_content`](#timer_content) * [`timer_source`](#timer_source) * [`service_content`](#service_content) * [`service_source`](#service_source) * [`owner`](#owner) * [`group`](#group) * [`mode`](#mode) * [`show_diff`](#show_diff) * [`service_unit`](#service_unit) * [`active`](#active) * [`enable`](#enable) * [`ensure`](#ensure) ##### `name` Data type: `Pattern['^.+\.timer$]` The target of the timer unit to create ##### `path` Data type: `Stdlib::Absolutepath` The main systemd configuration path Default value: `'/etc/systemd/system'` ##### `timer_content` Data type: `Optional[String[1]]` The full content of the timer unit file * Mutually exclusive with ``$timer_source`` Default value: ``undef`` ##### `timer_source` Data type: `Optional[String[1]]` The ``File`` resource compatible ``source`` * Mutually exclusive with ``$timer_content`` Default value: ``undef`` ##### `service_content` Data type: `Optional[String[1]]` The full content of the service unit file * Mutually exclusive with ``$service_source`` Default value: ``undef`` ##### `service_source` Data type: `Optional[String[1]]` The ``File`` resource compatible ``source`` * Mutually exclusive with ``$service_content`` Default value: ``undef`` ##### `owner` Data type: `String[1]` The owner to set on the dropin file Default value: `'root'` ##### `group` Data type: `String[1]` The group to set on the dropin file Default value: `'root'` ##### `mode` Data type: `Stdlib::Filemode` The mode to set on the dropin file Default value: `'0444'` ##### `show_diff` Data type: `Boolean` Whether to show the diff when updating dropin file Default value: ``true`` ##### `service_unit` Data type: `Optional[Systemd::Unit]` If set then the service_unit will have this name. If not set the service unit has the same name as the timer unit with s/.timer/.service/ Default value: ``undef`` ##### `active` Data type: `Optional[Boolean]` If set to true or false the timer service will be maintained. If true the timer service will be running and enabled, if false it will explictly stopped and disabled. Default value: ``undef`` ##### `enable` Data type: `Optional[Variant[Boolean, Enum['mask']]]` If set, will manage the state of the unit. Default value: ``undef`` ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Default value: `'present'` ### `systemd::tmpfile` Creates a systemd tmpfile * **See also** * systemd-tmpfiles(8) #### Parameters The following parameters are available in the `systemd::tmpfile` defined type: * [`name`](#name) * [`ensure`](#ensure) * [`path`](#path) * [`content`](#content) * [`source`](#source) * [`filename`](#filename) ##### `name` Data type: `Pattern['^[^/]+\.conf$']` (filename) The name of the tmpfile to create ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Whether to drop a file or remove it Default value: `'file'` ##### `path` Data type: `Stdlib::Absolutepath` The path to the main systemd tmpfiles directory Default value: `'/etc/tmpfiles.d'` ##### `content` Data type: `Optional[String]` The literal content to write to the file * Mutually exclusive with ``$source`` Default value: ``undef`` ##### `source` Data type: `Optional[String]` A ``File`` resource compatible ``source`` * Mutually exclusive with ``$limits`` Default value: ``undef`` ##### `filename` Data type: `Systemd::Dropin` Default value: `$name` ### `systemd::udev::rule` Adds a custom udev rule * **See also** * udev(7) #### Parameters The following parameters are available in the `systemd::udev::rule` defined type: * [`name`](#name) * [`ensure`](#ensure) * [`path`](#path) * [`selinux_ignore_defaults`](#selinux_ignore_defaults) * [`notify_services`](#notify_services) * [`rules`](#rules) ##### `name` Data type: `Pattern['^.+\.rules$']` The name of the udev rules to create ##### `ensure` Data type: `Enum['present', 'absent', 'file']` Whether to drop a file or remove it Default value: `'present'` ##### `path` Data type: `Stdlib::Absolutepath` The path to the main systemd settings directory Default value: `'/etc/udev/rules.d'` ##### `selinux_ignore_defaults` Data type: `Optional[Boolean]` If Puppet should ignore the default SELinux labels. Default value: ``false`` ##### `notify_services` Data type: `Optional[Variant[Array, String]]` List of services to notify when this rule is updated Default value: `[]` ##### `rules` Data type: `Array` The literal udev rules you want to deploy ### `systemd::unit_file` Creates a systemd unit file * **See also** * systemd.unit(5) #### Parameters The following parameters are available in the `systemd::unit_file` defined type: * [`name`](#name) * [`ensure`](#ensure) * [`path`](#path) * [`content`](#content) * [`source`](#source) * [`target`](#target) * [`owner`](#owner) * [`group`](#group) * [`mode`](#mode) * [`show_diff`](#show_diff) * [`enable`](#enable) * [`active`](#active) * [`restart`](#restart) ##### `name` Data type: `Pattern['^[^/]+\.(service|socket|device|mount|automount|swap|target|path|timer|slice|scope)$']` The target unit file to create ##### `ensure` Data type: `Enum['present', 'absent', 'file']` The state of the unit file to ensure Default value: `'present'` ##### `path` Data type: `Stdlib::Absolutepath` The main systemd configuration path Default value: `'/etc/systemd/system'` ##### `content` Data type: `Optional[String]` The full content of the unit file * Mutually exclusive with ``$source`` Default value: ``undef`` ##### `source` Data type: `Optional[String]` The ``File`` resource compatible ``source`` * Mutually exclusive with ``$content`` Default value: ``undef`` ##### `target` Data type: `Optional[Stdlib::Absolutepath]` If set, will force the file to be a symlink to the given target * Mutually exclusive with both ``$source`` and ``$content`` Default value: ``undef`` ##### `owner` Data type: `String` The owner to set on the unit file Default value: `'root'` ##### `group` Data type: `String` The group to set on the unit file Default value: `'root'` ##### `mode` Data type: `String` The mode to set on the unit file Default value: `'0444'` ##### `show_diff` Data type: `Boolean` Whether to show the diff when updating unit file Default value: ``true`` ##### `enable` Data type: `Optional[Variant[Boolean, Enum['mask']]]` If set, will manage the unit enablement status. Default value: ``undef`` ##### `active` Data type: `Optional[Boolean]` If set, will manage the state of the unit. Default value: ``undef`` ##### `restart` Data type: `Optional[String]` Specify a restart command manually. If left unspecified, a standard Puppet service restart happens. Default value: ``undef`` ## Resource types ### `loginctl_user` An arbitrary name used as the identity of the resource. #### Properties The following properties are available in the `loginctl_user` type. ##### `linger` Valid values: `enabled`, `disabled` Whether linger is enabled for the user. Default value: `disabled` #### Parameters The following parameters are available in the `loginctl_user` type. * [`name`](#name) * [`provider`](#provider) ##### `name` namevar An arbitrary name used as the identity of the resource. ##### `provider` The specific backend to use for this `loginctl_user` resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform. ## Data types ### `Systemd::Dropin` The Systemd::Dropin data type. Alias of ```puppet Pattern['^[^/]+\.conf$'] ``` ### `Systemd::JournaldSettings` Matches Systemd journald config Struct Alias of ```puppet Struct[{ Optional['Storage'] => Variant[Enum['volatile','persistent','auto','none'],Systemd::JournaldSettings::Ensure], Optional['Compress'] => Variant[Enum['yes','no'], Pattern[/^[0-9]+(K|M|G)?$/],Systemd::JournaldSettings::Ensure], Optional['Seal'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['SplitMode'] => Variant[Enum['uid','none'],Systemd::JournaldSettings::Ensure], Optional['RateLimitInterval'] => Variant[Pattern[/^[0-9]+(s|min|h|ms|us)?$/],Systemd::JournaldSettings::Ensure], Optional['RateLimitIntervalSec'] => Variant[Pattern[/^[0-9]+(s|min|h|ms|us)?$/],Systemd::JournaldSettings::Ensure], Optional['RateLimitBurst'] => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure], Optional['SystemMaxUse'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['SystemKeepFree'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['SystemMaxFileSize'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['SystemMaxFiles'] => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure], Optional['RuntimeMaxUse'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['RuntimeKeepFree'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['RuntimeMaxFileSize'] => Variant[Pattern[/^[0-9]+(K|M|G|T|P|E)?$/],Systemd::JournaldSettings::Ensure], Optional['RuntimeMaxFiles'] => Variant[Integer[0], Pattern[/^[0-9]+$/],Systemd::JournaldSettings::Ensure], Optional['MaxFileSec'] => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure], Optional['MaxRetentionSec'] => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure], Optional['SyncIntervalSec'] => Variant[Pattern[/^[0-9]+(year|month|week|day|h|m)?$/],Systemd::JournaldSettings::Ensure], Optional['ForwardToSyslog'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['ForwardToKMsg'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['ForwardToConsole'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['ForwardToWall'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['MaxLevelStore'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['MaxLevelSyslog'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['MaxLevelKMsg'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['MaxLevelConsole'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['MaxLevelWall'] => Variant[Enum['emerg','alert','crit','err','warning','notice','info','debug'],Integer[0,7],Systemd::JournaldSettings::Ensure], Optional['ReadKMsg'] => Variant[Enum['yes','no'],Systemd::JournaldSettings::Ensure], Optional['TTYPath'] => Variant[Stdlib::Absolutepath,Systemd::JournaldSettings::Ensure], Optional['LineMax'] => Variant[Pattern[/^[0-9]+(K|M|G|T)?$/],Systemd::JournaldSettings::Ensure], }] ``` ### `Systemd::JournaldSettings::Ensure` The Systemd::JournaldSettings::Ensure data type. Alias of ```puppet Struct[{ 'ensure' => Enum['present','absent'] }] ``` ### `Systemd::LogindSettings` Matches Systemd Login Manager Struct Alias of ```puppet Struct[{ Optional['HandleHibernateKey'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandleLidSwitch'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandleLidSwitchDocked'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandleLidSwitchExternalPower'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandlePowerKey'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HandleSuspendKey'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['HibernateKeyIgnoreInhibited'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['HoldoffTimeoutSec'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['IdleAction'] => Variant[Enum['ignore','poweroff','reboot','halt','kexec','suspend','hibernate','hybrid-sleep','suspend-then-hibernate','lock'],Systemd::LogindSettings::Ensure], Optional['IdleActionSec'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['InhibitDelayMaxSec'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['InhibitorsMax'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['KillExcludeUsers'] => Variant[Array[String],Systemd::LogindSettings::Ensure], Optional['KillOnlyUsers'] => Variant[Array[String],Systemd::LogindSettings::Ensure], Optional['KillUserProcesses'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['LidSwitchIgnoreInhibited'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['NAutoVTs'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['PowerKeyIgnoreInhibited'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['RemoveIPC'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['ReserveVT'] => Variant[Integer,Systemd::LogindSettings::Ensure], Optional['RuntimeDirectorySize'] => Variant[Integer,Pattern['^(\d+(K|M|G|T|P|E|%)?)$'],Systemd::LogindSettings::Ensure], Optional['SessionsMax'] => Variant[Integer,Pattern['^(infinity|(\d+(K|M|G|T|P|E|%)?))$'],Systemd::LogindSettings::Ensure], Optional['SuspendKeyIgnoreInhibited'] => Variant[Enum['yes','no'],Systemd::LogindSettings::Ensure], Optional['UserTasksMax'] => Variant[Integer,Pattern['^(infinity|(\d+(K|M|G|T|P|E|%)?))$'],Systemd::LogindSettings::Ensure] }] ``` ### `Systemd::LogindSettings::Ensure` The Systemd::LogindSettings::Ensure data type. Alias of ```puppet Struct[{ 'ensure' => Enum['present','absent'] }] ``` ### `Systemd::ServiceLimits` Matches Systemd Service Limit Struct Alias of ```puppet Struct[{ Optional['LimitCPU'] => Pattern['^\d+(s|m|h|d|w|M|y)?(:\d+(s|m|h|d|w|M|y)?)?$'], Optional['LimitFSIZE'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitDATA'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitSTACK'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitCORE'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitRSS'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitNOFILE'] => Variant[Integer[-1],Pattern['^(infinity|\d+(:(infinity|\d+))?)$']], Optional['LimitAS'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitNPROC'] => Variant[Integer[-1],Pattern['^(infinity|\d+(:(infinity|\d+))?)$']], Optional['LimitMEMLOCK'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitLOCKS'] => Integer[1], Optional['LimitSIGPENDING'] => Integer[1], Optional['LimitMSGQUEUE'] => Pattern['^(infinity|((\d+(K|M|G|T|P|E)(:\d+(K|M|G|T|P|E))?)))$'], Optional['LimitNICE'] => Variant[Integer[0,40], Pattern['^(-\+([0-1]?[0-9]|20))|([0-3]?[0-9]|40)$']], Optional['LimitRTPRIO'] => Integer[0], Optional['LimitRTTIME'] => Pattern['^\d+(ms|s|m|h|d|w|M|y)?(:\d+(ms|s|m|h|d|w|M|y)?)?$'], Optional['CPUAccounting'] => Boolean, Optional['CPUShares'] => Integer[2,262144], Optional['StartupCPUShares'] => Integer[2,262144], Optional['CPUQuota'] => Pattern['^([1-9][0-9]*)%$'], Optional['MemoryAccounting'] => Boolean, Optional['MemoryLow'] => Pattern['^(\d+(K|M|G|T)?)$'], Optional['MemoryHigh'] => Pattern['^(\d+(K|M|G|T)?)$'], Optional['MemoryMax'] => Pattern['^(\d+(K|M|G|T)?)$'], Optional['MemoryLimit'] => Pattern['^(\d+(K|M|G|T)?)$'], Optional['TasksAccounting'] => Boolean, Optional['TasksMax'] => Variant[Integer[1],Pattern['^(infinity|([1-9][0-9]?$|^100)%)$']], Optional['IOAccounting'] => Boolean, Optional['IOWeight'] => Integer[1,10000], Optional['StartupIOWeight'] => Integer[1,10000], Optional['IODeviceWeight'] => Array[Hash[Stdlib::Absolutepath, Integer[1,10000], 1, 1]], Optional['IOReadBandwidthMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]], Optional['IOWriteBandwidthMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]], Optional['IOReadIOPSMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]], Optional['IOWriteIOPSMax'] => Array[Hash[Stdlib::Absolutepath, Pattern['^(\d+(K|M|G|T)?)$'], 1, 1]], Optional['DeviceAllow'] => String[1], Optional['DevicePolicy'] => Enum['auto','closed','strict'], Optional['Slice'] => String[1], Optional['Delegate'] => Boolean, Optional['OOMScoreAdjust'] => Integer[-1000,1000] }] ``` ### `Systemd::Unit` The Systemd::Unit data type. Alias of ```puppet Pattern['^[^/]+\.(service|socket|device|mount|automount|swap|target|path|timer|slice|scope)$'] ``` diff --git a/manifests/dropin_file.pp b/manifests/dropin_file.pp index 7390963..326fc7a 100644 --- a/manifests/dropin_file.pp +++ b/manifests/dropin_file.pp @@ -1,90 +1,104 @@ # Creates a drop-in file for a systemd unit # # @api public # # @see systemd.unit(5) # # @param name [Pattern['^[^/]+\.conf$']] # The target unit file to create # # @param path # The main systemd configuration path # # @param selinux_ignore_defaults # If Puppet should ignore the default SELinux labels. # # @param content # The full content of the unit file # # * Mutually exclusive with ``$source`` # # @param source # The ``File`` resource compatible ``source`` # # * Mutually exclusive with ``$content`` # # @param target # If set, will force the file to be a symlink to the given target # # * Mutually exclusive with both ``$source`` and ``$content`` # # @param owner # The owner to set on the dropin file # # @param group # The group to set on the dropin file # # @param mode # The mode to set on the dropin file # # @param show_diff # Whether to show the diff when updating dropin file # +# @param notify_service +# Notify a service for the unit, if it exists +# define systemd::dropin_file ( Systemd::Unit $unit, Systemd::Dropin $filename = $name, Enum['present', 'absent', 'file'] $ensure = 'present', Stdlib::Absolutepath $path = '/etc/systemd/system', Optional[Boolean] $selinux_ignore_defaults = false, Optional[Variant[String,Sensitive[String]]] $content = undef, Optional[String] $source = undef, Optional[Stdlib::Absolutepath] $target = undef, String $owner = 'root', String $group = 'root', String $mode = '0444', Boolean $show_diff = true, + Boolean $notify_service = false, ) { include systemd if $target { $_ensure = 'link' } else { $_ensure = $ensure ? { 'present' => 'file', default => $ensure, } } + $full_filename = "${path}/${unit}.d/${filename}" + if $ensure != 'absent' { - ensure_resource('file', "${path}/${unit}.d", { + ensure_resource('file', dirname($full_filename), { ensure => directory, owner => 'root', group => 'root', recurse => $systemd::purge_dropin_dirs, purge => $systemd::purge_dropin_dirs, selinux_ignore_defaults => $selinux_ignore_defaults, }) } - file { "${path}/${unit}.d/${filename}": + file { $full_filename: ensure => $_ensure, content => $content, source => $source, target => $target, owner => $owner, group => $group, mode => $mode, selinux_ignore_defaults => $selinux_ignore_defaults, show_diff => $show_diff, } + + if $notify_service { + File[$full_filename] ~> Service <| title == $unit or name == $unit |> + if $unit =~ /\.service$/ { + $short_service_name = regsubst($unit, /\.service$/, '') + File[$full_filename] ~> Service <| title == $short_service_name or name == $short_service_name |> + } + } } diff --git a/spec/defines/dropin_file_spec.rb b/spec/defines/dropin_file_spec.rb index 2c38ac7..27971a3 100644 --- a/spec/defines/dropin_file_spec.rb +++ b/spec/defines/dropin_file_spec.rb @@ -1,116 +1,146 @@ require 'spec_helper' describe 'systemd::dropin_file' do context 'supported operating systems' do on_supported_os.each do |os, facts| context "on #{os}" do let(:facts) { facts } let(:title) { 'test.conf' } let(:params) do { unit: 'test.service', content: 'random stuff', } end it { is_expected.to compile.with_all_deps } it { is_expected.to create_file("/etc/systemd/system/#{params[:unit]}.d").with( ensure: 'directory', recurse: 'true', purge: 'true', selinux_ignore_defaults: false, ) } it { is_expected.to create_file("/etc/systemd/system/#{params[:unit]}.d/#{title}").with( ensure: 'file', content: %r{#{params[:content]}}, mode: '0444', selinux_ignore_defaults: false, ) } + context 'notifies services' do + let(:params) do + super().merge(notify_service: true) + end + let(:filename) { "/etc/systemd/system/#{params[:unit]}.d/#{title}" } + let(:pre_condition) do + <<-PUPPET + service { ['test', 'test.service']: + } + PUPPET + end + + it { is_expected.to compile.with_all_deps } + it { is_expected.to contain_service('test').that_subscribes_to("File[#{filename}]") } + it { is_expected.to contain_service('test.service').that_subscribes_to("File[#{filename}]") } + + context 'with overridden name' do + let(:pre_condition) do + <<-PUPPET + service { 'myservice': + name => 'test', + } + PUPPET + end + + it { is_expected.to compile.with_all_deps } + it { is_expected.to contain_service('myservice').that_subscribes_to("File[#{filename}]") } + end + end + context 'with selinux_ignore_defaults set to true' do let(:params) do super().merge(selinux_ignore_defaults: true) end it { is_expected.to create_file("/etc/systemd/system/#{params[:unit]}.d").with_selinux_ignore_defaults(true) } it { is_expected.to create_file("/etc/systemd/system/#{params[:unit]}.d/#{title}").with_selinux_ignore_defaults(true) } end context 'with a bad unit type' do let(:title) { 'test.badtype' } it { expect { is_expected.to compile.with_all_deps }.to raise_error(%r{expects a match for Systemd::Dropin}) } end context 'with a bad unit type containing a slash' do let(:title) { 'test/bad.conf' } it { expect { is_expected.to compile.with_all_deps }.to raise_error(%r{expects a match for Systemd::Dropin}) } end context 'with another drop-in file with the same filename (and content)' do let(:default_params) do { filename: 'longer-timeout.conf', content: 'random stuff', } end # Create drop-in file longer-timeout.conf for unit httpd.service let(:pre_condition) do "systemd::dropin_file { 'httpd_longer-timeout': filename => '#{default_params[:filename]}', unit => 'httpd.service', content => '#{default_params[:context]}', }" end # # Create drop-in file longer-timeout.conf for unit ftp.service let(:title) { 'ftp_longer-timeout' } let(:params) do default_params.merge(unit: 'ftp.service') end it { is_expected.to create_file("/etc/systemd/system/#{params[:unit]}.d/#{params[:filename]}").with( ensure: 'file', content: %r{#{params[:content]}}, mode: '0444', ) } end context 'with sensitve content' do let(:title) { 'sensitive.conf' } let(:params) do { unit: 'sensitive.service', content: RSpec::Puppet::RawString.new("Sensitive('TEST_CONTENT')"), } end it { is_expected.to create_file("/etc/systemd/system/#{params[:unit]}.d/#{title}").with( ensure: 'file', content: sensitive('TEST_CONTENT'), ) } end end end end end