(maint) - add back gems removed by pdk update

[puppet-modules/puppetlabs-apt.git] / REFERENCE.md

diff --git a/REFERENCE.md b/REFERENCE.md
index 06aff2140df92acfae30e2d77dcd2e171f50d552..a876fc5bbf736fde89cdf0a4eaa336030cea7fb2 100644 (file)
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -19,6 +19,7 @@ _Private Classes_
 
 * [`apt::conf`](#aptconf): Specifies a custom Apt configuration file.
 * [`apt::key`](#aptkey): Manages the GPG keys that Apt uses to authenticate packages.
+* [`apt::mark`](#aptmark): defined typeapt::mark
 * [`apt::pin`](#aptpin): Manages Apt pins. Does not trigger an apt-get update run.
 * [`apt::ppa`](#aptppa): Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
 * [`apt::setting`](#aptsetting): Manages Apt configuration files.
@@ -35,6 +36,11 @@ _Private Resource types_
 by apt to perform package validation. Apt has it's own GPG keyring that can
 be manipulated through the `apt-key` command.
 
+**Data types**
+
+* [`Apt::Auth_conf_entry`](#aptauth_conf_entry): Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
+* [`Apt::Proxy`](#aptproxy): Configures Apt to connect to a proxy server.
+
 **Tasks**
 
 * [`init`](#init): Allows you to perform apt functions
@@ -70,6 +76,14 @@ hkp://).
 
 Default value: $apt::params::keyserver
 
+##### `key_options`
+
+Data type: `Optional[String]`
+
+Specifies the default options for apt::key resources.
+
+Default value: $apt::params::key_options
+
 ##### `ppa_options`
 
 Data type: `Optional[String]`
@@ -305,6 +319,14 @@ Data type: `Hash`
 
 Default value: $apt::params::include_defaults
 
+##### `apt_conf_d`
+
+Data type: `String`
+
+
+
+Default value: $apt::params::apt_conf_d
+
 ##### `source_key_defaults`
 
 Data type: `Hash`
@@ -498,7 +520,7 @@ Default value: `undef`
 
 ##### `server`
 
-Data type: `Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/]`
+Data type: `Pattern[/\A((hkp|hkps|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?(\/[a-zA-Z\d\-_.]+)*\/?$/]`
 
 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
 hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
@@ -519,7 +541,23 @@ Data type: `Optional[String]`
 
 Passes additional options to `apt-key adv --keyserver-options`.
 
-Default value: `undef`
+Default value: $::apt::key_options
+
+### apt::mark
+
+defined typeapt::mark
+
+#### Parameters
+
+The following parameters are available in the `apt::mark` defined type.
+
+##### `setting`
+
+Data type: `Enum['auto','manual','hold','unhold']`
+
+auto, manual, hold, unhold
+specifies the behavior of apt in case of no more dependencies installed
+https://manpages.debian.org/sretch/apt/apt-mark.8.en.html
 
 ### apt::pin
 
@@ -679,6 +717,15 @@ Specifies the operating system of your node. Valid options: a string containing
 
 Default value: $facts['lsbdistcodename']
 
+##### `dist`
+
+Data type: `Optional[String]`
+
+Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint).
+Specifies the distribution of your node. Valid options: a string containing a valid distribution codename.
+
+Default value: $facts['lsbdistid']
+
 ##### `package_name`
 
 Data type: `Optional[String]`
@@ -872,6 +919,74 @@ Default value: `true`
 
 ## Resource types
 
+## Data types
+
+### Apt::Auth_conf_entry
+
+Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
+
+* **See also**
+https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html
+for more information
+
+Alias of `Struct[{
+    machine => String[1],
+    login => String,
+    password => String
+  }]`
+
+#### Parameters
+
+The following parameters are available in the `Apt::Auth_conf_entry` data type.
+
+##### `machine`
+
+Hostname of machine to connect to.
+
+##### `login`
+
+Specifies the username to connect with.
+
+##### `password`
+
+Specifies the password to connect with.
+
+### Apt::Proxy
+
+Configures Apt to connect to a proxy server.
+
+Alias of `Struct[{
+    ensure => Optional[Enum['file', 'present', 'absent']],
+    host   => Optional[String],
+    port   => Optional[Integer[0, 65535]],
+    https  => Optional[Boolean],
+    direct => Optional[Boolean],
+  }]`
+
+#### Parameters
+
+The following parameters are available in the `Apt::Proxy` data type.
+
+##### `ensure`
+
+Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Prefer 'file' over 'present'.
+
+##### `host`
+
+Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
+
+##### `port`
+
+Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
+
+##### `https`
+
+Specifies whether to enable https proxies.
+
+##### `direct`
+
+Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but https is not.
+
 ## Tasks
 
 ### init