apt (96) Versions 2.5.3 Follow409

Configures apt and apt caching.

Policyfile

Berkshelf

Knife

cookbook 'apt', '= 2.5.3', :supermarket

cookbook 'apt', '= 2.5.3'

knife supermarket install apt

knife supermarket download apt

README

Dependencies

Changelog

Quality -%

apt Cookbook

This cookbook includes recipes to execute apt-get update to ensure the local APT package cache is up to date. There are recipes for managing the apt-cacher-ng caching proxy and proxy clients. It also includes a LWRP for managing APT repositories in /etc/apt/sources.list.d as well as an LWRP for pinning packages via /etc/apt/preferences.d.

Requirements

Version 2.0.0+ of this cookbook requires Chef 11.0.0 or later. If your Chef version is earlier than 11.0.0, use version 1.10.0 of this cookbook.

Version 1.8.2 to 1.10.0 of this cookbook requires Chef 10.16.4 or later.

If your Chef version is earlier than 10.16.4, use version 1.7.0 of this cookbook.

Platform

Please refer to the [TESTING file](TESTING.md) to see the currently (and passing) tested platforms. The release was tested on:

Ubuntu 10.04
Ubuntu 12.04
Ubuntu 13.04
Debian 7.1
Debian 6.0 (have with manual testing)

May work with or without modification on other Debian derivatives.

default

This recipe installs the update-notifier-common package to provide the timestamp file used to only run apt-get update if the cache is more than one day old.

This recipe should appear first in the run list of Debian or Ubuntu nodes to ensure that the package cache is up to date before managing any package resources with Chef.

This recipe also sets up a local cache directory for preseeding packages.

Including the default recipe on a node that does not support apt (such as Windows) results in a noop.

cacher-client

Configures the node to use the apt-cacher-ng server as a client.

Bypassing the cache

Occasionally you may come across repositories that do not play nicely when the node is using an apt-cacher-ng server. You can configure cacher-client to bypass the server and connect directly to the repository with the cache_bypass attribute.

To do this, you need to override the cache_bypass attribute with an array of repositories, with each array key as the repository URL and value as the protocol to use:

{
    ...,
    'apt': {
        ...,
        'cache_bypass': {
            URL: PROTOCOL
        }
    }
}

For example, to prevent caching and directly connect to the repository at download.oracle.com via http:

{
    'apt': {
        'cache_bypass': {
            'download.oracle.com': 'http'
        }
    }
}

cacher-ng

Installs the apt-cacher-ng package and service so the system can provide APT caching. You can check the usage report at http://{hostname}:3142/acng-report.html.

If you wish to help the cacher-ng recipe seed itself, you must now explicitly include the cacher-client recipe in your run list after cacher-ng or you will block your ability to install any packages (ie. apt-cacher-ng).

Attributes

['apt']['cacher_ipaddress'] - use a cacher server (or standard proxy server) not available via search
['apt']['cacher_interface] - interface to connect to the cacher-ng service, no default.
['apt']['cacher_port'] - port for the cacher-ng service (either client or server), default is '3142'
['apt']['cacher_dir'] - directory used by cacher-ng service, default is '/var/cache/apt-cacher-ng'
['apt']['cacher-client']['restrict_environment'] - restrict your node to using the apt-cacher-ng server in your Environment, default is 'false'
['apt']['compiletime'] - force the cacher-client recipe to run before other recipes. It forces apt to use the proxy before other recipes run. Useful if your nodes have limited access to public apt repositories. This is overridden if the cacher-ng recipe is in your run list. Default is 'false'
['apt']['compile_time_update'] - force the default recipe to run apt-get update at compile time.
['apt']['cache_bypass'] - array of URLs to bypass the cache. Accepts the URL and protocol to fetch directly from the remote repository and not attempt to cache
['apt']['periodic_update_min_delay'] - minimum delay (in seconds) beetween two actual executions of apt-get update by the execute[apt-get-update-periodic] resource, default is '86400' (24 hours)

Libraries

There is an interface_ipaddress method that returns the IP address for a particular host and interface, used by the cacher-client recipe. To enable it on the server use the ['apt']['cacher_interface'] attribute.

Resources/Providers

`apt_repository`

This LWRP provides an easy way to manage additional APT repositories. Adding a new repository will notify running the execute[apt-get-update] resource immediately.

Actions

:add: creates a repository file and builds the repository listing (default)
:remove: removes the repository file

Attribute Parameters

repo_name: name attribute. The name of the channel to discover
uri: the base of the Debian distribution
distribution: this is usually your release's codename...ie something like karmic, lucid or maverick
components: package groupings... when in doubt use main
arch: constrain package to a particular arch like i386, amd64 or even armhf or powerpc. Defaults to nil.
trusted: treat all packages from this repository as authenticated regardless of signature
deb_src: whether or not to add the repository as a source repo as well - value can be true or false, default false.
keyserver: the GPG keyserver where the key for the repo should be retrieved
key: if a keyserver is provided, this is assumed to be the fingerprint, otherwise it can be either the URI to the GPG key for the repo, or a cookbook_file.
key_proxy: if set, pass the specified proxy via http-proxy= to GPG.
cookbook: if key should be a cookbook_file, specify a cookbook where the key is located for files/default. Defaults to nil, so it will use the cookbook where the resource is used.

Examples

Add the Zenoss repo:

apt_repository 'zenoss' do
  uri        'http://dev.zenoss.org/deb'
  components ['main', 'stable']
end

Add the Nginx PPA, grabbing the key from keyserver:

apt_repository 'nginx-php' do
  uri          'http://ppa.launchpad.net/nginx/php5/ubuntu'
  distribution node['lsb']['codename']
  components   ['main']
  keyserver    'keyserver.ubuntu.com'
  key          'C300EE8C'
end

Add the Nginx PPA, grab the key from the keyserver, and add source repo:

apt_repository 'nginx-php' do
  uri          'http://ppa.launchpad.net/nginx/php5/ubuntu'
  distribution node['lsb']['codename']
  components   ['main']
  keyserver    'keyserver.ubuntu.com'
  key          'C300EE8C'
  deb_src      true
end

Add the Cloudera Repo of CDH4 packages for Ubuntu 12.04 on AMD64:

apt_repository 'cloudera' do
  uri          'http://archive.cloudera.com/cdh4/ubuntu/precise/amd64/cdh'
  arch         'amd64'
  distribution 'precise-cdh4'
  components   ['contrib']
  key          'http://archive.cloudera.com/debian/archive.key'
end

Remove Zenoss repo:

apt_repository 'zenoss' do
  action :remove
end

`apt_preference`

This LWRP provides an easy way to pin packages in /etc/apt/preferences.d. Although apt-pinning is quite helpful from time to time please note that Debian does not encourage its use without thorough consideration.

Further information regarding apt-pinning is available via http://wiki.debian.org/AptPreferences.

Actions

:add: creates a preferences file under /etc/apt/preferences.d
:remove: Removes the file, therefore unpin the package

Attribute Parameters

package_name: name attribute. The name of the package
glob: Pin by glob() expression or regexp surrounded by /.
pin: The package version/repository to pin
pin_priority: The pinning priority aka "the highest package version wins"

Examples

Pin libmysqlclient16 to version 5.1.49-3:

apt_preference 'libmysqlclient16' do
  pin          'version 5.1.49-3'
  pin_priority '700'
end

Unpin libmysqlclient16:

apt_preference 'libmysqlclient16' do
  action :remove
end

Pin all packages from dotdeb.org:

apt_preference 'dotdeb' do
  glob         '*'
  pin          'origin packages.dotdeb.org'
  pin_priority '700'
end

Usage

Put recipe[apt] first in the run list. If you have other recipes that you want to use to configure how apt behaves, like new sources, notify the execute resource to run, e.g.:

template '/etc/apt/sources.list.d/my_apt_sources.list' do
  notifies :run, 'execute[apt-get update]', :immediately
end

The above will run during execution phase since it is a normal template resource, and should appear before other package resources that need the sources in the template.

Put recipe[apt::cacher-ng] in the run_list for a server to provide APT caching and add recipe[apt::cacher-client] on the rest of the Debian-based nodes to take advantage of the caching server.

If you want to cleanup unused packages, there is also the apt-get autoclean and apt-get autoremove resources provided for automated cleanup.

License & Authors

Author:: Joshua Timberman (joshua@opscode.com)
Author:: Matt Ray (matt@opscode.com)
Author:: Seth Chisamore (schisamo@opscode.com)

Copyright 2009-2013, Opscode, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

apt Cookbook CHANGELOG

This file is used to list changes made in each version of the apt cookbook.

v2.5.3 (2014-08-14)

#87 - Improve default settings, account for non-linux platforms

v2.5.2 (2014-08-14)

Fully restore fully restore 2.3.10 behaviour

v2.5.1 (2014-08-14)

fix breakage introduced in apt 2.5.0

v2.5.0 (2014-08-12)

Add unattended-upgrades recipe
Only update the cache for the created repository
Added ChefSpec matchers and default_action for resources
Avoid cloning resource attributes
Minor documentation updates

v2.4.0 (2014-05-15)

[COOK-4534]: Add option to update apt cache at compile time

v2.3.10 (2014-04-23)

[COOK-4512] Bugfix: Use empty PATH if PATH is nil

v2.3.8 (2014-02-14)

Bug

COOK-4287 - Cleanup the Kitchen

v2.3.6

[COOK-4154] - Add chefspec matchers.rb file to apt cookbook
[COOK-4102] - Only index created repository

v2.3.6

[COOK-4154] - Add chefspec matchers.rb file to apt cookbook
[COOK-4102] - Only index created repository

v2.3.4

No change. Version bump for toolchain sanity

v2.3.2

[COOK-3905] apt-get-update-periodic: configuration for the update period
Updating style for rubocops
Updating test-kitchen harness

v2.3.0

Bug

COOK-3812 - Add a way to bypass the apt existence check

Improvement

COOK-3567 - Allow users to bypass apt-cache via attributes

v2.2.1

Improvement

COOK-664 - Check platform before running apt-specific commands

v2.2.0

Bug

COOK-3707 - multiple nics confuse apt::cacher-client

v2.1.2

Improvement

COOK-3551 - Allow user to set up a trusted APT repository

v2.1.1

Bug

COOK-1856 - Match GPG keys without case sensitivity

v2.1.0

[COOK-3426]: cacher-ng fails with restrict_environment set to true
[COOK-2859]: cacher-client executes out of order
[COOK-3052]: Long GPG keys are downloaded on every run
[COOK-1856]: apt cookbook should match keys without case sensitivity
[COOK-3255]: Attribute name incorrect in README
[COOK-3225]: Call use_inline_resources only if defined
[COOK-3386]: Cache dir for apt-cacher-ng
[COOK-3291]: apt_repository: enable usage of a keyserver on port 80
Greatly expanded test coverage with ChefSpec and Test-Kitchen

v2.0.0

Bug

[COOK-2258]: apt: LWRP results in error under why-run mode in apt 1.9.0 cookbook

v1.10.0

Improvement

[COOK-2885]: Improvements for apt cache server search

Bug

[COOK-2441]: Apt recipe broken in new chef version
[COOK-2660]: Create Debian 6.0 "squeeze" specific template for apt-cacher-ng

v1.9.2

[COOK-2631] - Create Ubuntu 10.04 specific template for apt-cacher-ng

v1.9.0

[COOK-2185] - Proxy for apt-key
[COOK-2338] - Support pinning by glob() or regexp

v1.8.4

[COOK-2171] - Update README to clarify required Chef version: 10.18.0 or higher.

v1.8.2

[COOK-2112] - need [] around "arch" in sources.list entries
[COOK-2171] - fixes a regression in the notification

v1.8.0

[COOK-2143] - Allow for a custom cacher-ng port
[COOK-2171] - On apt_repository.run_action(:add) the source file is not created.
[COOK-2184] - apt::cacher-ng, use cacher_port attribute in acng.conf

v1.7.0

[COOK-2082] - add "arch" parameter to apt_repository LWRP

v1.6.0

[COOK-1893] - apt_preference use "package_name" resource instead of "name"
[COOK-1894] - change filename for sources.list.d files
[COOK-1914] - Wrong dir permissions for /etc/apt/preferences.d/
[COOK-1942] - README.md has wrong name for the keyserver attribute
[COOK-2019] - create 01proxy before any other apt-get updates get executed

v1.5.2

[COOK-1682] - use template instead of file resource in apt::cacher-client
[COOK-1875] - cacher-client should be Environment-aware

V1.5.0

[COOK-1500] - Avoid triggering apt-get update
[COOK-1548] - Add execute commands for autoclean and autoremove
[COOK-1591] - Setting up the apt proxy should leave https connections direct
[COOK-1596] - execute[apt-get-update-periodic] never runs
[COOK-1762] - create /etc/apt/preferences.d directory
[COOK-1776] - apt key check isn't idempotent

v1.4.8

Adds test-kitchen support
[COOK-1435] - repository lwrp is not idempotent with http key

v1.4.6

[COOK-1530] - apt_repository isn't aware of update-success-stamp file (also reverts COOK-1382 patch).

v1.4.4

[COOK-1229] - Allow cacher IP to be set manually in non-Chef Solo environments
[COOK-1530] - Immediately update apt-cache when sources.list file is dropped off

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

apt Cookbook

Requirements

Platform

default

cacher-client

Bypassing the cache

cacher-ng

Attributes

Libraries

Resources/Providers

apt_repository

Actions

Attribute Parameters

Examples

apt_preference

Actions

Attribute Parameters

Examples

Usage

License & Authors

Dependent cookbooks

Contingent cookbooks

apt Cookbook CHANGELOG

v2.5.3 (2014-08-14)

v2.5.2 (2014-08-14)

v2.5.1 (2014-08-14)

v2.5.0 (2014-08-12)

v2.4.0 (2014-05-15)

v2.3.10 (2014-04-23)

v2.3.8 (2014-02-14)

Bug

v2.3.6

v2.3.6

v2.3.4

v2.3.2

v2.3.0

Bug

Improvement

v2.2.1

Improvement

v2.2.0

Bug

v2.1.2

Improvement

v2.1.1

Bug

v2.1.0

v2.0.0

Bug

v1.10.0

Improvement

Bug

v1.9.2

v1.9.0

v1.8.4

v1.8.2

v1.8.0

v1.7.0

v1.6.0

v1.5.2

V1.5.0

v1.4.8

v1.4.6

v1.4.4

v1.4.2

v1.4.0

No quality metric results found

Details

Updated August 21, 2014 Created on October 25, 2009

Supported Platforms

License

`apt_repository`

`apt_preference`