opuppet/module-puppetlabs-apt
5
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
module-puppetlabs-apt/README.md

464 lines
24 KiB
Markdown
Raw Normal View History

DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
# apt
First commit
2010-04-27 22:38:28 +02:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
#### Table of Contents
1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
Correct some README punctuation
2015-04-28 02:08:42 +02:00
3. [Setup - The basics of getting started with apt](#setup)
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* [What apt affects](#what-apt-affects)
* [Beginning with apt](#beginning-with-apt)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
* [Classes](#classes)
* [Defines](#defines)
* [Types](#types)
* [Facts](#facts)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
## Overview
First commit
2010-04-27 22:38:28 +02:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
The apt module lets you use Puppet to manage Apt sources, keys, and other configuration options.
First commit
2010-04-27 22:38:28 +02:00
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
## Module Description
Updated content to conform to README best practices template *Note: I thought this was small enough to forgo a TOC. Please let me know if one is desired and I can add it in.* Before alterations, this content was the module author- determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards.
2013-02-16 02:51:44 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
Apt (Advanced Package Tool) 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.
Add security warning re: short keys
2014-04-07 19:56:20 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
**Note**: 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. We highly recommend you either make this part of your provisioning layer, if you run many Debian or derivative systems, or ensure that you have Facter 2.2.0 or later installed, which will pull this dependency in for you.
Give clearer instructions around lsb-release
2015-04-23 22:54:17 +02:00
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
## Setup
Updated content to conform to README best practices template *Note: I thought this was small enough to forgo a TOC. Please let me know if one is desired and I can add it in.* Before alterations, this content was the module author- determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards.
2013-02-16 02:51:44 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
### What apt affects
Updated content to conform to README best practices template *Note: I thought this was small enough to forgo a TOC. Please let me know if one is desired and I can add it in.* Before alterations, this content was the module author- determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards.
2013-02-16 02:51:44 +01:00
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
* Your system's `sources.list` file and `sources.list.d` directory
* System repositories
* Authentication keys
Updated content to conform to README best practices template *Note: I thought this was small enough to forgo a TOC. Please let me know if one is desired and I can add it in.* Before alterations, this content was the module author- determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards.
2013-02-16 02:51:44 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
**Note:** Setting the apt module's `purge_sources_list` and `purge_sources_list_d` parameters to 'true' will destroy any existing content that you haven't declared through Puppet. The default for these parameters is 'false'.
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
### Beginning with apt
Update the README about apt_key and apt::key.
2014-03-05 15:02:06 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
To use the apt module with default parameters, declare the `apt` class.
Update the README about apt_key and apt::key.
2014-03-05 15:02:06 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
~~~puppet
include apt
~~~
**Note:** The main `apt` class is required by all other classes, types, and defines in this module. You must declare it whenever you use the module.
Update the README about apt_key and apt::key.
2014-03-05 15:02:06 +01:00
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
## Usage
Update the README about apt_key and apt::key.
2014-03-05 15:02:06 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
### Add GPG keys
**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.
Declare the `apt::key` class:
~~~puppet
apt::key { 'puppetlabs':
id => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
server => 'pgp.mit.edu',
options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
}
~~~
### Prioritize backports
~~~puppet
class { 'apt::backports':
pin => 500,
}
~~~
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.
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.
### Update the list of packages
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':
~~~puppet
class { 'apt':
update => {
frequency => 'daily',
},
}
~~~
### Pin a specific release
~~~puppet
apt::pin { 'karmic': priority => 700 }
apt::pin { 'karmic-updates': priority => 700 }
apt::pin { 'karmic-security': priority => 700 }
~~~
You can also specify more complex pins using distribution properties:
~~~puppet
apt::pin { 'stable':
priority => -10,
originator => 'Debian',
release_version => '3.0',
component => 'main',
label => 'Debian'
}
~~~
To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
### Add a PPA (Personal Package Archive) repository
~~~puppet
apt::ppa { 'ppa:drizzle-developers/ppa': }
~~~
### Add an Apt source to `/etc/apt/sources.list.d/`
~~~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 Labs Apt repository as a source:
~~~puppet
apt::source { 'puppetlabs':
location => 'http://apt.puppetlabs.com',
repos => 'main',
key => {
'id' => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
'server' => 'pgp.mit.edu',
},
},
~~~
### Configure Apt from Hiera
~~~yaml
apt::sources:
'debian_unstable':
location: 'http://debian.mirror.iweb.ca/debian/'
release: 'unstable'
repos: 'main contrib non-free'
key:
id: '9AA38DCD55BE302B'
server: 'subkeys.pgp.net'
pin: '-10'
include:
src: true
deb: true
Update the README about apt_key and apt::key.
2014-03-05 15:02:06 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
'puppetlabs':
location: 'http://apt.puppetlabs.com'
repos: 'main'
key:
id: '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30'
server: 'pgp.mit.edu'
~~~
Update the README about apt_key and apt::key.
2014-03-05 15:02:06 +01:00
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
## Reference
Updated content to conform to README best practices template *Note: I thought this was small enough to forgo a TOC. Please let me know if one is desired and I can add it in.* Before alterations, this content was the module author- determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards.
2013-02-16 02:51:44 +01:00
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
### Classes
Updated content to conform to README best practices template *Note: I thought this was small enough to forgo a TOC. Please let me know if one is desired and I can add it in.* Before alterations, this content was the module author- determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards.
2013-02-16 02:51:44 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
#### Public Classes
Add testing, docs, and examples for backports
2015-04-07 21:12:06 +02:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* [`apt`](#class-apt)
* [`apt::backports`](#class-aptbackports)
Add testing, docs, and examples for backports
2015-04-07 21:12:06 +02:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
#### Private Classes
Add testing, docs, and examples for backports
2015-04-07 21:12:06 +02:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `apt::params`: Provides defaults for the apt module parameters.
* `apt::update`: Updates the list of available packages using `apt-get update`.
Updated content to conform to README best practices template *Note: I thought this was small enough to forgo a TOC. Please let me know if one is desired and I can add it in.* Before alterations, this content was the module author- determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards.
2013-02-16 02:51:44 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
### Defines
* [`apt::conf`](#define-aptconf)
* [`apt::key`](#define-aptkey)
* [`apt::pin`](#define-aptpin)
* [`apt::ppa`](#define-aptppa)
* [`apt::setting`](#define-aptsetting)
* [`apt::source`](#define-aptsource)
apt::hold: Add a mechanism to hold a package. I am aware this can be done with `dpkg --set-selections`, `apt-mark` or `ensure => 'held'` on a package resource. The changes to the README include the full rationale for wanting another mechanism.
2014-03-05 10:13:42 +01:00
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
### Types
apt::hold: Add a mechanism to hold a package. I am aware this can be done with `dpkg --set-selections`, `apt-mark` or `ensure => 'held'` on a package resource. The changes to the README include the full rationale for wanting another mechanism.
2014-03-05 10:13:42 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* [`apt_key`](#type-apt_key)
MODULES-1259: added info on apt::update + edits to readme.md Added apt::update information to the Readme file. Also general copy editing throughout for clarity and consistent style.
2014-09-17 01:51:24 +02:00
add facts showing available updates Making use of the apt-check command from the 'update-notifier-common' package (if available) display the number of available updates, number of security updates as well as the update package names.
2014-06-26 15:50:11 +02:00
### Facts
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `apt_updates`: The number of installed packages with available updates.
add facts showing available updates Making use of the apt-check command from the 'update-notifier-common' package (if available) display the number of available updates, number of security updates as well as the update package names.
2014-06-26 15:50:11 +02:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `apt_security_updates`: The number of installed packages with available security updates.
Add ability to specify hash of apt sources in hiera This patch uses create_resources() to call apt::source which lets you specify your sources in hiera.
2013-12-04 19:05:26 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `apt_package_updates`: The names of all installed packages with available updates. In Facter 2.0 and later this data is formatted as an array; in earlier versions it is a comma-delimited string.
README: the facts depend on update-notifier
2014-10-14 13:42:59 +02:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `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).
DOC-249 Revised and updated apt readme Revised and updated apt readme. Post-merge-conflict edition.
2014-10-08 20:09:54 +02:00
Added new apt_reboot_required fact, updated readme, and added unit tests
2015-04-29 19:36:51 +02:00
* `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
#### Class: `apt`
Add ability to specify hash of apt sources in hiera This patch uses create_resources() to call apt::source which lets you specify your sources in hiera.
2013-12-04 19:05:26 +01:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
Main class, includes all other classes.
##### Parameters (all optional)
* `keys`: Creates new `apt::key` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
* `ppas`: Creates new `apt::ppa` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
* `proxy`: Configures Apt to connect to a proxy server. Valid options: a hash made up from the following keys:
* 'host': Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname. Default: undef.
* 'port': Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a port number. Default: '8080'.
* 'https': Specifies whether to enable https proxies. Valid options: 'true' and 'false'. Default: 'false'.
* `purge`: Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
* 'sources.list': Specifies whether to purge any unmanaged entries from `sources.list`. Valid options: 'true' and 'false'. Default: 'false'.
* 'sources.list.d': Specifies whether to purge any unmanaged entries from `sources.list.d`. Valid options: 'true' and 'false'. Default: 'false'.
* 'preferences.list': Specifies whether to purge any unmanaged entries from `preferences.list`. Valid options: 'true' and 'false'. Default: 'false'.
* 'preferences.list.d': Specifies whether to purge any unmanaged entries from `preferences.list.d`. Valid options: 'true' and 'false'. Default: 'false'.
* `settings`: Creates new `apt::setting` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
* `sources`: Creates new `apt::setting` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
* `update`: Configures various update settings. Valid options: a hash made up from the following keys:
* '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'.
* 'timeout': Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: 300.
* 'tries': Specifies how many times to retry the update after receiving a DNS or HTTP error. Valid options: an integer. Default: 1.
#### Class: `apt::backports`
Manages backports.
##### Parameters (all optional on Debian and Ubuntu; all required on other operating systems, except where specified)
* `key`: Specifies a key to authenticate the backports. Valid options: a string to be passed to the `id` parameter of the `apt::key` define, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or `options` parameters. Defaults:
* Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
* Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
* `location`: Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Defaults:
* Debian (squeeze): 'http://backports.debian.org/debian-backports'
* Debian (other): 'http://ftp.debian.org/debian/'
* Ubuntu: 'http://archive.ubuntu.com/ubuntu'
* `pin`: *Optional.* Specifies a pin priority for the backports. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` define, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. Default: '200'.
Correct some README punctuation
2015-04-28 02:08:42 +02:00
* `release`: Specifies a distribution of the Apt repository containing the backports to manage. Valid options: a string containing the release, used in populating the `source.list` configuration file. Default: on Debian and Ubuntu, '${lsbdistcodename}-backports'. We recommend keeping this default, except on other operating systems.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `repos`: Specifies a component of the Apt repository containing the backports to manage. Valid options: A string containing the repos to include, used in populating the `source.list` configuration file. Defaults:
* Debian: 'main contrib non-free'
* Ubuntu: 'main universe multiverse restricted'
#### Define: `apt::conf`
Specifies a custom Apt configuration file.
##### Parameters
* `content`: *Required, unless `ensure` is set to 'absent'.* Directly supplies content for the configuration file. Valid options: a string. Default: undef.
* `ensure`: Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
* `priority`: *Optional.* Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first. Valid options: a string containing an integer. Default: '50'.
#### Define: `apt::key`
Manages the GPG keys that Apt uses to authenticate packages.
The `apt::key` define makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
##### Parameters (all optional)
* `content`: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Valid options: a string. Default: undef.
Correct some README punctuation
2015-04-28 02:08:42 +02:00
* `ensure`: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: 'present'.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `id`: Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters). Default: $title.
* `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
* `source`: Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef.
* `server`: Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or hkp://). Default: 'keyserver.ubuntu.com'.
Make apt::key compatible with 1.8.x
2015-06-04 18:41:27 +02:00
* `key`: Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters). Default: undef. **Note** This parameter is deprecated and will be removed in a future release.
* `key_content`: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Valid options: a string. Default: undef. **Note** This parameter is deprecated and will be removed in a future release.
* `key_source`: Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef. **Note** This parameter is deprecated and will be removed in a future release.
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `key_server`: Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or hkp://). Default: 'keyserver.ubuntu.com'. **Note** This parameter is deprecated and will be removed in a future release.
Make apt::key compatible with 1.8.x
2015-06-04 18:41:27 +02:00
* `key_options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef. **Note** This parameter is deprecated and will be removed in a future release.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
#### Define: `apt::pin`
Manages Apt pins.
**Note:** For context on these parameters, we recommend reading the man page ['apt_preferences(5)'](http://linux.die.net/man/5/apt_preferences)
##### Parameters (all optional)
* `codename`: Specifies the distribution (lsbdistcodename) of the Apt repository. Valid options: a string. Default: ''.
* `component`: Names the licensing component associated with the packages in the directory tree of the Release file. Valid options: a string. Default: ''.
Correct some README punctuation
2015-04-28 02:08:42 +02:00
* `ensure`: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: 'present'.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `explanation`: Supplies a comment to explain the pin. Valid options: a string. Default: "${caller_module_name}: ${name}".
* `label`: Names the label of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
* `order`: Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first. Valid options: an integer. Default: 50.
* `origin`: Tells Apt to prefer packages from the specified server. Valid options: a string containing a hostname. Default: ''.
* `originator`: Names the originator of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
* `packages`: Specifies which package(s) to pin. Valid options: a string or an array. Default: '*'.
* `priority`: Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest priority number (subject to dependency constraints). Valid options: an integer. Default: 0.
* `release`: Tells Apt to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable' Valid options: a string. Default: ''.
* `release_version`: Tells Apt to prefer packages that support the specified operating system release version (e.g., Debian release version 7). Valid options: a string. Default: ''.
* `version`: Tells Apt to prefer a specified package version or version range. Valid options: a string. Default: ''.
#### Define: `apt::ppa`
Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
##### Parameters (all optional, except where specified)
* `ensure`: Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. Default: 'present'.
* `options`: Supplies options to be passed to the `add-apt-repository` command. Valid options: a string. Defaults:
* Lucid: undef
* All others: '-y'
* `package_manage`: Specifies whether Puppet should manage the package that provides `apt-add-repository`. Valid options: 'true' and 'false'. Default: 'false'.
* `package_name`: Names the package that provides the `apt-add-repository` command. Valid options: a string. Defaults:
* Lucid and Precise: 'python-software-properties'
* Trusty, Utopic, and Vivid: 'software-properties-common'
* All others: undef
* `release`: *Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint).* Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename. Default: "$lsbdistcodename".
#### Define: `apt:setting`
Manages Apt configuration files.
##### Parameters
* `content`: *Required, unless `source` is set.* Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid options: see the `content` attribute of [Puppet's native `file` type](https://docs.puppetlabs.com/references/latest/type.html#file-attribute-content). Default: undef.
* `ensure`: Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. Default: 'file'.
* `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
* `priority`: *Optional.* Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first. Valid options: an integer or zero-padded integer. Default: 50.
* `source`: *Required, unless `content` is set.* Specifies a source file to supply the content of the configuration file. Cannot be used in combination with `content`. Valid options: see the `source` attribute of [Puppet's native `file` type](https://docs.puppetlabs.com/references/latest/type.html#file-attribute-source). Default: undef.
#### Define: `apt::source`
Manages the Apt sources in `/etc/apt/sources.list.d/`.
##### Parameters (all optional, except where specified)
* `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. Valid options: 'true' and 'false'. Default: 'false'.
* `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).
* `comment`: Supplies a comment for adding to the Apt source file. Valid options: a string. Default: $name.
Correct some README punctuation
2015-04-28 02:08:42 +02:00
* `ensure`: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `key`: Creates a declaration of the apt::key define Valid options: a string to be passed to the `id` parameter of the `apt::key` define, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or `options` parameters. Default: undef.
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `include`: Configures include options. Valid options: a hash of available keys. Default: {}. Available keys are:
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* 'deb' - Specifies whether to request the distribution's compiled binaries. Valid options: 'true' and 'false'. Default: 'true'.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* 'src' - Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: 'false'.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
* `location`: *Required, unless `ensure` is set to 'absent'.* Specifies an Apt repository. Valid options: a string containing a repository URL. Default: undef.
* `pin`: Creates a declaration of the apt::pin define Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` define, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. Default: undef.
* `release`: Specifies a distribution of the Apt repository. Valid options: a string. Default: "$lsbdistcodename".
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `repos`: Specifies a component of the Apt repository. Valid options: a string. Default: 'main'.
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `include_deb`: Specify whether to request the distrubution's compiled binaries. Valid options: 'true' and 'false'. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module.
Compatibility between 1.8.x and 2.x for apt::source
2015-06-04 02:19:16 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `include_src`: Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module.
Compatibility between 1.8.x and 2.x for apt::source
2015-06-04 02:19:16 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `required_packages`: Installs packages required for this Apt source via an exec. Default: 'false'. **Note**: This parameter is deprecated and will be removed in future versions of the module.
Compatibility between 1.8.x and 2.x for apt::source
2015-06-04 02:19:16 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `key_content`: Specifies the content to be passed to `apt::key`. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module.
Compatibility between 1.8.x and 2.x for apt::source
2015-06-04 02:19:16 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `key_server`: Specifies the server to be passed to `apt::key`. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module.
Compatibility between 1.8.x and 2.x for apt::source
2015-06-04 02:19:16 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `key_source`: Specifies the source to be passed to `apt::key`. Default: undef. **Note**: This parameter is deprecated and will be removed in future versions of the module.
Compatibility between 1.8.x and 2.x for apt::source
2015-06-04 02:19:16 +02:00
DOCS: Edits to README.md Just mostly commas and wording and other edit-y stuff.
2015-06-15 20:45:59 +02:00
* `trusted_source`: Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked. Valid options: 'true' and 'false'. Default: undef. This parameter is **deprecated** and will be removed in a future version of the module.
Compatibility between 1.8.x and 2.x for apt::source
2015-06-04 02:19:16 +02:00
Update README per DOC-1503 1. Make sure that for each parameter, where applicable, there is a default value. 2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional. 3. Make sure the links in the README work and are accurate. 4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html 5. General copyediting. * Add a ToC * Reorganize Usage & Reference sections * Standardize capitalization of "Apt" (as opposed to "apt", the module) * Standardize Development section Apply edits from @jbondpdx * Re-emphasize the warning about short key names * Restore the “What apt affects” section * Re-correct capitalization of “Apt” (where it had reverted to “APT”) * Clarify OS compatibility in Limitations and elsewhere * Various edits for clarity
2015-04-14 03:35:10 +02:00
#### Type: `apt_key`
Manages the GPG keys that Apt uses to authenticate packages.
**Note:** In most cases, we recommend using the `apt::key` define. It makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
##### Parameters (all optional)
* `content`: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Cannot be used in combination with `source`. Valid options: a string. Default: undef.
* `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
* `server`: Specifies a keyserver to provide Puppet's GPG key. Valid options: a string containing a domain name or a full URL. Default: 'keyserver.ubuntu.com'.
* `source`: Specifies the location of an existing GPG key file to copy. Cannot be used in combination with `content`. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef.
## Limitations
This module is tested and officially supported on Debian 6 and 7 and Ubuntu 10.04, 12.04, and 14.04. Testing on other platforms has been light and cannot be guaranteed.
## Development
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 hardware, software, and deployment configurations that Puppet is intended to serve. 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.
For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
Make apt::key compatible with 1.8.x
2015-06-04 18:41:27 +02:00
To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)
Reference in a new issue Copy permalink