backupninja-formula

Configure backupninja using SaltStack Pillar.

This formula is meant to be a thin wrapper around standard backupninja configuration, enabling us to re-use our knowledge of backupninja without wrapping our head around a thick abstraction layer. Therefore configuration details are not discussed here. Please see backupninja Configuration for an overview.

When reading pillar.example you'll probably notice that Pillar maps directly to the configuration directives described in backupninja example files. If they don't (and there's no comment explaining why) that's probably a bug. In that case please file an issue or submit a Pull Request.

Table of Contents

• General notes
• Contributing to this repo
• Special notes
• Available states
• Testing

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.

If you need (non-default) configuration, please pay attention to the pillar.example file and/or Special notes section.

Contributing to this repo

Commit messages

Commit message formatting is significant!!

Please see How to contribute for more details.

pre-commit

pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes. First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and now pre-commit will run automatically on each git commit.

$ bin/install-hooks
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msg

Special notes

None

Available states

• backupninja
• backupninja.install
• backupninja.config

backupninja

Meta-state (This is a state that includes other states).

Includes backupninja.install and backupninja.config

backupninja.install

Installs the backupninja package(s).

backupninja.config

Configures backupninja based on Pillar. See pillar.example for details.

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