aptly Cookbook

This cookbook installs and configures aptly http://www.aptly.info

Maintainers

This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.

Requirements

Platform

• Debian 9
• Debian 10
• Ubuntu 16.04
• Ubuntu 18.04

Attributes

Repository attributes

• default['aptly']['repository']['uri'] = 'http://repo.aptly.info/'
• default['aptly']['repository']['dist'] = 'squeeze'
• default['aptly']['repository']['components'] = 'main'
• default['aptly']['repository']['key'] = 'https://www.aptly.info/pubkey.txt'

Global repository attributes

• default['aptly']['user'] = 'aptly'
• default['aptly']['group'] = 'aptly'
• default['aptly']['rootDir'] = '/opt/aptly'
• default['aptly']['downloadConcurrency'] = 4
• default['aptly']['downloadSpeedLimit'] = 0
• default['aptly']['architectures'] = []
• default['aptly']['dependencyFollowSuggests'] = false
• default['aptly']['dependencyFollowRecommends'] = false
• default['aptly']['dependencyFollowAllVariants'] = false
• default['aptly']['dependencyFollowSource'] = false
• default['aptly']['gpgDisableSign'] = false
• default['aptly']['gpgDisableVerify'] = false
• default['aptly']['gpgProvider'] = 'gpg'
• default['aptly']['downloadSourcePackages'] = false
• default['aptly']['skipLegacyPool'] = true
• default['aptly']['ppaDistributorID'] = 'ubuntu'
• default['aptly']['ppaCodename'] = ''
• default['aptly']['FileSystemPublishEndpoints'] = {}
• default['aptly']['S3PublishEndpoints'] = {}
• default['aptly']['SwiftPublishEndpoints'] = {}

GPG attributes

• default['aptly']['gpg']['key-type'] = 'RSA'
• default['aptly']['gpg']['key-length'] = 4096
• default['aptly']['gpg']['subkey-type'] = 'RSA'
• default['aptly']['gpg']['subkey-length'] = 4096
• default['aptly']['gpg']['name-real'] = 'Aptly'
• default['aptly']['gpg']['name-comment'] = 'Aptly Key'
• default['aptly']['gpg']['name-email'] = 'organisation@example.org'
• default['aptly']['gpg']['expire-date'] = 0
• default['aptly']['gpg']['passphrase'] = 'GreatPassPhrase'

Recipes

default

Install and configure aptly

Resources

'aptly_repo'

Manage local repositories

Actions

• create - (default) Create a repo
• drop - Drop an existed repository
• add - Add packages to a repository
• remove - remove a package from a repository

Properties

Examples

aptly_repo 'my_repo' do
  comment 'A repository of packages'
  component 'main'
  distribution 'bionic'
  action :create
end

aptly_repo 'repo_with_no_comment' do
  action :create
end

aptly_repo 'my_repo' do
  action :drop
end

aptly_repo 'my_repo' do
  file '/path/to/package-1.0.1.deb'
  action :add
end

aptly_repo 'my_repo' do
  directory '/path/to/packages'
  action :add
end

aptly_repo 'my_repo' do
  package_query 'package-1.0.1.deb'
  action :remove
end

'aptly_mirror'

Manage external mirror

Actions

• create - (default) Create a mirror from external repository
• drop - Drop created mirror
• update - Update/Sync your mirror

Properties

Note: The "architectures" property will use the global configuration (settable via node['aptly']['architectures']) if you do not provide it for a particular repository here. If you do not provide either of them, it will default to all available architectures for that particular mirror. Note also that you need to publish with the architectures as well!

Examples

aptly_mirror 'nginx-bionic' do
  distribution 'bionic'
  component 'nginx'
  keyid '7BD9BF62'
  keyserver 'keyserver.ubuntu.com'
  uri 'http://nginx.org/packages/ubuntu/'
end

aptly_mirror 'nginx-bionic' do
  action :update
end

aptly_mirror 'nginx-bionic' do
  action :drop
end

'aptly_snapshot'

Manage aptly snapshots

Actions

• create - (default) Create a snapshot from an internal repository or mirror
• drop - Drop created snapshot
• verify - Verifies dependencies between packages in snapshot
• pull - Pulls new packages to snapshot from source snapshot
• merge - Merges several source snapshots into new destination snapshot

Properties

Examples

aptly_snapshot 'my_snapshot' do
  from 'my_repo'
  type 'repo'
end

aptly_snapshot 'my_snapshot' do
  action :drop
end

aptly_snapshot 'merged_snapshot' do
  merge_sources %w(snapshot1 snapshot2)
  action :merge
end

aptly_snapshot 'merged_snapshot' do
  action :verify
end

aptly_snapshot 'merged_snapshot' do
  package_query 'curl_7.26.0-1+wheezy25+deb7u1_amd64.deb'
  source 'my_snapshot'
  destination 'new_my_snapshot'
  action :pull
end

'aptly_publish'

Publish, remove or update a repo or a snapshot

Actions

• create - (default) Publish a repo or a snapshot
• drop - Drop a publication
• update - Update publication

Properties

Note: The "architectures" property will use the global configuration (settable via node['aptly']['architectures']) if you do not provide it for a particular repository here.

Examples

aptly_publish 'my_repo' do
  type 'repo'
  component %w(main contrib)
  prefix 'my_company'
end

aptly_publish 'my_snapshot' do
  type 'snapshot'
  endpoint 's3'
  prefix 'snap'
  action :create
end

aptly_publish 'my_snapshot' do
  prefix 'snap'
  action :update
end

aptly_publish 'my_snapshot' do
  prefix 'snap'
  action :drop
end

'aptly_serve'

Serve an HTTP Service

Actions

• run - (default) Run the service

Properties

Examples

aptly_serve 'Serve Aptly HTTP Service' do
  port 8090
end

'aptly_api_serve'

Serve an API Service

Actions

• run - (default) Run the service

Properties

Examples

aptly_api_serve 'Serve Aptly API Service' do
  port 8091
  no_lock true
end

'aptly_db'

Manage internal Aptly DB

Actions

• cleanup - (default) Database cleanup removes information about unreferenced packages and deletes files in the package pool that aren’t used by packages anymore.
• recover - Database recover does its best to recover database after crash.

Properties

None

Examples

aptly_db 'cleanup' do
  action :cleanup
end

aptly_db 'recover' do
  action :recover
end

Usage

include recipe in a wrapper cookbook and call resources if needed

include_recipe 'aptly'

aptly_repo 'my_repo' do
  comment 'A repository of packages'
  component 'main'
  distribution 'bionic'
end

aptly_snapshot 'my_snapshot' do
  from 'my_repo'
  type 'repo'
end

aptly_publish 'my_repo' do
  type 'repo'
  prefix 'ubuntu'
end

aptly_serve 'Aptly HTTP Service'

Testing

Please contribute to keep unit and functional tests up to date.
After modifications, please run the following commands to check if you break something:

• chef exec rspec
• kitchen test default-ubuntu-1804

NOTE: Available distro tests: default-debian-8, default-debian-9, default-ubuntu-1604 and default-ubuntu-1804

NOTE2: if you want to use Policyfile, rename Policyfile.rb.dist to Policyfile.rb in root and test directories, then execute chef update in each folder. Look inside .kitchen.yml and spec/spec_helper.rb too.

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers!

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.