X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=README.md;h=0749cb85af247cb6b784fb3a512fee343c9cfbd8;hb=a68eca58a658e432fbfffcd91862134082ac7dc0;hp=20c465dbfa1eec47e5ef0ccdfc21609635c8554b;hpb=ed52e513db21eca180c4ac80cce0cfe116549653;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/README.md b/README.md index 20c465d..0749cb8 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,6 @@ apt [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt) -## Description - -Provides helpful definitions for dealing with Apt. - -======= - Overview -------- @@ -19,12 +13,15 @@ Module Description APT automates obtaining and installing software packages on \*nix systems. +***Note:** While this module allows the use of short keys, we STRONGLY RECOMMEND that you DO NOT USE short keys, as they pose a serious security issue in that they open you up to collision attacks.* + Setup ----- **What APT affects:** * package/service/configuration files for APT + * NOTE: Setting the `purge_preferences` or `purge_preferences_d` parameters to 'true' will destroy any existing configuration that was not declared with puppet. The default for these parameters is 'false'. * your system's `sources.list` file and `sources.list.d` directory * NOTE: Setting the `purge_sources_list` and `purge_sources_list_d` parameters to 'true' will destroy any existing content that was not declared with Puppet. The default for these parameters is 'false'. * system repositories @@ -36,7 +33,7 @@ To begin using the APT module with default parameters, declare the class include apt -Puppet code that uses anything from the APT module requires that the core apt class be declared/\s\+$//e +Puppet code that uses anything from the APT module requires that the core apt class be declared. Usage ----- @@ -57,12 +54,13 @@ The parameters for `apt` are not required in general and are predominantly for d purge_sources_list => false, purge_sources_list_d => false, purge_preferences_d => false, - update_timeout => undef + update_timeout => undef, + fancy_progress => undef } Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content. -If you declare your apt class with `purge_sources_list` and `purge_sources_list_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet. +If you declare your apt class with `purge_sources_list`, `purge_sources_list_d`, `purge_preferences` and `purge_preferences_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet. ### apt::builddep @@ -196,6 +194,7 @@ Sets the default apt release. This class is particularly useful when using repos Adds an apt source to `/etc/apt/sources.list.d/`. apt::source { 'debian_unstable': + comment => 'This is the iWeb Debian unstable mirror', location => 'http://debian.mirror.iweb.ca/debian/', release => 'unstable', repos => 'main contrib non-free', @@ -215,6 +214,13 @@ If you would like to configure your system so the source is the Puppet Labs APT key_server => 'pgp.mit.edu', } +### Facts + +There are a few facts included within the apt module describing the state of the apt system: + +* `apt_updates` - the number of updates available on the system +* `apt_security_updates` - the number of updates which are security updates +* `apt_package_updates` - the package names that are available for update. On Facter 2.0 and newer this will be a list type, in earlier versions it is a comma delimitered string. #### Hiera example 
@@ -323,3 +329,4 @@ A lot of great people have contributed to this module. A somewhat current list f
 * William Van Hevelingen  
 * Zach Leslie 
 * Daniele Sluijters 
+* Daniel Paulus