X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=manifests%2Finit.pp;h=f3472aca0097e6ce45505ca34587caf1327736ce;hb=53ea6e7a789ebec00d463ba78abf09bfe031efd9;hp=6b69eccb5f065d3c187a3a5ade96c3b076ee9458;hpb=d4e1a346103ed0eb5d60e311da79f2ed315b716b;p=puppet-modules%2Fpuppetlabs-apt.git

diff --git a/manifests/init.pp b/manifests/init.pp
index 6b69ecc..f3472ac 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -1,6 +1,112 @@
-# == Class: apt
+# @summary Main class, includes all other classes.
 #
-# Manage APT (Advanced Packaging Tool)
+# @see https://docs.puppetlabs.com/references/latest/function.html#createresources for the create resource function
+#
+# @param provider
+#   Specifies the provider that should be used by apt::update.
+#
+# @param keyserver
+#   Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or 
+#   hkp://).
+#
+# @param ppa_options
+#   Supplies options to be passed to the `add-apt-repository` command. 
+#
+# @param ppa_package
+#   Names the package that provides the `apt-add-repository` command.
+#
+# @param backports
+#   Specifies some of the default parameters used by apt::backports. Valid options: a hash made up from the following keys:
+#
+# @option backports [String] :location 
+#   See apt::backports for documentation.
+#
+# @option backports [String] :repos 
+#   See apt::backports for documentation.
+#
+# @option backports [String] :key 
+#   See apt::backports for documentation.
+#
+# @param confs
+#   Creates new `apt::conf` resources. Valid options: a hash to be passed to the create_resources function linked above.
+#
+# @param update
+#   Configures various update settings. Valid options: a hash made up from the following keys:
+#
+# @option update [String] :frequency
+#   Specifies how often to run `apt-get update`. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value. 
+#   Valid options: 'always' (at every Puppet run); 'daily' (if the value of `apt_update_last_success` is less than current epoch time minus 86400); 
+#   'weekly' (if the value of `apt_update_last_success` is less than current epoch time minus 604800); and 'reluctantly' (only if the exec resource 
+#   `apt_update` is notified). Default: 'reluctantly'.
+#
+# @option update [Integer] :loglevel
+#   Specifies the log level of logs outputted to the console. Default: undef.
+#
+# @option update [Integer] :timeout
+#   Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: undef.
+#
+# @option update [Integer] :tries
+#    Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef.
+#
+# @param purge
+#   Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
+#
+# @option purge [Boolean] :sources.list
+#   Specifies whether to purge any unmanaged entries from sources.list. Default false.
+#
+# @option purge [Boolean] :sources.list.d
+#   Specifies whether to purge any unmanaged entries from sources.list.d. Default false.
+#
+# @option purge [Boolean] :preferences
+#   Specifies whether to purge any unmanaged entries from preferences. Default false.
+#
+# @option purge [Boolean] :preferences.d.
+#   Specifies whether to purge any unmanaged entries from preferences.d. Default false.
+#
+# @param proxy
+#   Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy.
+#
+# @param sources
+#   Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above.
+#
+# @param keys
+#   Creates new `apt::key` resources. Valid options: a hash to be passed to the create_resources function linked above.
+#
+# @param ppas
+#   Creates new `apt::ppa` resources. Valid options: a hash to be passed to the create_resources function linked above.
+#
+# @param pins
+#   Creates new `apt::pin` resources. Valid options: a hash to be passed to the create_resources function linked above.
+#
+# @param settings
+#   Creates new `apt::setting` resources. Valid options: a hash to be passed to the create_resources function linked above.
+#
+# @param auth_conf_entries
+#   An optional array of login configuration settings (hashes) that are recorded in the file /etc/apt/auth.conf. This file has a netrc-like 
+#   format (similar to what curl uses) and contains the login configuration for APT sources and proxies that require authentication. See 
+#   https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details. If specified each hash must contain the keys machine, login and 
+#   password and no others.
+#
+# @param root
+#   Specifies root directory of Apt executable.
+#
+# @param sources_list
+#   Specifies the path of the sources_list file to use. 
+#
+# @param sources_list_d
+#   Specifies the path of the sources_list.d file to use. 
+#
+# @param conf_d
+#   Specifies the path of the conf.d file to use. 
+#
+# @param preferences
+#   Specifies the path of the preferences file to use. 
+#
+# @param preferences_d
+#   Specifies the path of the preferences.d file to use. 
+#
+# @param config_files
+#   A hash made up of the various configuration files used by Apt.
 #
 class apt (
   Hash $update_defaults         = $apt::params::update_defaults,
@@ -15,7 +121,7 @@ class apt (
   Hash $confs                   = $apt::params::confs,
   Hash $update                  = $apt::params::update,
   Hash $purge                   = $apt::params::purge,
-  Hash $proxy                   = $apt::params::proxy,
+  Apt::Proxy $proxy             = $apt::params::proxy,
   Hash $sources                 = $apt::params::sources,
   Hash $keys                    = $apt::params::keys,
   Hash $ppas                    = $apt::params::ppas,
@@ -30,11 +136,11 @@ class apt (
   String $preferences           = $apt::params::preferences,
   String $preferences_d         = $apt::params::preferences_d,
   Hash $config_files            = $apt::params::config_files,
-  Hash $source_key_defaults     = $apt::params::source_key_defaults
+  Hash $source_key_defaults     = $apt::params::source_key_defaults,
 ) inherits apt::params {
 
   if $facts['osfamily'] != 'Debian' {
-    fail('This module only works on Debian or derivatives like Ubuntu')
+    fail(translate('This module only works on Debian or derivatives like Ubuntu'))
   }
 
   if $update['frequency'] {
@@ -67,23 +173,6 @@ class apt (
   }
 
   $_purge = merge($::apt::purge_defaults, $purge)
-
-  if $proxy['ensure'] {
-    assert_type(Enum['file', 'present', 'absent'], $proxy['ensure'])
-  }
-  if $proxy['host'] {
-    assert_type(String, $proxy['host'])
-  }
-  if $proxy['port'] {
-    assert_type(Integer, $proxy['port'])
-  }
-  if $proxy['https']{
-    assert_type(Boolean, $proxy['https'])
-  }
-  if $proxy['direct']{
-    assert_type(Boolean, $proxy['direct'])
-  }
-
   $_proxy = merge($apt::proxy_defaults, $proxy)
 
   $confheadertmp = epp('apt/_conf_header.epp')
@@ -202,17 +291,5 @@ class apt (
   }
 
   # required for adding GPG keys on Debian 9 (and derivatives)
-  case $facts['os']['name'] {
-    'Debian': {
-      if versioncmp($facts['os']['release']['major'], '9') >= 0 {
-        ensure_packages(['dirmngr'])
-      }
-    }
-    'Ubuntu': {
-      if versioncmp($facts['os']['release']['full'], '17.04') >= 0 {
-        ensure_packages(['dirmngr'])
-      }
-    }
-    default: { }
-  }
+  ensure_packages(['dirmngr'])
 }