Merge branch 'puppet_client_adminguide' into 'master'

Added Puppet client admin guide

See merge request linux-infra/documentation!6

_toc.yml

@@ -40,6 +40,7 @@ chapters:
           - file: admin-guide/configuration/vgroot
           - file: admin-guide/configuration/xrdp
           - file: admin-guide/configuration/custom_nameservers
+          - file: admin-guide/configuration/puppet_agent
           - file: admin-guide/configuration/ssh_host_hopping
           - file: admin-guide/configuration/citrix_vda
       - file: admin-guide/guidelines

admin-guide/configuration.md

@@ -11,6 +11,7 @@ Here starts a so far small collections of configuration guides for sysadmins of
 - [RDP Remote Access with XRDP](configuration/xrdp)
 - [Resize System Volumes (volume group `vg_root`)](configuration/vgroot)
 - [Custom Nameservers](configuration/custom_nameservers)
+- [Puppent Agent run frequency](configuration/puppet_agent) 
 
 ## Special Installations
 - [SSH Host Hopping as Root (e.g. between cluster members)](configuration/ssh_host_hopping)

admin-guide/configuration/puppet_agent.md

@@ -0,0 +1,44 @@
+# Puppet Agent Configuration
+The Puppet agent software communicates with the Puppet master to enforce desired system configurations defined in hiera.
+
+## Automatic Puppet Agent Runs
+Puppet agent is configured to run daily between 5-8 AM.
+This describes how the Puppet agent can be configured to run at different intervals and also at different times than the default.
+
+### Agent Run Frequency
+The intervals the Puppet agent runs can be configured in hiera with `puppet_client::run_frequency`
+
+Allowed parameters
+- 'halfhourly': every 30 minutes (to see the exact time do `systemctl list-timers pli-puppet-run.timer`)
+- 'daily': once a day (default)
+- 'weekly': every Monday 
+
+The daily and weekly Puppet run respect the value set for `puppet_client::exec_time:`
+
+### Execution Time
+The actual automatic Puppet Agent run is always on the same random time. Check ... for the exact time.
+For `daily` and `weekly` this time window is configured in Hiera with `puppet_client::exec_time`, the default is:
+
+`puppet_client::exec_time: '05:00 -- 08:00'``
+
+The time format used is '24-hour clock' `HH:MM -- HH:MM`
+
+## Temporarily Disable Automatic Puppet Agent Runs
+Puppet execution can be disabled for a certain amount of time with the
+``/opt/pli/libexec/pli-puppet-disable`` command: ::
+
+ [root@lxdev04 ~]# /opt/pli/libexec/pli-puppet-disable
+ puppet currently not disabled
+ [root@lxdev04 ~]# /opt/pli/libexec/pli-puppet-disable '1 week'
+ [root@lxdev04 ~]# /opt/pli/libexec/pli-puppet-disable
+ Puppet disabled until: Wed Nov 1 08:00:05 CET 2017
+ [root@lxdev04 ~]# /opt/pli/libexec/pli-puppet-disable stop
+ Stopping
+ [root@lxdev04 ~]# /opt/pli/libexec/pli-puppet-disable
+ puppet currently not disabled
+ [root@lxdev04 ~]#
+
+The disabling time has to be in the ``date`` format (see date(1)).
+
+## Manual Execution of Puppet Agent
+The Puppet agent can be run manually by executing following command `puppet agent -t`