diff options
Diffstat (limited to 'lib/chef/resource/systemd_unit.rb')
| -rw-r--r-- | lib/chef/resource/systemd_unit.rb | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/lib/chef/resource/systemd_unit.rb b/lib/chef/resource/systemd_unit.rb index a7508660f7..8197d760ab 100644 --- a/lib/chef/resource/systemd_unit.rb +++ b/lib/chef/resource/systemd_unit.rb @@ -44,16 +44,24 @@ class Chef property :static, [TrueClass, FalseClass], skip_docs: true # User-provided properties - property :user, String, desired_state: false - property :content, [String, Hash] + property :user, String, desired_state: false, + description: "The user account that the systemd unit process is run under. The path to the unit for that user would be something like '/etc/systemd/user/sshd.service'. If no user account is specified, the systemd unit will run under a 'system' account, with the path to the unit being something like '/etc/systemd/system/sshd.service'." + + property :content, [String, Hash], + description: "A string or hash that contains a systemd `unit file <https://www.freedesktop.org/software/systemd/man/systemd.unit.html>`_ definition that describes the properties of systemd-managed entities, such as services, sockets, devices, and so on. In Chef 14.4 or later, repeatable options can be implemented with an array." + property :triggers_reload, [TrueClass, FalseClass], - default: true, desired_state: false + description: "Specifies whether to trigger a daemon reload when creating or deleting a unit.", + default: true, desired_state: false + property :verify, [TrueClass, FalseClass], - default: true, desired_state: false + default: true, desired_state: false, + description: "Specifies if the unit will be verified before installation. Systemd can be overly strict when verifying units, so in certain cases it is preferable not to verify the unit." + property :unit_name, String, desired_state: false, - identity: true, - name_property: true, - introduced: "13.7" + identity: true, name_property: true, + description: "The name of the unit file if it differs from the resource block name.", + introduced: "13.7" def to_ini case content |