X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=README.md;h=b0574a7aa0a138adbb9b536c79a0ef13f828fd37;hb=1e1f61a636b6432622af25c8c9e190de7d5a8370;hp=705cb33de5be1eac3c9995fa7c893a77c5f1004f;hpb=bd6830278391253d17e8f1991ea0ab6df8080502;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/README.md b/README.md index 705cb33..b0574a7 100644 --- a/README.md +++ b/README.md @@ -1,106 +1,337 @@ -# Apt module for Puppet +apt +=== -## Description -Provides helpful definitions for dealing with Apt. +[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt) -## Usage +Overview +-------- -### apt:builddep -Install the build depends of a specified package. -
-apt::builddep { "glusterfs-server": } -+The apt module provides a simple interface for managing APT source, key, and definitions with Puppet. + +Module Description +------------------ + +The apt module 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 by opening 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 +* authentication keys + +### Beginning with apt + +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. + +Usage +----- + +Using the apt module consists predominantly of declaring classes that provide the desired functionality and features. + +### apt + +`apt` provides a number of common resources and options that are shared by the various defined types in this module, so you **must always** include this class in your manifests. + +The parameters for `apt` are not generally required and are predominantly for development environment use cases. + + class { 'apt': + always_apt_update => false, + apt_update_frequency => undef, + disable_keys => undef, + proxy_host => false, + proxy_port => '8080', + purge_sources_list => false, + purge_sources_list_d => false, + purge_preferences_d => false, + 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`, `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 + +Installs the build depends of a specified package. + + apt::builddep { 'glusterfs-server': } ### apt::force -Force a package to be installed from a specific release. Useful when using repositories like Debian unstable in Ubuntu. -
-apt::force { "glusterfs-server": - release => "unstable", - version => '3.0.3', - require => Apt::Source["debian_unstable"], -} -+ +Forces a package to be installed from a specific release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu. +The cfg_files parameter controls wether newer or older configuration files should be used or only unchanged configuration files should be updated. Cfg_missing forces the provider to install all missing configuration files. Both are optional. + + apt::force { 'glusterfs-server': + release => 'unstable', + version => '3.0.3', + cfg_files => 'unchanged', + cfg_missing => true, + require => Apt::Source['debian_unstable'], + } + +You can additionally set the following attributes: + + * `cfg_files`: "new", "old", "unchanged" or "none" (default). "new" will overwrite all existing configuration files with newer ones, "old" will force usage of all old files and "unchanged" only updates unchanged config files whereas setting "none" will don't do anything but providing backward-compatability with existing puppet manifests. + * `cfg_missing`: "true" or "false". Setting cfg_missing to false will provide backward compatability whereas setting true will add an aptitude/apt-get parameter which checks and installs missing configuration files for the selected package. + +### apt_key + +A native Puppet type and provider for managing GPG keys for APT is provided by this module. + + apt_key { 'puppetlabs': + ensure => 'present', + id => '1054B7A24BD6EC30', + } + +You can additionally set the following attributes: + + * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the + target host; + * `content`: Instead of pointing to a file, pass the key in as a string; + * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*; + * `keyserver_options`: Additional options to pass to `--keyserver`. + +Because apt_key is a native type, it can be used in and queried for with MCollective. + +### apt::key + +Adds a key to the list of keys used by APT to authenticate packages. This type uses the aforementioned `apt_key` native type. As such, it no longer requires +the `wget` command on which the old implementation depended. + + apt::key { 'puppetlabs': + key => '1054B7A24BD6EC30', + key_server => 'pgp.mit.edu', + } + + apt::key { 'jenkins': + key => '9B7D32F2D50582E6', + key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key', + } ### apt::pin -Add an apt pin for a certain release. -
-apt::pin { "karmic": priority => 700 } -apt::pin { "karmic-updates": priority => 700 } -apt::pin { "karmic-security": priority => 700 } -+ +Adds an apt pin for a certain release. + + apt::pin { 'karmic': priority => 700 } + apt::pin { 'karmic-updates': priority => 700 } + apt::pin { 'karmic-security': priority => 700 } + +Note you can also specifying more complex pins using distribution properties. + + apt::pin { 'stable': + priority => -10, + originator => 'Debian', + release_version => '3.0', + component => 'main', + label => 'Debian' + } + +If you wish to pin a number of packages you may specify the packages as a space +delimited string using the `packages` attribute or pass in an array of package +names. + +### apt::hold + +When you wish to hold a package in Puppet, it should be done by passing in +'held' as the ensure attribute to the package resource. However, a lot of +public modules do not take this into account and generally do not work well +with an ensure of 'held'. + +Moreover, when Puppet is told to hold a package, it holds it at the current version installed; there is no way to tell it to both install a specific version **and** hold that version, unless you use an exec resource that wraps `dpkg --set-selections` or `apt-mark`. + +At first glance, it seems this issue could also be solved by passing the version required to the ensure attribute---but that only means that Puppet will install that +version after it processes the package. It does not inform apt that we want +this package to be held; that is, should another package want to upgrade this one (because of a version requirement in a dependency, for example), we want apt to refuse. + +To solve this issue, use apt::hold. Implement this by creating a preferences file with a priority of 1001. Under normal circumstances, this preference will always win. Because the priority is > 1000, apt will maintain the required version, downgrading the current package if necessary. + +With this, you can now set a package's ensure attribute to 'latest' but get the version specified by apt::hold: + + apt::hold { 'vim': + version => '2:7.3.547-7', + } + +Alternatively, if you want to hold Vim at version 7.3.*, you can pass in a version with a glob: + + apt::hold { 'vim': + version => '2:7.3.*', + } ### apt::ppa -Add a ppa repository using `add-apt-repository`. Somewhat experimental. -
-apt::ppa { "ppa:drizzle-developers/ppa": } -+ +Adds a ppa repository using `add-apt-repository`. + + apt::ppa { 'ppa:drizzle-developers/ppa': } ### apt::release -Set the default apt release. Useful when using repositories like Debian unstable in Ubuntu. -
-apt::release { "karmic": } -+ +Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu. + + class { 'apt::release': + release_id => 'precise', + } ### apt::source -Add an apt source to `/etc/apt/sources.list.d/`. -
-apt::source { "debian_unstable": - location => "http://debian.mirror.iweb.ca/debian/", - release => "unstable", - repos => "main contrib non-free", - required_packages => "debian-keyring debian-archive-keyring", - key => "55BE302B", - key_server => "subkeys.pgp.net", - pin => "-10", - include_src => true -} --This source will configure your system for the Puppet Labs APT repository. -
-apt::source { 'puppetlabs': - location => 'http://apt.puppetlabs.com', - repos => 'main', - key => '4BD6EC30', - key_server => 'pgp.mit.edu', -} -+Adds an apt source to `/etc/apt/sources.list.d/`. -### apt::key -Add a key to the list of keys used by apt to authenticate packages. -
-apt::key { "puppetlabs": - key => "4BD6EC30", - key_server => "pgp.mit.edu", -} -+ 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', + required_packages => 'debian-keyring debian-archive-keyring', + key => '8B48AD6246925553', + key_server => 'subkeys.pgp.net', + pin => '-10', + include_src => true, + include_deb => true + } + +If you would like to configure your system so the source is the Puppet Labs APT repository: + + apt::source { 'puppetlabs': + location => 'http://apt.puppetlabs.com', + repos => 'main', + key => '1054B7A24BD6EC30', + key_server => 'pgp.mit.edu', + } + +### apt::update + +Runs `apt-get update`, updating the list of available packages and their versions without installing or upgrading any packages. +The update runs on the first Puppet run after you include the class, then whenever `notify => Exec['apt_update']` occurs---this should happen when config files get updated or other relevant changes occur. If you set the `always_apt_update` parameter, the update will run on every Puppet run. + +### Facts + +There are a few facts included in 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. In Facter 2.0 and later, this will be a list type; in earlier versions, it is a comma-delimited string. +* `apt_update_last_success` --- The date in epochtime that `apt-get update` last ran successfully. This is determined by reading the mtime of the file `/var/lib/apt/periodic/update-success-stamp`. That file is generated by the `/etc/apt/apt.conf.d/15update-stamp` file. + +#### Hiera example
-apt::key { "jenkins": - key => "D50582E6", - key_source => "http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key", -} +apt::sources: + 'debian_unstable': + location: 'http://debian.mirror.iweb.ca/debian/' + release: 'unstable' + repos: 'main contrib non-free' + required_packages: 'debian-keyring debian-archive-keyring' + key: '9AA38DCD55BE302B' + key_server: 'subkeys.pgp.net' + pin: '-10' + include_src: 'true' + include_deb: 'true' + + 'puppetlabs': + location: 'http://apt.puppetlabs.com' + repos: 'main' + key: '1054B7A24BD6EC30' + key_server: 'pgp.mit.edu'-Note that use of the "key_source" parameter requires wget to be installed and working. - - -## Contributors -A lot of great people have contributed to this module. A somewhat current list follows. -Ben Godfrey