summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README72
1 files changed, 40 insertions, 32 deletions
diff --git a/README b/README
index 6b1bfcd..9f95749 100644
--- a/README
+++ b/README
@@ -19,13 +19,13 @@ Ubuntu support is lagging behind but not absent either.
* the apt class has been moved to a paramterized class. if you were including
this class before, after passing some variables, you will need to move to
- instantiating the class with those variables instead. For example, if you
+ instantiating the class with those variables instead. For example, if you
had the following in your manifests:
$apt_debian_url = 'http://localhost:9999/debian/'
$apt_use_next_release = true
include apt
-
+
you will need to remove the variables, and the include and instead do
the following:
@@ -67,9 +67,9 @@ Ubuntu support is lagging behind but not absent either.
you will need to remove the variables, and the include and instead do the
following:
-
+
class { 'apt::listchanges': email => 'foo@example.com' }
-
+
* the apt::proxy_client class has been moved to a paramterized class. if you
were including this class before, after passing some variables, you will need
to move to instantiating the class with those variables instead. For example,
@@ -113,22 +113,6 @@ the site_apt modules' files directory that is named the same as the
host. (example: site_apt/files/some.host.com/03clean, or
site_apt/files/some.host.com/03clean_vserver)
-Variables
-=========
-
-$custom_sources_list
---------------------
-
-By default this module will use a basic apt/sources.list template with
-a generic Debian mirror. If you need to set more specific sources,
-(e.g. changing the sections included in the source, etc.) you can
-override the default by passing $custom_sources_list argument to apt
-class. For example:
-
- class { 'apt':
- custom_sources_list => template('site_apt/sources.list')
- }
-
Classes
=======
@@ -146,9 +130,8 @@ Class parameters:
* use_volatile
- If this variable is set to true the Debian Volatile sources (until
- Lenny) or CODENAME-updates (such as squeeze-updates, supported since
- Squeeze) are added.
+ If this variable is set to true the CODENAME-updates sources (such as
+ squeeze-updates) are added.
By default this is false for backward compatibility with older
versions of this module.
@@ -188,17 +171,17 @@ Class parameters:
* disable_update
- Disable "apt-get update" which is normally triggered by apt::upgrade_package
- and apt::dist_upgrade.
+ Disable "apt-get update" which is normally triggered by apt::upgrade_package
+ and apt::dist_upgrade.
- Note that nodes can be updated once a day by using
+ Note that nodes can be updated once a day by using
APT::Periodic::Update-Package-Lists "1";
in i.e. /etc/apt/apt.conf.d/80_apt_update_daily.
* custom_preferences
- Since Debian Lenny's version of APT doesn't support the use of the
- preferences.d directory for putting fragments of 'preferences', this
+ For historical reasons (Debian Lenny's version of APT did not support the use
+ of the preferences.d directory for putting fragments of 'preferences'), this
module will manage a default generic apt/preferences file with more
recent releases pinned to very low values so that any package
installation will not accidentally pull in packages from those suites
@@ -213,6 +196,18 @@ Class parameters:
apt/preferences file to be absent:
class { 'apt': custom_preferences => false }
+
+* custom_sources_list
+
+ By default this module will use a basic apt/sources.list template with
+ a generic Debian mirror. If you need to set more specific sources,
+ e.g. changing the sections included in the source, etc. you can set
+ this variable to the content that you desire to use instead.
+
+ For example, setting this variable will pull in the
+ templates/site_apt/sources.list file:
+
+ class { 'apt': custom_sources_list => template('site_apt/sources.list') }
* codename
@@ -339,7 +334,7 @@ the following parameterized variables, which can be changed:
Example usage:
class { 'apt::listchanges': email => 'foo@example.com' }
-
+
apt::proxy_client
-----------------
@@ -367,6 +362,17 @@ apt::unattended_upgrades
If this class is included, it will install the package 'unattended-upgrades'
and configure it to daily upgrade the system.
+The class has the following parameters that you can use to change the contents
+of the configuration file. The values shown here are the default values:
+
+ * $config_content = undef
+ * $mailonlyonerror = true
+ * $mail_recipient = 'root'
+ * $blacklisted_packages = []
+
+Note that using $config_content actually specifies all of the configuration
+contents and thus makes the other parameters useless.
+
Defines
=======
@@ -432,7 +438,7 @@ following in your manifest:
apt::preseeded_package { locales: }
-You can also specify the content of the seed via the content parameter,
+You can also specify the content of the seed via the content parameter,
for example:
apt::preseeded_package { 'apticron':
@@ -445,11 +451,13 @@ apt::sources_list
Creates a file in the apt/sources.list.d directory to easily add additional apt
sources. One can use either the 'source' meta-parameter to specify a list of
static files to include from the puppet fileserver or the 'content'
-meta-parameter to define content inline or with the help of a template.
+meta-parameter to define content inline or with the help of a template. Ending
+the resource name in '.list' is optional: it will be automatically added to the
+file name if not present in the resource name.
Example:
- apt::sources_list { 'company_internals.list':
+ apt::sources_list { 'company_internals':
source => [ "puppet:///modules/site_apt/${::fqdn}/company_internals.list",
'puppet:///modules/site_apt/company_internals.list' ],
}