diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 128 |
1 files changed, 90 insertions, 38 deletions
@@ -9,13 +9,18 @@ package download current. backports.debian.org is added. -/etc/apt/sources.list and /etc/apt/preferences are managed. Testing and -unstable are pinned to very low values by default to prevent accidental -upgrades. +/etc/apt/sources.list and /etc/apt/preferences are managed. More +recent Debian releases are pinned to very low values by default to +prevent accidental upgrades. -This module needs lsb-release installed. +Ubuntu support is lagging behind but not absent either. -By default, this module sets the cofiguration option DSelect::Clean to 'auto'. +This module needs: + +- lsb-release installed +- the common module: git://labs.riseup.net/shared-common + +By default, this module sets the configuration option DSelect::Clean to 'auto'. It is the recommended value on normal hosts. On virtual servers, the recommended value is 'pre-auto', since virtual servers are usually more space-bound and have better recovery mechanisms via the host: @@ -45,25 +50,12 @@ Contains the codename ("etch", "lenny", ...) of the client's release. While these values come from lsb-release by default, this value can be set manually too, e.g. to enable forced upgrades. -$main_apt_source ----------------- - -If the default sources.list template (see next variable) suits your needs but -you simply need to change the URL to the apt source used, set this variable to -the URL that is desired. The default value for this variable is -"http://ftp.debian.org/debian/" for Debian and -"http://de.archive.ubuntu.com/ubuntu/" for Ubuntu. - -Here's an example for setting a local source near Montreal, Quebec, Canada: - - $apt_main_source = "ftp://debian.mirror.iweb.ca/debian/" - $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 or removing backports, etc. you can set +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 the following variable before including this class will @@ -71,20 +63,20 @@ pull in the templates/site-apt/sources.list file: $custom_sources_list = template("site-apt/sources.list") -$custom_preferences -------------------- +$custom_preferences +-------------------- -Since Debian stable's version of apt doesn't support the use of the -preferences.d directory for putting fragments of 'preferences', this module -will manage a default basic apt/preferences file with unstable and testing -pinned to very low values so that any package installation will not -accidentally pull in packages from those suites unless you explicitly specify -the version number. This file will be complemented with all of the -preferences_snippet calls (see below). +Since Debian stable's version of APT doesn't 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 +unless you explicitly specify the version number. This file will be +complemented with all of the preferences_snippet calls (see below). -If you are not using the 'stable' branch or if the default preferences file -doesn't suit your needs, you can create a file named 'preferences' in a -site-apt module's files directory. You can also create a host-specific file: +If the default preferences template doesn't suit your needs, you can +create a file named 'preferences' in a site-apt module's files +directory. You can also create a host-specific file: site-apt - files/ @@ -92,7 +84,7 @@ site-apt module's files directory. You can also create a host-specific file: - preferences preferences -You can set this variable to false before including this class will force the +Setting this variable to false before including this class will force the apt/preferences file to be absent: $custom_preferences = false @@ -119,12 +111,70 @@ Here's an example of setting the proxy to 'http://proxy.domain' at port 666: $apt_proxy_port = 666 include apt::proxy_client +$apt_volatile_enabled +----------------- + +If this variable is set to true the Debian Volatile sources are added. +By default this is false for backward compatibility with older +versions of this module. + +$apt_include_src +---------------- + +If this variable is set to true a deb-src source is added for every +added binary archive source. +By default this is false for backward compatibility with older +versions of this module. + +$apt_use_next_release +--------------------- + +If this variable is set to true the sources for the next Debian +release are added. The default pinning configuration pins it to very +low values. +By default this is false for backward compatibility with older +versions of this module. + +$apt_debian_url, $apt_security_url, $apt_backports_url, $apt_volatile_url +------------------------------------------------------------------------- + +These variables allow to override the default APT mirrors respectively +used for the standard Debian archives, the Debian security archive, +the Debian official backports and the Debian Volatile archive. + +$apt_ubuntu_url +--------------- + +These variables allows to override the default APT mirror used for all +standard Ubuntu archives (including updates, security, backports). + +$apt_repos +---------- + +If this variable is set the default repositories list ("main contrib non-free") +is overriden. + Classes ======= -Most of the functionality is provided by the 'apt' class, but some -functionality is not inclulded by default. To use it, you must inlucde one of -the following classes: +apt +--- + +The apt class sets up most of the documented functionality. To use +functionality that is not enabled by default, you must inlucde one of +the following classes. + +apt::cron::download +------------------- + +This class sets up cron-apt so that it downloads upgradable packages, +does not actually do any upgrade and email when the output changes. + +apt::cron::dist-upgrade +----------------------- + +This class sets up cron-apt so that it dist-upgrades the system and +email when upgrades are performed. apt::dselect ------------ @@ -247,7 +297,9 @@ TODO ==== Currently this module updates the caches on every run. Running apt-get update is -an expensive operation and should be done only on schedule by using apticron. +an expensive operation and should be done only on schedule by using +apticron or cron-apt. + Sometimes -- especially when initially starting management or deploying new packages -- a immediate update is really needed to be able to install the right packages without errors. Thus a method should be devised to be able to specify |