Puppet Class: apt::backports

Defined in:
manifests/backports.pp

Summary

Manages backports.

Overview

Examples:

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',
  },
}

Parameters:

  • location (Optional[String]) (defaults to: undef) —

    Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Default value for Debian and Ubuntu varies:

  • release (Optional[String]) (defaults to: undef) —

    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, `$'os'-backports`. We recommend keeping this default, except on other operating systems.

  • repos (Optional[String]) (defaults to: undef) —

    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’

  • key (Optional[Variant[String, Hash]]) (defaults to: undef) —

    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’

  • pin (Optional[Variant[Integer, String, Hash]]) (defaults to: 200) —

    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.

  • include (Optional[Variant[Hash]]) (defaults to: {}) —

    Specifies whether to include ‘deb’ or ‘src’, or both.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'manifests/backports.pp', line 51

class apt::backports (
  Optional[String] $location                    = undef,
  Optional[String] $release                     = undef,
  Optional[String] $repos                       = undef,
  Optional[Variant[String, Hash]] $key          = undef,
  Optional[Variant[Integer, String, Hash]] $pin = 200,
  Optional[Variant[Hash]] $include              = {},
) {
  include apt

  if $location {
    $_location = $location
  }
  if $release {
    $_release = $release
  }
  if $repos {
    $_repos = $repos
  }
  if $key {
    $_key = $key
  }
  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')
    }
  }
  unless $location {
    $_location = $::apt::backports['location']
  }
  unless $release {
    $_release = "${facts['os']['distro']['codename']}-backports"
  }
  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 {
    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,
  }
}