From c439b8a524fc8f797e98b2c5351b028cf91ce237 Mon Sep 17 00:00:00 2001 From: intrigeri Date: Wed, 29 Jun 2016 18:45:32 +0000 Subject: Remove documentation for apt::cron::download, and document the new parameter to apt::cron::dist_upgrade. --- README.md | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2173d7e..2028e2a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,6 @@ * [Classes](#classes) * [apt](#apt) * [apt::apticron](#apt-apticron) - * [apt::cron::download](#apt-cron-download) * [apt::cron::dist_upgrade](#apt-cron-dist_upgrade) * [apt::dist_upgrade](#apt-dist_upgrade) * [apt::dist_upgrade::initiator](#apt-dist_upgrade-initiator) @@ -324,30 +323,20 @@ Example usage: } -## apt::cron::download +## apt::cron::dist_upgrade -This class sets up `cron-apt` so that it downloads upgradable packages, does not -actually do any upgrade and emails when the output changes. +This class sets up cron-apt so that it dist-upgrades the system and +emails when upgrades are performed. `cron-apt` defaults to run at 4 AM. You may want to set the -`$apt_cron_hours` variable before you include the class: its value will +`$cron_hours` class parameter before you include the class: its value will be passed as the "hours" parameter of a cronjob. Example: # Run cron-apt every three hours - $apt_cron_hours = '*/3' + class { 'apt::cron::dist_upgrade': cron_hours => '*/3' } Note that the default 4 AM cronjob won't be disabled. - -## apt::cron::dist_upgrade - -This class sets up cron-apt so that it dist-upgrades the system and -emails when upgrades are performed. - -See [apt::cron::download](#apt-cron-download) above if you need to run `cron-apt` more often -than once a day. - - ## apt::dist_upgrade This class provides the `Exec['apt_dist-upgrade']` resource that -- cgit v1.2.3