apt-cacher-formula

Travis CI Build Status Semantic Release

A SaltStack formula that is empty. It has dummy content to help with a quick start on a new formula and it serves as a style guide.

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

2. Contributing to this repo

Commit message formatting is significant!!

Please see How to contribute for more details.

3. Available states

3.1. apt-cacher.server

Installs the apt-cacher package.

3.2. apt-cacher.client

Sets up the system to use the apt-cacher server as the caching proxy.

3.3. apt-cacher.ng.server

Install and configure apt-cacher-ng.

Supports Debian(ish) distributions and FreeBSD.

3.4. apt-cacher.ng.server.package

Installs the apt-cacher-ng package.

3.5. apt-cacher.ng.server.config

Installs the apt-cacher-ng config.

3.6. apt-cacher.ng.server.service

Manages the startup and running state of the apt-cacher-ng service.

3.7. apt-cacher.ng.client

Sets up the system to use the apt-cacher-ng server as the caching proxy.

4. Testing

Linux testing is done with kitchen-salt.

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

4.2. bin/kitchen converge

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

4.3. bin/kitchen verify

Runs the inspec tests on the actual instance.

4.4. bin/kitchen destroy

Removes the docker instance.

4.5. bin/kitchen test

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

4.6. bin/kitchen login

Gives you SSH access to the instance for manual testing.