Update CODEOWNERS
[puppet-modules/puppetlabs-apt.git] / README.md
index b0574a7aa0a138adbb9b536c79a0ef13f828fd37..c37101f07b4f358907097e4e102ba12d18774606 100644 (file)
--- a/README.md
+++ b/README.md
-apt
-===
+# apt
 
-[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt)
+#### Table of Contents
 
-Overview
---------
+1. [Module Description - What the module does and why it is useful](#module-description)
+1. [Setup - The basics of getting started with apt](#setup)
+    * [What apt affects](#what-apt-affects)
+    * [Beginning with apt](#beginning-with-apt)
+1. [Usage - Configuration options and additional functionality](#usage)
+    * [Add GPG keys](#add-gpg-keys)
+    * [Prioritize backports](#prioritize-backports)
+    * [Update the list of packages](#update-the-list-of-packages)
+    * [Pin a specific release](#pin-a-specific-release) 
+    * [Add a Personal Package Archive repository](#add-a-personal-package-archive-repository)
+    * [Configure Apt from Hiera](#configure-apt-from-hiera)
+    * [Replace the default sources.list file](#replace-the-default-sourceslist-file)
+1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
+1. [Limitations - OS compatibility, etc.](#limitations)
+1. [Development - Guide for contributing to the module](#development)
 
-The apt module provides a simple interface for managing APT source, key, and definitions with Puppet.
+<a id="module-description"></a>
 
-Module Description
-------------------
+## Module Description
 
-The apt module automates obtaining and installing software packages on \*nix systems.
+The apt module lets you use Puppet to manage APT (Advanced Package Tool) sources, keys, and other configuration options.
 
-***Note:** While this module allows the use of short keys, we **strongly** recommend that you **do not use short keys**, as they pose a serious security issue by opening you up to collision attacks.
+APT is a package manager available on Debian, Ubuntu, and several other operating systems. The apt module provides a series of classes, defines, types, and facts to help you automate APT package management.
 
-Setup
------
+**Note**: Prior to Puppet 7, for this module to correctly autodetect which version of
+Debian/Ubuntu (or derivative) you're running, you need to make sure the `lsb-release` package is
+installed. With Puppet 7 the `lsb-release` package is not needed.
 
-**What apt affects:**
+<a id="setup"></a>
 
-* package/service/configuration files for APT
-    * NOTE: Setting the `purge_preferences` or `purge_preferences_d` parameters to 'true' will destroy any existing configuration that was not declared with Puppet. The default for these parameters is 'false'.
-* your system's `sources.list` file and `sources.list.d` directory
-    * NOTE: Setting the `purge_sources_list` and `purge_sources_list_d` parameters to 'true' will destroy any existing content that was not declared with Puppet. The default for these parameters is 'false'.
-* system repositories
-* authentication keys
+## Setup
 
-### Beginning with apt
-
-To begin using the apt module with default parameters, declare the class.
-
-    include apt
-
-Puppet code that uses anything from the apt module requires that the core apt class be declared.
-
-Usage
------
-
-Using the apt module consists predominantly of declaring classes that provide the desired functionality and features.
-
-### apt
-
-`apt` provides a number of common resources and options that are shared by the various defined types in this module, so you **must always** include this class in your manifests.
-
-The parameters for `apt` are not generally required and are predominantly for development environment use cases.
-
-    class { 'apt':
-      always_apt_update    => false,
-      apt_update_frequency => undef,
-      disable_keys         => undef,
-      proxy_host           => false,
-      proxy_port           => '8080',
-      purge_sources_list   => false,
-      purge_sources_list_d => false,
-      purge_preferences_d  => false,
-      update_timeout       => undef,
-      fancy_progress       => undef
-    }
-
-Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
-
-If you declare your apt class with `purge_sources_list`, `purge_sources_list_d`, `purge_preferences` and `purge_preferences_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet.
-
-### apt::builddep
-
-Installs the build depends of a specified package.
+<a id="what-apt-affects"></a>
 
-    apt::builddep { 'glusterfs-server': }
+### What apt affects
 
-### apt::force
+* Your system's `preferences` file and `preferences.d` directory
+* Your system's `sources.list` file and `sources.list.d` directory
+* Your system's `apt.conf.d` directory
+* System repositories
+* Authentication keys
 
-Forces a package to be installed from a specific release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
-The cfg_files parameter controls wether newer or older configuration files should be used or only unchanged configuration files should be updated. Cfg_missing forces the provider to install all missing configuration files. Both are optional.
+**Note:** This module offers `purge` parameters which, if set to `true`, **destroy** any configuration on the node's `sources.list(.d)`, `preferences(.d)` and `apt.conf.d` that you haven't declared through Puppet. The default for these parameters is `false`.
 
-    apt::force { 'glusterfs-server':
-      release     => 'unstable',
-      version     => '3.0.3',
-      cfg_files   => 'unchanged',
-      cfg_missing => true,
-      require     => Apt::Source['debian_unstable'],
-    }
+<a id="beginning-with-apt"></a>
 
-You can additionally set the following attributes:
-
- * `cfg_files`: "new", "old", "unchanged" or "none" (default). "new" will overwrite all existing configuration files with newer ones, "old" will force usage of all old files and "unchanged" only updates unchanged config files whereas setting "none" will don't do anything but providing backward-compatability with existing puppet manifests.
- * `cfg_missing`: "true" or "false". Setting cfg_missing to false will provide backward compatability whereas setting true will add an aptitude/apt-get parameter which checks and installs missing configuration files for the selected package.
-
-### apt_key
-
-A native Puppet type and provider for managing GPG keys for APT is provided by this module.
-
-    apt_key { 'puppetlabs':
-      ensure => 'present',
-      id     => '1054B7A24BD6EC30',
-    }
-
-You can additionally set the following attributes:
-
- * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the
-             target host;
- * `content`: Instead of pointing to a file, pass the key in as a string;
- * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*;
- * `keyserver_options`: Additional options to pass to `--keyserver`.
-
-Because apt_key is a native type, it can be used in and queried for with MCollective.
+### Beginning with apt
 
-### apt::key
+To use the apt module with default parameters, declare the `apt` class.
 
-Adds a key to the list of keys used by APT to authenticate packages. This type uses the aforementioned `apt_key` native type. As such, it no longer requires
-the `wget` command on which the old implementation depended.
+```puppet
+include apt
+```
 
-    apt::key { 'puppetlabs':
-      key        => '1054B7A24BD6EC30',
-      key_server => 'pgp.mit.edu',
-    }
+**Note:** The main `apt` class is required by all other classes, types, and defined types in this module. You must declare it whenever you use the module.
 
-    apt::key { 'jenkins':
-      key        => '9B7D32F2D50582E6',
-      key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
-    }
+<a id="usage"></a>
 
-### apt::pin
+## Usage
 
-Adds an apt pin for a certain release.
+<a id="add-gpg-keys"></a>
 
-    apt::pin { 'karmic': priority => 700 }
-    apt::pin { 'karmic-updates': priority => 700 }
-    apt::pin { 'karmic-security': priority => 700 }
+### Add GPG keys
 
-Note you can also specifying more complex pins using distribution properties.
+**Warning:** Using short key IDs presents a serious security issue, potentially leaving you open to collision attacks. We recommend you always use full fingerprints to identify your GPG keys. This module allows short keys, but issues a security warning if you use them.
 
-    apt::pin { 'stable':
-      priority        => -10,
-      originator      => 'Debian',
-      release_version => '3.0',
-      component       => 'main',
-      label           => 'Debian'
-    }
+Declare the `apt::key` defined type:
 
-If you wish to pin a number of packages you may specify the packages as a space
-delimited string using the `packages` attribute or pass in an array of package
-names.
+```puppet
+apt::key { 'puppetlabs':
+  id      => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
+  server  => 'pgp.mit.edu',
+  options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
+}
+```
 
-### apt::hold
+<a id="prioritize-backports"></a>
 
-When you wish to hold a package in Puppet, it should be done by passing in
-'held' as the ensure attribute to the package resource. However, a lot of
-public modules do not take this into account and generally do not work well
-with an ensure of 'held'.
+### Prioritize backports
 
-Moreover, when Puppet is told to hold a package, it holds it at the current version installed; there is no way to tell it to both install a specific version **and** hold that version, unless you use an exec resource that wraps `dpkg --set-selections` or `apt-mark`.
+```puppet
+class { 'apt::backports':
+  pin => 500,
+}
+```
 
-At first glance, it seems this issue could also be solved by passing the version required to the ensure attribute---but that only means that Puppet will install that
-version after it processes the package. It does not inform apt that we want
-this package to be held; that is, should another package want to upgrade this one (because of a version requirement in a dependency, for example), we want apt to refuse.
+By default, the `apt::backports` class drops a pin file for backports, pinning it to a priority of 200. This is lower than the normal default of 500, so packages with `ensure => latest` don't get upgraded from backports without your explicit permission.
 
-To solve this issue, use apt::hold. Implement this by creating a preferences file with a priority of 1001. Under normal circumstances, this preference will always win. Because the priority is > 1000, apt will maintain the required version, downgrading the current package if necessary.
+If you raise the priority through the `pin` parameter to 500, normal policy goes into effect and Apt installs or upgrades to the newest version. This means that if a package is available from backports, it and its dependencies are pulled in from backports unless you explicitly set the `ensure` attribute of the `package` resource to `installed`/`present` or a specific version.
 
-With this, you can now set a package's ensure attribute to 'latest' but get the version specified by apt::hold:
+<a id="update-the-list-of-packages"></a>
 
-    apt::hold { 'vim':
-      version => '2:7.3.547-7',
-    }
+### Update the list of packages
 
-Alternatively, if you want to hold Vim at version 7.3.*, you can pass in a version with a glob:
+By default, Puppet runs `apt-get update` on the first Puppet run after you include the `apt` class, and anytime `notify => Exec['apt_update']` occurs; i.e., whenever config files get updated or other relevant changes occur. If you set `update['frequency']` to 'always', the update runs on every Puppet run. You can also set `update['frequency']` to 'daily' or 'weekly':
 
-    apt::hold { 'vim':
-      version => '2:7.3.*',
-    }
+```puppet
+class { 'apt':
+  update => {
+    frequency => 'daily',
+  },
+}
+```
 
-### apt::ppa
+When `Exec['apt_update']` is triggered, it generates a `notice`-level message. Because the default [logging level for agents](https://puppet.com/docs/puppet/latest/configuration.html#loglevel) is `notice`, this causes the repository update to appear in agent logs. To silence these updates from the default log output, set the [loglevel](https://puppet.com/docs/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level:
 
-Adds a ppa repository using `add-apt-repository`.
+```puppet
+class { 'apt':
+  update => {
+    frequency => 'daily',
+    loglevel  => 'debug',
+  },
+}
+```
 
-    apt::ppa { 'ppa:drizzle-developers/ppa': }
+> **NOTE:** Every `Exec['apt_update']` run will generate a corrective change, even if the apt caches are not updated. For example, setting an update frequency of `always` can result in every Puppet run resulting in a corrective change. This is a known issue. For details, see [MODULES-10763](https://tickets.puppetlabs.com/browse/MODULES-10763).
 
-### apt::release
+<a id="pin-a-specific-release"></a>
 
-Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
+### Pin a specific release
 
-    class { 'apt::release':
-      release_id => 'precise',
-    }
+```puppet
+apt::pin { 'karmic': priority => 700 }
+apt::pin { 'karmic-updates': priority => 700 }
+apt::pin { 'karmic-security': priority => 700 }
+```
 
-### apt::source
+You can also specify more complex pins using distribution properties:
 
-Adds an apt source to `/etc/apt/sources.list.d/`.
+```puppet
+apt::pin { 'stable':
+  priority        => -10,
+  originator      => 'Debian',
+  release_version => '3.0',
+  component       => 'main',
+  label           => 'Debian'
+}
+```
 
-    apt::source { 'debian_unstable':
-      comment           => 'This is the iWeb Debian unstable mirror',
-      location          => 'http://debian.mirror.iweb.ca/debian/',
-      release           => 'unstable',
-      repos             => 'main contrib non-free',
-      required_packages => 'debian-keyring debian-archive-keyring',
-      key               => '8B48AD6246925553',
-      key_server        => 'subkeys.pgp.net',
-      pin               => '-10',
-      include_src       => true,
-      include_deb       => true
-    }
+To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
 
-If you would like to configure your system so the source is the Puppet Labs APT repository:
+<a id="add-a-personal-package-archive-repository"></a>
 
-    apt::source { 'puppetlabs':
-      location   => 'http://apt.puppetlabs.com',
-      repos      => 'main',
-      key        => '1054B7A24BD6EC30',
-      key_server => 'pgp.mit.edu',
-    }
+### Add a Personal Package Archive (PPA) repository
 
-### apt::update
+```puppet
+apt::ppa { 'ppa:drizzle-developers/ppa': }
+```
 
-Runs `apt-get update`, updating the list of available packages and their versions without installing or upgrading any packages.
+### Add an Apt source to `/etc/apt/sources.list.d/`
 
-The update runs on the first Puppet run after you include the class, then whenever `notify  => Exec['apt_update']` occurs---this should happen when config files get updated or other relevant changes occur. If you set the `always_apt_update` parameter, the update will run on every Puppet run.
+```puppet
+apt::source { 'debian_unstable':
+  comment  => 'This is the iWeb Debian unstable mirror',
+  location => 'http://debian.mirror.iweb.ca/debian/',
+  release  => 'unstable',
+  repos    => 'main contrib non-free',
+  pin      => '-10',
+  key      => {
+    'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
+    'server' => 'subkeys.pgp.net',
+  },
+  include  => {
+    'src' => true,
+    'deb' => true,
+  },
+}
+```
+
+To use the Puppet Apt repository as a source:
 
-### Facts
+```puppet
+apt::source { 'puppetlabs':
+  location => 'http://apt.puppetlabs.com',
+  repos    => 'main',
+  key      => {
+    'id'     => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
+    'server' => 'pgp.mit.edu',
+  },
+}
+```
+
+<a id="configure-apt-from-hiera"></a>
 
-There are a few facts included in the apt module describing the state of the apt system:
+### Configure Apt from Hiera
 
-* `apt_updates` --- the number of updates available on the system
-* `apt_security_updates` --- the number of updates which are security updates
-* `apt_package_updates` --- the package names that are available for update. In Facter 2.0 and later, this will be a list type; in earlier versions, it is a comma-delimited string.
-* `apt_update_last_success` --- The date in epochtime that `apt-get update` last ran successfully. This is determined by reading the mtime of the file `/var/lib/apt/periodic/update-success-stamp`. That file is generated by the `/etc/apt/apt.conf.d/15update-stamp` file.
+Instead of specifying your sources directly as resources, you can instead just include the `apt` class, which will pick up the values automatically from hiera.
 
-#### Hiera example
-<pre>
+```yaml
 apt::sources:
   'debian_unstable':
-      location: 'http://debian.mirror.iweb.ca/debian/'
-      release: 'unstable'
-      repos: 'main contrib non-free'
-      required_packages: 'debian-keyring debian-archive-keyring'
-      key: '9AA38DCD55BE302B'
-      key_server: 'subkeys.pgp.net'
-      pin: '-10'
-      include_src: 'true'
-      include_deb: 'true'
+    comment: 'This is the iWeb Debian unstable mirror'
+    location: 'http://debian.mirror.iweb.ca/debian/'
+    release: 'unstable'
+    repos: 'main contrib non-free'
+    pin: '-10'
+    key:
+      id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
+      server: 'subkeys.pgp.net'
+    include:
+      src: true
+      deb: true
 
   'puppetlabs':
-      location: 'http://apt.puppetlabs.com'
-      repos: 'main'
-      key: '1054B7A24BD6EC30'
-      key_server: 'pgp.mit.edu'
-</pre>
-
-### Testing
-
-The apt module is mostly a collection of defined resource types, which provide reusable logic that can be leveraged to manage APT. It provides smoke tests for testing functionality on a target system, as well as spec tests for checking a compiled catalog against an expected set of resources.
+    location: 'http://apt.puppetlabs.com'
+    repos: 'main'
+    key:
+      id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
+      server: 'pgp.mit.edu'
+```
+
+<a id="replace-the-default-sourceslist-file"></a>
+
+### Replace the default `sources.list` file
+
+The following example replaces the default `/etc/apt/sources.list`. Along with this code, be sure to use the `purge` parameter, or you might get duplicate source warnings when running Apt.
+
+```puppet
+apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}":
+  location => 'http://archive.ubuntu.com/ubuntu',
+  key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+  repos    => 'main universe multiverse restricted',
+}
+
+apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-security":
+  location => 'http://archive.ubuntu.com/ubuntu',
+  key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+  repos    => 'main universe multiverse restricted',
+  release  => "${facts['os']['distro']['codename']}-security"
+}
+
+apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-updates":
+  location => 'http://archive.ubuntu.com/ubuntu',
+  key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+  repos    => 'main universe multiverse restricted',
+  release  => "${facts['os']['distro']['codename']}-updates"
+}
+
+apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-backports":
+ location => 'http://archive.ubuntu.com/ubuntu',
+ key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+ repos    => 'main universe multiverse restricted',
+ release  => "${facts['os']['distro']['codename']}-backports"
+}
+```
+
+### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
+
+Starting with APT version 1.5, you can define login configuration settings, such as
+username and password, for APT sources or proxies that require authentication
+in the `/etc/apt/auth.conf` file. This is preferable to embedding login
+information directly in `source.list` entries, which are usually world-readable.
+
+The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
+curl) and has restrictive file permissions. See [here](https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html) for details.
+
+Use the optional `apt::auth_conf_entries` parameter to specify an array of hashes containing login configuration settings. These hashes may only contain the `machine`, `login` and `password` keys.
+
+```puppet
+class { 'apt':
+  auth_conf_entries => [
+    {
+      'machine'  => 'apt-proxy.example.net',
+      'login'    => 'proxylogin',
+      'password' => 'proxypassword',
+    },
+    {
+      'machine'  => 'apt.example.com/ubuntu',
+      'login'    => 'reader',
+      'password' => 'supersecret',
+    },
+  ],
+}
+```
+
+<a id="reference"></a>
+
+## Reference
 
-#### Example Test
-
-This test will set up a Puppet Labs APT repository. Start by creating a new smoke test, called puppetlabs-apt.pp, in the apt module's test folder. In this test, declare a single resource representing the Puppet Labs APT source and GPG key:
-
-    apt::source { 'puppetlabs':
-      location   => 'http://apt.puppetlabs.com',
-      repos      => 'main',
-      key        => '1054B7A24BD6EC30',
-      key_server => 'pgp.mit.edu',
-    }
+### Facts
 
-This resource creates an APT source named puppetlabs and gives Puppet information about the repository's location and the key used to sign its packages. Puppet leverages Facter to determine the appropriate release, but you can set this directly by adding the release type.
+* `apt_updates`: The number of installed packages with available updates from `upgrade`.
 
-Check your smoke test for syntax errors:
+* `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
 
-    $ puppet parser validate tests/puppetlabs-apt.pp
+* `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
 
-If you receive no output from that command, it means nothing is wrong. Then, apply the code:
+* `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
 
-    $ puppet apply --verbose tests/puppetlabs-apt.pp
-    notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
-    info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
-    notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
+* `apt_package_updates`: The names of all installed packages with available updates from `upgrade`. In Facter 2.0 and later this data is formatted as an array; in earlier versions it is a comma-delimited string.
 
-The above example uses a smoke test to lay out a resource declaration and apply it on your system. In production, you might want to declare your APT sources inside the classes where they’re needed.
+* `apt_package_dist_updates`: The names of all installed packages with available updates from `dist-upgrade`. In Facter 2.0 and later this data is formatted as an array; in earlier versions it is a comma-delimited string.
 
-Implementation
---------------
+* `apt_update_last_success`: The date, in epochtime, of the most recent successful `apt-get update` run (based on the mtime of  /var/lib/apt/periodic/update-success-stamp).
 
-### apt::backports
+* `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
 
-Adds the necessary components to get backports for Ubuntu and Debian. The release name defaults to `$lsbdistcodename`. Setting this manually can cause undefined behavior (read: universe exploding).
+### More Information
 
-By default this class drops a Pin-file for Backports, pinning it to a priority of 200. This is lower than the normal Debian archive, which gets a priority of 500 to ensure that packages with `ensure => latest` don't get magically upgraded from Backports without your explicit permission.
+See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apt/blob/main/REFERENCE.md) for all other reference documentation.
 
-If you raise the priority through the `pin_priority` parameter to *500*, identical to the rest of the Debian mirrors, normal policy goes into effect and the newest version wins/becomes the candidate apt will want to install or upgrade to. This means that if a package is available from Backports it and its dependencies will be pulled in from Backports unless you explicitly set the `ensure` attribute of the `package` resource to `installed`/`present` or a specific version.
+<a id="limitations"></a>
 
-Limitations
------------
+## Limitations
 
-This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
+This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
 
-Development
-------------
+For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/main/metadata.json)
 
-Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
+### Adding new sources or PPAs
 
-We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+If you are adding a new source or PPA and trying to install packages from the new source or PPA on the same Puppet run, your `package` resource should depend on `Class['apt::update']`, as well as depending on the `Apt::Source` or the `Apt::Ppa`. You can also add [collectors](https://docs.puppetlabs.com/puppet/latest/reference/lang_collectors.html) to ensure that all packages happen after `apt::update`, but this can lead to dependency cycles and has implications for [virtual resources](https://docs.puppetlabs.com/puppet/latest/reference/lang_collectors.html#behavior). Before running the command below, ensure that all packages have the provider set to apt.
 
-You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
+```puppet
+Class['apt::update'] -> Package <| provider == 'apt' |>
+```
 
-License
--------
+## Development
 
-The original code for this module comes from Evolving Web and was licensed under the MIT license. Code added since the fork of this module is licensed under the Apache 2.0 License like the rest of the Puppet Labs products.
+Acceptance tests for this module leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus).
+To run the acceptance tests follow the instructions [here](https://puppetlabs.github.io/litmus/Running-acceptance-tests.html).
+You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE).
 
-The LICENSE contains both licenses.
+If you run into an issue with this module, or if you would like to request a feature, please [file a ticket](https://tickets.puppetlabs.com/browse/MODULES/).
+Every Monday the Puppet IA Content Team has [office hours](https://puppet.com/community/office-hours) in the [Puppet Community Slack](http://slack.puppet.com/), alternating between an EMEA friendly time (1300 UTC) and an Americas friendly time (0900 Pacific, 1700 UTC).
 
-Contributors
-------------
+If you have problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support).
 
-A lot of great people have contributed to this module. A somewhat current list follows:
+If you submit a change to this module, be sure to regenerate the reference documentation as follows:
 
-* Ben Godfrey <ben.godfrey@wonga.com>
-* Branan Purvine-Riley <branan@puppetlabs.com>
-* Christian G. Warden <cwarden@xerus.org>
-* Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
-* Daniel Tremblay <github@danieltremblay.ca>
-* Garrett Honeycutt <github@garretthoneycutt.com>
-* Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
-* Ken Barber <ken@bob.sh>
-* Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
-* Matthias Pigulla <mp@webfactory.de>
-* Monty Taylor <mordred@inaugust.com>
-* Peter Drake <pdrake@allplayers.com>
-* Reid Vandewiele <marut@cat.pdx.edu>
-* Robert Navarro <rnavarro@phiivo.com>
-* Ryan Coleman <ryan@puppetlabs.com>
-* Scott McLeod <scott.mcleod@theice.com>
-* Spencer Krum <spencer@puppetlabs.com>
-* William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
-* Zach Leslie <zach@puppetlabs.com>
-* Daniele Sluijters <github@daenney.net>
-* Daniel Paulus <daniel@inuits.eu>
-* Wolf Noble <wolf@wolfspyre.com>
+```bash
+puppet strings generate --format markdown --out REFERENCE.md
+```