apt (96) Versions 7.0.0 Follow409

Configures apt and apt caching.

Policyfile

Berkshelf

Knife

cookbook 'apt', '= 7.0.0', :supermarket

cookbook 'apt', '= 7.0.0'

knife supermarket install apt

knife supermarket download apt

README

Dependencies

Changelog

Quality 100%

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 custom resource for pinning packages via /etc/apt/preferences.d.

Requirements

Platforms

Ubuntu 12.04+
Debian 7+

May work with or without modification on other Debian derivatives.

Chef

Chef 13.3+

Cookbooks

None

Recipes

default

This recipe manually updates 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 or RHEL) results in a noop.

cacher-client

Configures the node to use a apt-cacher-ng server to cache apt requests. Configuration of the server to use is located in default['apt']['cacher_client']['cacher_server'] which is a hash containing host, port, proxy_ssl, and bypass keys. Example:

{
    "apt": {
        "cacher_client": {
            "cacher_server": {
                "host": "cache_server.mycorp.dmz",
                "port": 1234,
                "proxy_ssl": true,
                "cache_bypass": {
                    "download.oracle.com": "http"
                }
            }
        }
    }
}

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 hash of repositories, with each key as the repository URL and value as the protocol to use:

{
    "apt": {
        "cacher_client": {
            "cacher_server": {
                "cache_bypass": {
                    "URL": "PROTOCOL"
                }
            }
        }
    }
}

For example, to prevent caching and directly connect to the repository at download.oracle.com via http and the repo at nginx.org via https

{
    "apt": {
        "cacher_client": {
            "cacher_server": {
                "cache_bypass": {
                    "download.oracle.com": "http",
                    "nginx.org": "https"  
                }
            }
        }
    }
}

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).

unattended-upgrades

Installs and configures the unattended-upgrades package to provide automatic package updates. This can be configured to upgrade all packages or to just install security updates by setting ['apt']['unattended_upgrades']['allowed_origins'].

To pull just security updates, set origins_patterns to something like ["origin=Ubuntu,archive=trusty-security"] (for Ubuntu trusty) or ["origin=Debian,label=Debian-Security"] (for Debian).

Attributes

General

['apt']['compile_time_update'] - force the default recipe to run apt-get update at compile time.
['apt']['periodic_update_min_delay'] - minimum delay (in seconds) between two actual executions of apt-get update by the execute[apt-get-update-periodic] resource, default is '86400' (24 hours)

Caching

['apt']['cacher_client']['cacher_server'] - Hash containing server information used by clients for caching. See the example in the recipes section above for the full format of the hash.
['apt']['cacher_interface'] - interface to connect to the cacher-ng service, no default.
['apt']['cacher_port'] - port for the cacher-ng service (used by server recipe only), default is '3142'
['apt']['cacher_dir'] - directory used by cacher-ng service, default is '/var/cache/apt-cacher-ng'
['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'

Unattended Upgrades

['apt']['unattended_upgrades']['enable'] - enables unattended upgrades, default is false
['apt']['unattended_upgrades']['update_package_lists'] - automatically update package list (apt-get update) daily, default is true
['apt']['unattended_upgrades']['allowed_origins'] - array of allowed apt origins from which to pull automatic upgrades, defaults to a guess at the system's main origin and should almost always be overridden
['apt']['unattended_upgrades']['origins_patterns'] - array of allowed apt origin patterns from which to pull automatic upgrades, defaults to none.
['apt']['unattended_upgrades']['package_blacklist'] - an array of package which should never be automatically upgraded, defaults to none
['apt']['unattended_upgrades']['auto_fix_interrupted_dpkg'] - attempts to repair dpkg state with dpkg --force-confold --configure -a if it exits uncleanly, defaults to false (contrary to the unattended-upgrades default)
['apt']['unattended_upgrades']['minimal_steps'] - Split the upgrade into the smallest possible chunks. This makes the upgrade a bit slower but it has the benefit that shutdown while a upgrade is running is possible (with a small delay). Defaults to false.
['apt']['unattended_upgrades']['install_on_shutdown'] - Install upgrades when the machine is shuting down instead of doing it in the background while the machine is running. This will (obviously) make shutdown slower. Defaults to false.
['apt']['unattended_upgrades']['mail'] - Send email to this address for problems or packages upgrades. Defaults to no email.
['apt']['unattended_upgrades']['mail_only_on_error'] - If set, email will only be set on upgrade errors. Otherwise, an email will be sent after each upgrade. Defaults to true.
['apt']['unattended_upgrades']['remove_unused_dependencies'] Do automatic removal of new unused dependencies after the upgrade. Defaults to false.
['apt']['unattended_upgrades']['automatic_reboot'] - Automatically reboots without confirmation if a restart is required after the upgrade. Defaults to false.
['apt']['unattended_upgrades']['dl_limit'] - Limits the bandwidth used by apt to download packages. Value given as an integer in kb/sec. Defaults to nil (no limit).
['apt']['unattended_upgrades']['random_sleep'] - Wait a random number of seconds up to this value before running daily periodic apt actions. System default is 1800 seconds (30 minutes).

Configuration for APT

['apt']['confd']['force_confask'] - Prompt when overwriting configuration files. (default: false)
['apt']['confd']['force_confdef'] - Don't prompt when overwriting configuration files. (default: false)
['apt']['confd']['force_confmiss'] - Install removed configuration files when upgrading packages. (default: false)
['apt']['confd']['force_confnew'] - Overwrite configuration files when installing packages. (default: false)
['apt']['confd']['force_confold'] - Keep modified configuration files when installing packages. (default: false)
['apt']['confd']['install_recommends'] - Consider recommended packages as a dependency for installing. (default: true)
['apt']['confd']['install_suggests'] - Consider suggested packages as a dependency for installing. (default: false)

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.

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.

Resources

apt_preference

The apt_preference resource has been moved into chef-client in Chef 13.3.

See https://docs.chef.io/resource_apt_preference.html for usage details

apt_repository

The apt_repository resource has been moved into chef-client in Chef 12.9.

See https://docs.chef.io/resource_apt_repository.html for usage details

apt_update

The apt_update resource has been moved into chef-client in Chef 12.7.

See https://docs.chef.io/resource_apt_update.html for usage details

Maintainers

This cookbook is maintained by Chef's Community Cookbook Engineering team. Our goal is to improve cookbook quality and to aid the community in contributing to cookbooks. To learn more about our team, process, and design goals see our team documentation. To learn more about contributing to cookbooks like this see our contributing documentation, or if you have general questions about this cookbook come chat with us in #cookbok-engineering on the Chef Community Slack

License

Copyright: 2009-2017, Chef Software, 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.

7.0.0 (2018-04-06)

Breaking Change

This cookbook no longer includes apt_preference as that resource was moved into Chef Client 13.3. The cookbook now also requires Chef 13.3 or later. If you require support for an older release of Chef you will need to pin to a 6.X release.

6.1.4 (2017-08-31)

Restores ignore_failure true on compile time update.
name_property vs name_attribute in the resource

6.1.3 (2017-07-19)

Fixed typo in readme
Fixed config namespace in the 10dpkg-options file

6.1.2 (2017-06-20)

restore backwards compatability by respecting node['apt']['periodic_update_min_delay']

6.1.1 (2017-06-20)

Remove action_class.class_eval usage that caused failures
Remove wrong warning logs generated by apt_preference
Fix wrong warning log in cacher-client recipe

6.1.0 (2017-04-11)

Test with local delivery and not Rake
Use proper value type for bsd-mailx package only_if/not_if block
Update apache2 license string
Convert apt_preference to a custom resource

6.0.1 (2017-02-27)

Update cookbook description
Testing updates for Chef 13 and fixes to the cacher recipe

6.0.0 (2017-02-08)

Breaking changes

apt_update and apt_repository resources have been removed from the cookbook. These resources were both added to the chef-client itself. Due to this we now require Chef 12.9 or later, which has both of these resources built in. If you require compatibility with older chef-client releases you will need to pin to the 5.X release.

Other changes

apt_preference resource now properly required a pin_priority, which prevents us from writing out bad preference files that must be manually removed

5.1.0 (2017-02-01)

Convert integration tests to inspec
Add management of the /etc/apt/apt.conf.d/10dpkg-options file with new attributes. This allows tuning of how dpkg will handle package prompts during package installation. Note that Chef 12.19+ will automatically suppress package prompts

5.0.1 (2016-12-22)

Avoid CHEF-3694 in apt_preferences resource
Cookstyle fixes

5.0.0 (2016-10-14)

Remove search logic from the cacher client cookbook and rework attribute structure. See the attributes file and readme for new structure. Determining what servers to cache against is better handled in a wrapper cookbook where you can define the exact search syntax yourself
Corrected readme examples for the cacher client setup
Depend on the latest compat_resource
Define matchers for ChefSpec
Testing updates to better test the various recipes and providers in the cookbook on Travis

4.0.2 (2016-08-13)

The cookbook requires Chef 12.1+ not 12.0. Update docs
Test on Chef 12.1 to ensure compatibility
Restore compatibility with Chef < 12.4

4.0.1 (2016-06-21)

Fix bug that prevented adding the cookbook to non Debian/Ubuntu nodes without chef run failures

4.0.0 (2016-06-02)

This cookbook now requires Chef 12. If you require Chef 11 compatibility you will need to pin to the 3.X cookbook version

The apt-get update logic in the default recipe has been converted to apt_update custom resource and compat_resource cookbook has been added for backwards compatibility with all Chef 12.X releases. In addition this resource is now included in core chef-client and the cookbook will use the built-in resource if available
Added support for the unattended-upgrade RandomSleep configuration feature
Added support for the unattended-upgrade Unattended-Upgrade::Origins-Pattern configuration feature
Added Chefspec matchers for apt_update
Fixed apt_repository documentation to correctly reflect the deb_src property

3.0.0 (2016-03-01)

Removed Chef 10 compatibility code. This cookbook requires Chef 11 or greater now
The default recipe will no longer create /etc/apt/ and other directories on non-Debian based systems
Updated the autoremove command in the default recipe to run in non-interactive mode
Added CentOS 7 to Test Kitchenwith tests to ensure we don't create any files on RHEL or other non-Debian hosts
Updated Chefspec to 4.X format
Properly mock the existence of apt for the Chefspec runs so they don't just skip over the resources
Fixed lwrp test kitchen tests to pass
Resolved or disabled all Rubocop warnings
Enabled testing in Travis CI
Removed Apt Cacher NG support for Ubuntu 10.04 and Debian 6.X as they are both deprecated
Fixed + signs in packages names with the preference LWRP being rejected

v2.9.2

# 168 Adding guard to package resource.

v2.9.1

Adding package apt-transport-https to default.rb

v2.9.0

Add sensitive flag for apt_repositories
Enable installation of recommended or suggested packages
Tidy up apt-get update logic
Fixing not_if guard on ruby_block[validate-key #{key}]

v2.8.2 (2015-08-24)

Fix removal of apt_preferences

v2.8.1 (2015-08-18)

Handle keyservers as URLs and bare hostnames

v2.8.0 (2015-08-18)

Access keyservers on port 80
Adds key_proxy as LWRP attribute for apt_repository
Fix wildcard glob preferences files
Fix text output verification for non en_US locales
Quote repo URLs to deal with spaces

v2.7.0 (2015-03-23)

Support Debian 8.0
Filename verification for LWRPs
Support SSL enabled apt repositories

v2.6.1 (2014-12-29)

Remove old preference files without .pref extension from previous versions

v2.6.0 (2014-09-09)

Always update on first run - check
Adding ppa support for apt_repository

v2.5.3 (2014-08-14)

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

v2.5.2 (2014-08-14)

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

v1.4.2

[COOK-1155] - LWRP for apt pinning

v1.4.0

[COOK-889] - overwrite existing repo source files
[COOK-921] - optionally use cookbook_file or remote_file for key
[COOK-1032] - fixes problem with apt repository key installation

Collaborator Number Metric

7.0.0 passed this metric

Contributing File Metric

7.0.0 passed this metric

Foodcritic Metric

7.0.0 passed this metric

No Binaries Metric

7.0.0 passed this metric

Testing File Metric

7.0.0 passed this metric

Version Tag Metric

7.0.0 passed this metric

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

Platforms

Chef

Cookbooks

Recipes

default

cacher-client

Bypassing the cache

cacher-ng

unattended-upgrades

Attributes

General

Caching

Unattended Upgrades

Configuration for APT

Libraries

Usage

Resources

apt_preference

apt_repository

apt_update

Maintainers

License

Dependent cookbooks

Contingent cookbooks

apt Cookbook CHANGELOG

7.0.0 (2018-04-06)

Breaking Change

6.1.4 (2017-08-31)

6.1.3 (2017-07-19)

6.1.2 (2017-06-20)

6.1.1 (2017-06-20)

6.1.0 (2017-04-11)

6.0.1 (2017-02-27)

6.0.0 (2017-02-08)

Breaking changes

Other changes

5.1.0 (2017-02-01)

5.0.1 (2016-12-22)

5.0.0 (2016-10-14)

4.0.2 (2016-08-13)

4.0.1 (2016-06-21)

4.0.0 (2016-06-02)

3.0.0 (2016-03-01)

v2.9.2

v2.9.1

v2.9.0

v2.8.2 (2015-08-24)

v2.8.1 (2015-08-18)

v2.8.0 (2015-08-18)

v2.7.0 (2015-03-23)

v2.6.1 (2014-12-29)

v2.6.0 (2014-09-09)

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

Collaborator Number Metric

7.0.0 passed this metric

Contributing File Metric

7.0.0 passed this metric

Foodcritic Metric

7.0.0 passed this metric

No Binaries Metric

7.0.0 passed this metric

Testing File Metric

7.0.0 passed this metric

Version Tag Metric

7.0.0 passed this metric