X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=README.md;h=63e6a85870df705b4337de696cecb973c36c049c;hb=7c48eb2f0e4bbd21933e57f4e06b73123ff3281c;hp=9feb900cfe37cb3173532a721717ae4ba28a6646;hpb=bf9b18740532f96da95e3531fecfaafd017eb88c;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/README.md b/README.md index 9feb900..63e6a85 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # apt -[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt) - ## Overview The apt module provides a simple interface for managing Apt source, key, and definitions with Puppet. @@ -10,7 +8,7 @@ The apt module provides a simple interface for managing Apt source, key, and def The apt module automates obtaining and installing software packages on \*nix systems. -**Note**: While this module allows the use of short keys, **we urge you NOT to use short keys**, as they pose a serious security issue by opening you up to collision attacks. +**Note**: While this module allows the use of short keys, **warnings are thrown if a full fingerprint is not used**, as they pose a serious security issue by opening you up to collision attacks. ## Setup @@ -76,12 +74,11 @@ class { 'apt': ``` class { 'apt::unattended_upgrades': - origins => $::apt::params::origins, - blacklist => [], - update => '1', - download => '1', - upgrade => '1', - autoclean => '7', + blacklist => [], + update => '1', + download => '1', + upgrade => '1', + autoclean => '7', } ``` @@ -246,8 +243,8 @@ apt::sources: key: '9AA38DCD55BE302B' key_server: 'subkeys.pgp.net' pin: '-10' - include_src: 'true' - include_deb: 'true' + include_src: true + include_deb: true 'puppetlabs': location: 'http://apt.puppetlabs.com' @@ -279,6 +276,7 @@ apt::sources: ####apt::unattended_upgrades +* `legacy_origin`: If set to true, use the old `Unattended-Upgrade::Allowed-Origins` variable. If false, use `Unattended-Upgrade::Origins-Pattern`. OS-dependent defaults are defined in `apt::params`. * `origins`: The repositories from which to automatically upgrade included packages. * `blacklist`: A list of packages to **not** automatically upgrade. * `update`: How often, in days, to run `apt-get update`. @@ -334,6 +332,14 @@ apt::sources: It is recommended to read the manpage 'apt_preferences(5)' +####apt::ppa + +* `ensure`: Whether we are adding or removing the PPA. Can be 'present' or 'absent'. Defaults to 'present'. +* `release`: The codename for the operating system you're running. Defaults to `$lsbdistcodename`. Required if lsb-release is not installed. +* `options`: Options to be passed to the `apt-add-repository` command. OS-dependent defaults are set in `apt::params`. +* `package_name`: The package that provides the `apt-add-repository` command. OS-dependent defaults are set in `apt::params`. +* `package_manage`: Whether or not to manage the package providing `apt-add-repository`. Defaults to true. + ### Testing The apt module is mostly a collection of defined resource types, which provide reusable logic for managing Apt. It provides smoke tests for testing functionality on a target system, as well as spec tests for checking a compiled catalog against an expected set of resources.