.github/workflows | ||
bin | ||
docs | ||
test | ||
unbound | ||
.gitignore | ||
.gitlab-ci.yml | ||
.pre-commit-config.yaml | ||
.rstcheck.cfg | ||
.rubocop.yml | ||
.salt-lint | ||
.travis.yml | ||
.yamllint | ||
CODEOWNERS | ||
commitlint.config.js | ||
FORMULA | ||
Gemfile | ||
Gemfile.lock | ||
kitchen.yml | ||
LICENSE | ||
pillar.example | ||
pre-commit_semantic-release.sh | ||
release-rules.js | ||
release.config.js |
unbound-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
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 refer to:
- how to configure the formula with map.jinja
- the
pillar.example
file - the 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
unbound
Meta-state (This is a state that includes other states).
This installs the unbound package, manages the unbound configuration file and then starts the associated unbound service.
unbound.package
This state will install the unbound package only.
unbound.config
This state will configure the unbound service and has a dependency on
unbound.install
via include list.
unbound.service
This state will start the unbound service and has a dependency on
unbound.config
via include list.
unbound.clean
Meta-state (This is a state that includes other states).
this state will undo everything performed in the unbound
meta-state in reverse order, i.e. stops the service, removes the
configuration file and then uninstalls the package.
unbound.service.clean
This state will stop the unbound service and disable it at boot time.
unbound.config.clean
This state will remove the configuration of the unbound service and
has a dependency on unbound.service.clean
via include
list.
unbound.package.clean
This state will remove the unbound package and has a depency on
unbound.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 unbound
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.