jdkelleher / apt-formula

apt

A formula to configure and manage update, upgrade, and dist-upgrade within apt.

Table of Contents

• General notes
• Contributing to this repo
• Available states
  • apt.dist_upgrade
  • apt.update
  • apt.upgrade
  • apt.repositories
  • apt.preferences
  • apt.ppa
  • apt.unattended
  • apt.transports.debtorrent
  • apt.transports.https
• Testing
  • Requirements
  • bin/kitchen converge
  • bin/kitchen verify
  • bin/kitchen destroy
  • bin/kitchen test
  • bin/kitchen login

General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

Contributing to this repo

Commit message formatting is significant!!

Please see :ref:`How to contribute <CONTRIBUTING>` for more details.

Available states

• apt.dist_upgrade
• apt.update
• apt.upgrade
• apt.repositories
• apt.preferences
• apt.ppa
• apt.unattended
• apt.transports.debtorrent
• apt.transports.https

apt.dist_upgrade

Runs apt-get -y dist-upgrade.

apt.update

Runs apt-get -y update.

apt.upgrade

Runs apt-get -y upgrade.

apt.repositories

Allows you to configure and manage repositories from pillar. Check pillar.example to see possible values. If used and no repositories are provided, sane default values from map.jinja are used.

Check https://wiki.debian.org/SourcesList for an explanation about the resulting files structure.

apt.preferences

Allows you to configure and manage apt's preferences from pillar. Check pillar.example to see possible values. If used and no repositories are provided, sane default values from map.jinja are used.

Check https://wiki.debian.org/AptPreferences?action=show&redirect=preferences and man 5 apt_preferences for an explanation about the resulting files structure.

apt.ppa

Installs python-software-properties ($ /usr/bin/apt-add-repository ppa:user/repository).

apt.unattended

Installs and configures unattended-upgrades

apt.transports.debtorrent

Installs apt-transport-debtorrent.

apt.transports.https

Installs apt-transport-https. Note that `apt-transport-https` has been deprecated since Debian 9 and it's now a dummy package

Testing

Linux testing is done with kitchen-salt.

Requirements

• Ruby
• Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

bin/kitchen converge

Creates the docker instance and runs the apt main state, ready for testing.

bin/kitchen verify

Runs the inspec tests on the actual instance.

bin/kitchen destroy

Removes the docker instance.

bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.

bin/kitchen login

Gives you SSH access to the instance for manual testing.