wireguard-formula

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.

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

• wireguard
• wireguard.package
• wireguard.config
• wireguard.service
• wireguard.clean
• wireguard.service.clean
• wireguard.config.clean
• wireguard.package.clean

wireguard

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

This installs the wireguard package, manages the wireguard configuration file and then starts the associated wireguard service.

wireguard.package

This state will install the wireguard package only.

wireguard.config

This state will configure the wireguard service and has a dependency on wireguard.install via include list.

wireguard.service

This state will start the wireguard service and has a dependency on wireguard.config via include list.

wireguard.clean

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

this state will undo everything performed in the wireguard meta-state in reverse order, i.e. stops the service, removes the configuration file and then uninstalls the package.

wireguard.service.clean

This state will stop the wireguard service and disable it at boot time.

wireguard.config.clean

This state will remove the configuration of the wireguard service and has a dependency on wireguard.service.clean via include list.

wireguard.package.clean

This state will remove the wireguard package and has a depency on wireguard.config.clean via include list.

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