(GH-cat-9) syntax:hiera:yaml fixes

[puppet-modules/puppetlabs-apt.git] / manifests / backports.pp

diff --git a/manifests/backports.pp b/manifests/backports.pp
index f4c5faaf8997e1ce3db5be5b518314f72f6b9f84..1a9ea1bcaefb4c629209cc25543b9e63308d6757 100644 (file)
--- a/manifests/backports.pp
+++ b/manifests/backports.pp
@@ -1,59 +1,116 @@
+# @summary Manages backports.
+#
+# @example Set up a backport source for Linux Mint qiana
+#   class { 'apt::backports':
+#     location => 'http://us.archive.ubuntu.com/ubuntu',
+#     release  => 'trusty-backports',
+#     repos    => 'main universe multiverse restricted',
+#     key      => {
+#       id     => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+#       server => 'keyserver.ubuntu.com',
+#     },
+#   }
+#
+# @param location
+#   Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Default value for Debian and
+#   Ubuntu varies:
+#
+#   - Debian: 'http://deb.debian.org/debian'
+#
+#   - Ubuntu: 'http://archive.ubuntu.com/ubuntu'
+#
+# @param release
+#   Specifies a distribution of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
+#   Default: on Debian and Ubuntu, `${fact('os.distro.codename')}-backports`. We recommend keeping this default, except on other operating
+#   systems.
+#
+# @param repos
+#   Specifies a component of the Apt repository containing the backports to manage. Used in populating the `source.list` configuration file.
+#   Default value for Debian and Ubuntu varies:
+#
+#   - Debian: 'main contrib non-free'
+#
+#   - Ubuntu: 'main universe multiverse restricted'
+#
+# @param key
+#   Specifies a key to authenticate the backports. Valid options: a string to be passed to the id parameter of the apt::key defined type, or a
+#   hash of parameter => value pairs to be passed to apt::key's id, server, content, source, and/or options parameters. Default value
+#   for Debian and Ubuntu varies:
+#
+#   - Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
+#
+#   - Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
+#
+# @param pin
+#   Specifies a pin priority for the backports. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` defined
+#   type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
+#
+# @param include
+#   Specifies whether to include 'deb' or 'src', or both.
+#
 class apt::backports (
-  $location = undef,
-  $release  = undef,
-  $repos    = undef,
-  $key      = undef,
-  $pin      = 200,
-) inherits apt::params {
+  Optional[String] $location                    = undef,
+  Optional[String] $release                     = undef,
+  Optional[String] $repos                       = undef,
+  Optional[Variant[String, Hash]] $key          = undef,
+  Variant[Integer, String, Hash] $pin           = 200,
+  Variant[Hash] $include                        = {},
+) {
+  include apt
+
   if $location {
-    validate_string($location)
     $_location = $location
   }
   if $release {
-    validate_string($release)
     $_release = $release
   }
   if $repos {
-    validate_string($repos)
     $_repos = $repos
   }
   if $key {
-    unless is_hash($key) {
-      validate_string($key)
-    }
     $_key = $key
   }
-  unless is_hash($pin) {
-    unless (is_numeric($pin) or is_string($pin)) {
-      fail('pin must be either a string, number or hash')
+  if (!($facts['os']['name'] == 'Debian' or $facts['os']['name'] == 'Ubuntu')) {
+    unless $location and $release and $repos and $key {
+      fail('If not on Debian or Ubuntu, you must explicitly pass location, release, repos, and key')
     }
   }
-
-  if ($::apt::params::xfacts['lsbdistid'] == 'debian' or $::apt::params::xfacts['lsbdistid'] == 'ubuntu') {
-    unless $location {
-      $_location = $::apt::params::backports['location']
-    }
-    unless $release {
-      $_release = "${::apt::params::xfacts['lsbdistcodename']}-backports"
-    }
-    unless $repos {
-      $_repos = $::apt::params::backports['repos']
+  unless $location {
+    $_location = $::apt::backports['location']
+  }
+  unless $release {
+    if fact('os.distro.codename') {
+      $_release = "${fact('os.distro.codename')}-backports"
+    } else {
+      fail('os.distro.codename fact not available: release parameter required')
     }
-    unless $key {
-      $_key =  $::apt::params::backports['key']
+  }
+  unless $repos {
+    $_repos = $::apt::backports['repos']
+  }
+  unless $key {
+    $_key =  $::apt::backports['key']
+  }
+
+  if $pin =~ Hash {
+    $_pin = $pin
+  } elsif $pin =~ Numeric or $pin =~ String {
+    # apt::source defaults to pinning to origin, but we should pin to release
+    # for backports
+    $_pin = {
+      'priority' => $pin,
+      'release'  => $_release,
     }
   } else {
-    unless $location and $release and $repos and $key {
-      fail('If not on Debian or Ubuntu, you must explicitly pass location, release, repos, and key')
-    }
+    fail('pin must be either a string, number or hash')
   }
 
   apt::source { 'backports':
     location => $_location,
     release  => $_release,
     repos    => $_repos,
+    include  => $include,
     key      => $_key,
-    pin      => $pin,
+    pin      => $_pin,
   }
-
 }