-# source.pp
-# add an apt source
+# @summary Manages the Apt sources in /etc/apt/sources.list.d/.
+#
+# @example Install the puppetlabs apt source
+# apt::source { 'puppetlabs':
+# location => 'http://apt.puppetlabs.com',
+# repos => 'main',
+# key => {
+# id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
+# server => 'hkps.pool.sks-keyservers.net',
+# },
+# }
+#
+# @param location
+# Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL.
+#
+# @param comment
+# Supplies a comment for adding to the Apt source file.
+#
+# @param ensure
+# Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'.
+#
+# @param release
+# Specifies a distribution of the Apt repository.
+#
+# @param repos
+# Specifies a component of the Apt repository.
+#
+# @param include
+# Configures include options. Valid options: a hash of available keys.
+#
+# @option include [Boolean] :deb
+# Specifies whether to request the distribution's compiled binaries. Default true.
+#
+# @option include [Boolean] :src
+# Specifies whether to request the distribution's uncompiled source code. Default false.
+#
+# @param key
+# Creates a declaration of the apt::key defined type. 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.
+#
+# @param pin
+# Creates a declaration of the apt::pin defined type. 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 architecture
+# Tells Apt to only download information for specified architectures. Valid options: a string containing one or more architecture names,
+# separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures
+# defined in the Apt::Architectures option).
+#
+# @param allow_unsigned
+# Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked.
+#
+# @param notify_update
+# Specifies whether to trigger an `apt-get update` run.
+#
define apt::source(
- $location = undef,
- $comment = $name,
- $ensure = present,
- $release = undef,
- $repos = 'main',
- $include = {},
- $key = undef,
- $pin = undef,
- $architecture = undef,
- $allow_unsigned = false,
- $include_src = undef,
- $include_deb = undef,
- $required_packages = undef,
- $key_server = undef,
- $key_content = undef,
- $key_source = undef,
- $trusted_source = undef,
- $notify_update = true,
+ Optional[String] $location = undef,
+ String $comment = $name,
+ String $ensure = present,
+ Optional[String] $release = undef,
+ String $repos = 'main',
+ Optional[Variant[Hash]] $include = {},
+ Optional[Variant[String, Hash]] $key = undef,
+ Optional[Variant[Hash, Numeric, String]] $pin = undef,
+ Optional[String] $architecture = undef,
+ Boolean $allow_unsigned = false,
+ Boolean $notify_update = true,
) {
- validate_string($architecture, $comment, $location, $repos)
- validate_bool($allow_unsigned)
- validate_hash($include)
- # This is needed for compat with 1.8.x
include ::apt
$_before = Apt::Setting["list-${title}"]
- if $include_src != undef {
- warning("\$include_src is deprecated and will be removed in the next major release, please use \$include => { 'src' => ${include_src} } instead")
- }
-
- if $include_deb != undef {
- warning("\$include_deb is deprecated and will be removed in the next major release, please use \$include => { 'deb' => ${include_deb} } instead")
- }
-
- if $required_packages != undef {
- warning('$required_packages is deprecated and will be removed in the next major release, please use package resources instead.')
- exec { "Required packages: '${required_packages}' for ${name}":
- command => "${::apt::params::provider} -y install ${required_packages}",
- logoutput => 'on_failure',
- refreshonly => true,
- tries => 3,
- try_sleep => 1,
- before => $_before,
- }
- }
-
- if $key_server != undef {
- warning("\$key_server is deprecated and will be removed in the next major release, please use \$key => { 'server' => ${key_server} } instead.")
- }
-
- if $key_content != undef {
- warning("\$key_content is deprecated and will be removed in the next major release, please use \$key => { 'content' => ${key_content} } instead.")
- }
-
- if $key_source != undef {
- warning("\$key_source is deprecated and will be removed in the next major release, please use \$key => { 'source' => ${key_source} } instead.")
- }
-
- if $trusted_source != undef {
- warning('$trusted_source is deprecated and will be removed in the next major release, please use $allow_unsigned instead.')
- $_allow_unsigned = $trusted_source
- } else {
- $_allow_unsigned = $allow_unsigned
- }
-
- if ! $release {
- $_release = $::apt::params::xfacts['lsbdistcodename']
- unless $_release {
- fail('lsbdistcodename fact not available: release parameter required')
+ if !$release {
+ if $facts['lsbdistcodename'] {
+ $_release = $facts['lsbdistcodename']
+ } else {
+ fail(translate('lsbdistcodename fact not available: release parameter required'))
}
} else {
$_release = $release
}
- if $ensure == 'present' and ! $location {
- fail('cannot create a source entry without specifying a location')
- }
-
- if $include_src != undef and $include_deb != undef {
- $_deprecated_include = {
- 'src' => $include_src,
- 'deb' => $include_deb,
+ if $ensure == 'present' {
+ if ! $location {
+ fail(translate('cannot create a source entry without specifying a location'))
+ }
+ # Newer oses, do not need the package for HTTPS transport.
+ $_transport_https_releases = [ 'wheezy', 'jessie', 'stretch', 'trusty', 'xenial' ]
+ if ($facts['lsbdistcodename'] in $_transport_https_releases) and $location =~ /(?i:^https:\/\/)/ {
+ ensure_packages('apt-transport-https')
}
- } elsif $include_src != undef {
- $_deprecated_include = { 'src' => $include_src }
- } elsif $include_deb != undef {
- $_deprecated_include = { 'deb' => $include_deb }
- } else {
- $_deprecated_include = {}
}
- $_include = merge($::apt::params::include_defaults, $_deprecated_include, $include)
-
- $_deprecated_key = {
- 'key_server' => $key_server,
- 'key_content' => $key_content,
- 'key_source' => $key_source,
- }
+ $includes = merge($::apt::include_defaults, $include)
if $key {
- if is_hash($key) {
+ if $key =~ Hash {
unless $key['id'] {
- fail('key hash must contain at least an id entry')
+ fail(translate('key hash must contain at least an id entry'))
}
- $_key = merge($::apt::params::source_key_defaults, $_deprecated_key, $key)
+ $_key = merge($::apt::source_key_defaults, $key)
} else {
- validate_string($key)
- $_key = merge( { 'id' => $key }, $_deprecated_key)
+ $_key = { 'id' => assert_type(String[1], $key) }
}
}
+ $header = epp('apt/_header.epp')
+
+ $sourcelist = epp('apt/source.list.epp', {
+ 'comment' => $comment,
+ 'includes' => $includes,
+ 'opt_architecture' => $architecture,
+ 'allow_unsigned' => $allow_unsigned,
+ 'location' => $location,
+ 'release' => $_release,
+ 'repos' => $repos,
+ })
+
apt::setting { "list-${name}":
ensure => $ensure,
- content => template('apt/_header.erb', 'apt/source.list.erb'),
+ content => "${header}${sourcelist}",
notify_update => $notify_update,
}
if $pin {
- if is_hash($pin) {
+ if $pin =~ Hash {
$_pin = merge($pin, { 'ensure' => $ensure, 'before' => $_before })
- } elsif (is_numeric($pin) or is_string($pin)) {
- $url_split = split($location, '/')
- $host = $url_split[2]
+ } elsif ($pin =~ Numeric or $pin =~ String) {
+ $url_split = split($location, '[:\/]+')
+ $host = $url_split[1]
$_pin = {
'ensure' => $ensure,
'priority' => $pin,
'origin' => $host,
}
} else {
- fail('Received invalid value for pin parameter')
+ fail(translate('Received invalid value for pin parameter'))
}
create_resources('apt::pin', { "${name}" => $_pin })
}
# We do not want to remove keys when the source is absent.
if $key and ($ensure == 'present') {
- if is_hash($_key) {
+ if $_key =~ Hash {
+ if $_key['ensure'] != undef {
+ $_ensure = $_key['ensure']
+ } else {
+ $_ensure = $ensure
+ }
+
apt::key { "Add key: ${$_key['id']} from Apt::Source ${title}":
- ensure => present,
- id => $_key['id'],
- server => $_key['server'],
- content => $_key['content'],
- source => $_key['source'],
- options => $_key['options'],
- key_server => $_key['key_server'],
- key_content => $_key['key_content'],
- key_source => $_key['key_source'],
- before => $_before,
+ ensure => $_ensure,
+ id => $_key['id'],
+ server => $_key['server'],
+ content => $_key['content'],
+ source => $_key['source'],
+ options => $_key['options'],
+ before => $_before,
}
}
}
Code Review / puppet-modules / puppetlabs-apt.git / blobdiff