From 9d5cf0e7d2acd485182224728d20a6216597b081 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Wed, 27 Sep 2023 07:36:38 +0200 Subject: Cleanup and documentation. --- manifests/networkd.pp | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) (limited to 'manifests/networkd.pp') diff --git a/manifests/networkd.pp b/manifests/networkd.pp index e7db086..74d653f 100644 --- a/manifests/networkd.pp +++ b/manifests/networkd.pp @@ -1,3 +1,31 @@ +# @summary Systemd Networkd network provider +# +# Networkd is rather nice to work with, since it relies heavily on different files. +# +# @see systemd-networkd(8) +# An introduction to how networkd works. +# +# @param notify_ +# Should the network daemon be reloaded when things changes. This is +# most likely a transient setting as part of the development, since +# currently things can self-destruct if not carefull. +# @param manage_directory +# If enabled, then the directory mentioned by `path` will both be +# created, and purged by this module. +# +# TODO this should be split into two: +# - Manage directory existance +# - Purge directory +# @param path +# Directory in which network and netdev files will be placed. +# +# The following directories are the default search paths for Networkd, +# so it's recommended to chose one of them: +# +# - `/usr/lib/systemd/network` +# - `/usr/local/lib/systemd/network` +# - `/run/systemd/network` +# - `/etc/systemd/network` class networking::networkd ( Boolean $notify_ = true, Boolean $manage_directory = true, @@ -11,7 +39,7 @@ class networking::networkd ( } } - # Force a full restort of systemd networkd to reload all configuration. + # Force a full restart of systemd networkd to reload all configuration. # The alternative is to first run `networkctl reload` which reloads # network files, followed by a `networkctl reconfigure `. # -- cgit v1.2.3